V2TXLivePlayer

Data Structures
protocol	<V2TXLivePlayer>

Detailed Description

Tencent Cloud live player.
This player pulls audio and video data from the specified livestreaming URL and plays the data after decoding and local rendering.

The player has the following capabilities:

• Supports RTMP, HTTP-FLV, TRTC and WebRTC.
• View capturing, which allows you to capture the video images of the current livestream.
• Delay adjustment, which allows you to set the minimum time and maximum time for auto adjustment of the player cache.
• Custom video data processing, which allows you to perform rendering and play video data after processing video data in the livestream based on the project requirements.

---

Data Structure Documentation

V2TXLivePlayer-p

protocol V2TXLivePlayer-p

Inheritance diagram for <V2TXLivePlayer>:

Instance Methods
(void)	- setObserver:
(V2TXLiveCode)	- setRenderView:
(V2TXLiveCode)	- setRenderRotation:
(V2TXLiveCode)	- setRenderFillMode:
(V2TXLiveCode)	- startLivePlay:
(V2TXLiveCode)	- stopPlay
(int)	- isPlaying
(V2TXLiveCode)	- pauseAudio
(V2TXLiveCode)	- resumeAudio
(V2TXLiveCode)	- pauseVideo
(V2TXLiveCode)	- resumeVideo
(V2TXLiveCode)	- setPlayoutVolume:
(V2TXLiveCode)	- setCacheParams:maxTime:
(V2TXLiveCode)	- enableVolumeEvaluation:
(V2TXLiveCode)	- snapshot
(V2TXLiveCode)	- enableObserveVideoFrame:pixelFormat:bufferType:
(V2TXLiveCode)	- enableReceiveSeiMessage:payloadType:
(void)	- showDebugView:
(V2TXLiveCode)	- setProperty:value:

Method Documentation

enableObserveVideoFrame:pixelFormat:bufferType:()

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

Turn on/off the monitoring callback of the video frame.

The 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.

Parameters

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

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful
• V2TXLIVE_ERROR_NOT_SUPPORTED: the pixel format or data format is not supported.

enableReceiveSeiMessage:payloadType:()

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

Enables the receiving of SEI messages.

Parameters

enable	YES: enable; NO (default): disable
payloadType	The payload type of SEI messages. Valid values: 5, 242, please be consistent with the payload type of the sender

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful

enableVolumeEvaluation:()

- (V2TXLiveCode) enableVolumeEvaluation:

(NSUInteger)

intervalMs

Enables playback volume update.

After this feature is enabled, you can obtain the SDK’s volume evaluation through the V2TXLivePlayerObserver::onPlayoutVolumeUpdate:volume: "onPlayoutVolumeUpdate" callback.

Parameters

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.

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful

isPlaying()

- (int) isPlaying

Indicates whether the player is playing the audio and video streams.

Returns

Indicates whether the player is playing the audio and video streams.

• 1: yes
• 0: no

pauseAudio()

- (V2TXLiveCode) pauseAudio

Pauses the audio stream of the player.

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful

pauseVideo()

- (V2TXLiveCode) pauseVideo

Pauses the video stream of the player.

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful

resumeAudio()

- (V2TXLiveCode) resumeAudio

Resumes the audio stream of the player.

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful

resumeVideo()

- (V2TXLiveCode) resumeVideo

Resumes the video stream of the player.

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful

setCacheParams:maxTime:()

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

Set the minimum time and maximum time (unit: s) for auto adjustment of the player cache.

Parameters

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

Returns

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.

setObserver:()

- (void) setObserver:

(id< V2TXLivePlayerObserver >)

observer

Sets the player callback.

By 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.

Parameters

observer

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

setPlayoutVolume:()

- (V2TXLiveCode) setPlayoutVolume:

(NSUInteger)

volume

Sets the volume.

Parameters

volume

Volume. Valid range: 0 - 100. [Default]: 100

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful

setProperty:value:()

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

Calls the advanced API of V2TXLivePlayer.

Attention

This API is used to call some advanced features.

Parameters

key	Key of the advanced API.
value	Parameter needed to call the advanced API corresponding to the key.

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful
• V2TXLIVE_ERROR_INVALID_PARAMETER: operation failed. The key cannot be nil.

setRenderFillMode:()

- (V2TXLiveCode) setRenderFillMode:

(V2TXLiveFillMode)

mode

Sets the fill mode of the view.

Parameters

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.

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful

setRenderRotation:()

- (V2TXLiveCode) setRenderRotation:

(V2TXLiveRotation)

rotation

Sets the rotation angle of the player view.

Parameters

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.

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful

setRenderView:()

- (V2TXLiveCode) setRenderView:

(TXView *)

view

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

Parameters

view	Player rendering view.

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful

showDebugView:()

- (void) showDebugView:

(BOOL)

isShow

Indicates whether the debug view of the player video status information is displayed.

Parameters

isShow

Specifies whether to display the debug view. [Default]: NO.

snapshot()

- (V2TXLiveCode) snapshot

Captures the video view in the playback process.

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful
• V2TXLIVE_ERROR_REFUSED: playback is stopped, the snapshot operation cannot be called.

startLivePlay:()

- (V2TXLiveCode) startLivePlay:

(NSString *)

url

Starts playing the audio and video streams.

Attention

Starting from version 10.7, the Licence needs to be set through V2TXLivePremier#setLicence or TXLiveBase#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.

Parameters

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

Returns

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.
• TXLIVE_ERROR_INVALID_LICENSE: The licence is invalid and the playback fails.

stopPlay()

- (V2TXLiveCode) stopPlay

Stops playing the audio and video streams.

Returns

Return code V2TXLiveCode

• V2TXLIVE_OK: successful