V2TXLivePlayer

Copyright (c) 2021 Tencent. All rights reserved.
﻿
Module:   V2TXLivePlayer @ TXLiteAVSDK
﻿
Function: Tencent Cloud live player
﻿
FunctionTencent Cloud Live Player.
It is mainly responsible for pulling audio and video data from the specified live stream address, decoding and rendering locally.
IntroduceThe player includes the following capabilities:
 Support RTMP, HTTP-FLV, HLS, TRTC, WebRTC protocols.
 Screen capture, you can capture the video screen of the current live stream.
 Delay adjustment, you can set the minimum and maximum time for automatic adjustment of the player cache.
 Customized video data processing, you can process the video data in the live stream according to the needs of the project, and then render and play it.
﻿
V2TXLivePlayer
V2TXLivePlayer
FuncList
DESC
setObserver:
Sets the player callback
setRenderView:
Sets the rendering view of the player. This control is responsible for presenting the video content
setRenderRotation:
Sets the rotation angle of the player view
setRenderFillMode:
Sets the fill mode of the view
startLivePlay:
Starts playing the audio and video streams
stopPlay
Stops playing the audio and video streams
isPlaying
Indicates whether the player is playing the audio and video streams
pauseAudio
Pauses the audio stream of the player
resumeAudio
Resumes the audio stream of the player
pauseVideo
Pauses the video stream of the player
resumeVideo
Resumes the video stream of the player
setPlayoutVolume:
Sets the volume
setCacheParams:maxTime:
Set the minimum time and maximum time (unit: s) for auto adjustment of the player cache
switchStream:
Seamlessly switch live stream urls, supporting  FLV and LEB protocols
getStreamList
Get Stream lnfo List
enableVolumeEvaluation:
Enables playback volume update
snapshot
Captures the video view in the playback process
enableObserveVideoFrame:pixelFormat:bufferType:
Turn on/off the monitoring callback of the video frame
enableObserveAudioFrame:
Turn on/off the monitoring callback of the audio frame
enableReceiveSeiMessage:payloadType:
Enables the receiving of SEI messages
enablePictureInPicture:
Enables Picture-in-Picture mode
showDebugView:
Indicates whether the debug view of the player video status information is displayed
setProperty:value:
Calls the advanced API of V2TXLivePlayer
startLocalRecording:
Start recording audio and video stream
stopLocalRecording
Stop recording audio and video stream
setObserver:
setObserver:
- (void)setObserver:
(id<﻿V2TXLivePlayerObserver﻿>)observer
Sets the player callbackBy setting the callback, you can listen to some callback events of V2TXLivePlayer,
including the player status, playback volume callback, first frame audio/video callback, statistics, warnings, and error messages.
Param
DESC
observer
Callback target of the player. For more information, see ﻿V2TXLivePlayerObserver﻿.
setRenderView:
setRenderView:
- (V2TXLiveCode)setRenderView:
(TXView *)view
Sets the rendering view of the player. This control is responsible for presenting the video contentParam
DESC
view
Player rendering view.
Return Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
setRenderRotation:
setRenderRotation:
- (V2TXLiveCode)setRenderRotation:
(﻿V2TXLiveRotation﻿)rotation
Sets the rotation angle of the player viewParam
DESC
rotation
Rotation angle of the view ﻿V2TXLiveRotation﻿.
 V2TXLiveRotation0 Default: 0 degrees, which means the view is not rotated.
 V2TXLiveRotation90:  rotate 90 degrees clockwise.
 V2TXLiveRotation180: rotate 180 degrees clockwise.
 V2TXLiveRotation270: rotate 270 degrees clockwise.
Return Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
setRenderFillMode:
setRenderFillMode:
- (V2TXLiveCode)setRenderFillMode:
(﻿V2TXLiveFillMode﻿)mode
Sets the fill mode of the viewParam
DESC
mode
Fill mode of the view ﻿V2TXLiveFillMode﻿.
 V2TXLiveFillModeFill: Default: fill the screen with the image without leaving any black edges. If the aspect ratio of the view is different from that of the screen, part of the view will be cropped.
 V2TXLiveFillModeFit  make the view fit the screen without cropping. If the aspect ratio of the view is different from that of the screen, black edges will appear.
 V2TXLiveFillModeScaleFill  fill the screen with the stretched image, thus the length and width may not change proportionally.
Return Desc:Return code ﻿V2TXLiveCode﻿
 V2TXLIVE_OK: successful
startLivePlay:
startLivePlay:
- (V2TXLiveCode)startLivePlay:
(NSString *)url
Starts playing the audio and video streamsParam
DESC
url
URL of the audio and video streams to be played. The RTMP, HTTP-FLV and TRTC streaming protocols are supported.
Note
Starting from version 10.7, the Licence needs to be set through ﻿setLicence﻿ or ﻿setLicence﻿ before it can be played successfully, otherwise the playback will fail (black screen), and it can only be set once globally. Live Licence, UGC Licence, and Player Licence can all be used. If you have not obtained the above Licence, you can  quickly apply for a beta Licence for free  To play, the official licence needs to be  purchased .
Return Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: operation succeeded. The player starts connecting to the URL and playing the audio and video streams.
 V2TXLIVE_ERROR_INVALID_PARAMETER: operation failed. The URL is invalid.
 V2TXLIVE_ERROR_REFUSED: operation failed. Duplicate streamId, please ensure that no other player or pusher is using this streamId now.
 V2TXLIVE_ERROR_INVALID_LICENSE: The licence is invalid and the playback fails.
stopPlay
stopPlay
Stops playing the audio and video streamsReturn Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
isPlaying
isPlaying
Indicates whether the player is playing the audio and video streamsReturn Desc:Indicates whether the player is playing the audio and video streams.
 1: yes.
 0: no.
pauseAudio
pauseAudio
Pauses the audio stream of the playerReturn Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
resumeAudio
resumeAudio
Resumes the audio stream of the playerReturn Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
pauseVideo
pauseVideo
Pauses the video stream of the playerReturn Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
resumeVideo
resumeVideo
Resumes the video stream of the playerReturn Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
setPlayoutVolume:
setPlayoutVolume:
- (V2TXLiveCode)setPlayoutVolume:
(NSUInteger)volume
Sets the volumeParam
DESC
volume
Volume. Valid range: 0 - 100. Default: 100.
Return Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
setCacheParams:maxTime:
setCacheParams:maxTime:
- (V2TXLiveCode)setCacheParams:
(CGFloat)minTime
maxTime:
(CGFloat)maxTime
Set the minimum time and maximum time (unit: s) for auto adjustment of the player cacheParam
DESC
maxTime
Maximum time for auto cache adjustment. The value must be greater than 0. Default: 5.
minTime
Minimum time for auto cache adjustment. The value must be greater than 0. Default: 1.
Return Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
 V2TXLIVE_ERROR_INVALID_PARAMETER: operation failed. MinTime and maxTime must be greater than 0.
 V2TXLIVE_ERROR_REFUSED: operation failed. Change of cache is not suppoted when playing.
switchStream:
switchStream:
- (V2TXLiveCode)switchStream:
(NSString*)newUrl
Seamlessly switch live stream urls, supporting  FLV and LEB protocolsParam
DESC
newUrl
New pull address.
getStreamList
getStreamList
Get Stream lnfo List
enableVolumeEvaluation:
enableVolumeEvaluation:
- (V2TXLiveCode)enableVolumeEvaluation:
(NSUInteger)intervalMs
Enables playback volume updateAfter this feature is enabled, you can obtain the SDK’s volume evaluation through the ﻿onPlayoutVolumeUpdate﻿ callback.
Param
DESC
intervalMs
Interval for triggering the volume callback. The unit is ms. The minimum interval is 100 ms. If the value is equal to or smaller than 0, the callback is disabled. We recommend that you set this parameter to 300 ms. Default: 0.
Return Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
snapshot
snapshot
Captures the video view in the playback processReturn Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
 V2TXLIVE_ERROR_REFUSED: playback is stopped, the snapshot operation cannot be called.
enableObserveVideoFrame:pixelFormat:bufferType:
enableObserveVideoFrame:pixelFormat:bufferType:
- (V2TXLiveCode)enableObserveVideoFrame:
(BOOL)enable
pixelFormat:
(﻿V2TXLivePixelFormat﻿)pixelFormat
bufferType:
(﻿V2TXLiveBufferType﻿)bufferType
Turn on/off the monitoring callback of the video frameThe SDK will no longer render the video after you turn on this switch. You can get the video frame through V2TXLivePlayerObserver and execute custom rendering logic.
Param
DESC
bufferType
Video data format for custom rendering callback ﻿V2TXLiveBufferType﻿。
enable
Whether to enable custom rendering. Default: NO.
pixelFormat
Video pixel format for custom rendering callback ﻿V2TXLivePixelFormat﻿。
Return Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
 V2TXLIVE_ERROR_NOT_SUPPORTED: the pixel format or data format is not supported.
enableObserveAudioFrame:
enableObserveAudioFrame:
- (V2TXLiveCode)enableObserveAudioFrame:
(BOOL)enable
Turn on/off the monitoring callback of the audio frameif you turn on this switch, You can get the audio frame through V2TXLivePlayerObserver and execute custom logic.
Param
DESC
enable
Whether to enable the callback of the audio frame. Default: NO.
Return Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
enableReceiveSeiMessage:payloadType:
enableReceiveSeiMessage:payloadType:
- (V2TXLiveCode)enableReceiveSeiMessage:
(BOOL)enable
payloadType:
(int)payloadType
Enables the receiving of SEI messagesParam
DESC
enable
 YES : enable;  NO  (default): disable.
payloadType
The payload type of SEI messages. Valid values:  5 ,  242 ,  243 , please be consistent with the payload type of the sender.
Return Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
enablePictureInPicture:
enablePictureInPicture:
- (V2TXLiveCode)enablePictureInPicture:
(BOOL)enable
Enables Picture-in-Picture modeParam
DESC
enable
 YES : enable;  NO  (default): disable.
Return Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
showDebugView:
showDebugView:
- (void)showDebugView:
(BOOL)isShow
Indicates whether the debug view of the player video status information is displayedParam
DESC
isShow
Specifies whether to display the debug view. Default: NO.
setProperty:value:
setProperty:value:
- (V2TXLiveCode)setProperty:
(NSString *)key
value:
(NSObject *)value
Calls the advanced API of V2TXLivePlayerParam
DESC
key
Key of the advanced API, please see ﻿V2TXLiveProperty﻿.
value
Parameter needed to call the advanced API corresponding to the key.
Note
This API is used to call some advanced features.
Return Desc:Return code ﻿V2TXLiveCode﻿.
 V2TXLIVE_OK: successful.
 V2TXLIVE_ERROR_INVALID_PARAMETER: operation failed. The key cannot be nil.
startLocalRecording:
startLocalRecording:
- (V2TXLiveCode)startLocalRecording:
(﻿V2TXLiveLocalRecordingParams﻿ *)params
Start recording audio and video streamNote
The recording can only be started after the play stream is started, and it is invalid to start the recording in the non-play state.
 Do not dynamically switch soft/hard decoding during the recording process, as there is a high probability that the generated video will be abnormal.
Return Desc:Return code for ﻿V2TXLiveCode﻿.
  V2TXLIVE_OK : successful.
  V2TXLIVE_ERROR_INVALID_PARAMETER  : The parameter is invalid, such as filePath is empty.
  V2TXLIVE_ERROR_REFUSED : API refuse, you must first call startLivePlay to start playing streaming.
stopLocalRecording
stopLocalRecording
Stop recording audio and video streamNote
When the play stream is stopped, if the video is still being recorded, the SDK will automatically end the recording.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

FuncList	DESC
setObserver:	Sets the player callback
setRenderView:	Sets the rendering view of the player. This control is responsible for presenting the video content
setRenderRotation:	Sets the rotation angle of the player view
setRenderFillMode:	Sets the fill mode of the view
startLivePlay:	Starts playing the audio and video streams
stopPlay	Stops playing the audio and video streams
isPlaying	Indicates whether the player is playing the audio and video streams
pauseAudio	Pauses the audio stream of the player
resumeAudio	Resumes the audio stream of the player
pauseVideo	Pauses the video stream of the player
resumeVideo	Resumes the video stream of the player
setPlayoutVolume:	Sets the volume
setCacheParams:maxTime:	Set the minimum time and maximum time (unit: s) for auto adjustment of the player cache
switchStream:	Seamlessly switch live stream urls, supporting FLV and LEB protocols
getStreamList	Get Stream lnfo List
enableVolumeEvaluation:	Enables playback volume update
snapshot	Captures the video view in the playback process
enableObserveVideoFrame:pixelFormat:bufferType:	Turn on/off the monitoring callback of the video frame
enableObserveAudioFrame:	Turn on/off the monitoring callback of the audio frame
enableReceiveSeiMessage:payloadType:	Enables the receiving of SEI messages
enablePictureInPicture:	Enables Picture-in-Picture mode
showDebugView:	Indicates whether the debug view of the player video status information is displayed
setProperty:value:	Calls the advanced API of V2TXLivePlayer
startLocalRecording:	Start recording audio and video stream
stopLocalRecording	Stop recording audio and video stream

Param	DESC
observer	Callback target of the player. For more information, see V2TXLivePlayerObserver.

Param	DESC
rotation	Rotation angle of the view V2TXLiveRotation. V2TXLiveRotation0 Default: 0 degrees, which means the view is not rotated. V2TXLiveRotation90: rotate 90 degrees clockwise. V2TXLiveRotation180: rotate 180 degrees clockwise. V2TXLiveRotation270: rotate 270 degrees clockwise.

Param	DESC
url	URL of the audio and video streams to be played. The RTMP, HTTP-FLV and TRTC streaming protocols are supported.

Param	DESC
volume	Volume. Valid range: 0 - 100. Default: 100.

- (V2TXLiveCode)setCacheParams:	(CGFloat)minTime
maxTime:	(CGFloat)maxTime

Param	DESC
maxTime	Maximum time for auto cache adjustment. The value must be greater than 0. Default: 5.
minTime	Minimum time for auto cache adjustment. The value must be greater than 0. Default: 1.

Param	DESC
intervalMs	Interval for triggering the volume callback. The unit is ms. The minimum interval is 100 ms. If the value is equal to or smaller than 0, the callback is disabled. We recommend that you set this parameter to 300 ms. Default: 0.

- (V2TXLiveCode)enableObserveVideoFrame:	(BOOL)enable
pixelFormat:	(V2TXLivePixelFormat)pixelFormat
bufferType:	(V2TXLiveBufferType)bufferType

Param	DESC
bufferType	Video data format for custom rendering callback V2TXLiveBufferType。
enable	Whether to enable custom rendering. Default: NO.
pixelFormat	Video pixel format for custom rendering callback V2TXLivePixelFormat。

- (V2TXLiveCode)enableReceiveSeiMessage:	(BOOL)enable
payloadType:	(int)payloadType

Param	DESC
isShow	Specifies whether to display the debug view. Default: NO.

- (V2TXLiveCode)setProperty:	(NSString *)key
value:	(NSObject *)value

Param	DESC
key	Key of the advanced API, please see V2TXLiveProperty.
value	Parameter needed to call the advanced API corresponding to the key.

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Tencent Big Model

Internet of Things

Stream Services

Cloud Real-time Rendering

Management and Audit Tools

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Developer Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Image Creation

Natural Language Processing

Communication

Media Process Services

Education Sevices

Monitor and Operation

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Voice Technology

Optical Character Recognition

Interactive Video Services

Media SDK

Cloud Resource Management

More

Function

Introduce

V2TXLivePlayer

setObserver:

Sets the player callback

setRenderView:

Sets the rendering view of the player. This control is responsible for presenting the video content

Return Desc:

setRenderRotation:

Sets the rotation angle of the player view

Return Desc:

setRenderFillMode:

Sets the fill mode of the view

Return Desc:

startLivePlay:

Starts playing the audio and video streams

Return Desc:

stopPlay

Stops playing the audio and video streams

Return Desc:

isPlaying

Indicates whether the player is playing the audio and video streams

Return Desc:

pauseAudio

Pauses the audio stream of the player

Return Desc:

resumeAudio

Resumes the audio stream of the player

Return Desc: