LiteAVSDK
Tencent Cloud TRTC SDK, is a high availability components serving tens of thousands of enterprise customers, which is committed to helping you to minimize your research and development costs.
V2TXLivePlayer

Data Structures

class  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:


Data Structure Documentation

◆ com::tencent::live2::V2TXLivePlayer

class com::tencent::live2::V2TXLivePlayer

Public Member Functions

abstract void setObserver (V2TXLivePlayerObserver observer)
 
abstract int setRenderView (TXCloudVideoView view)
 
abstract int setRenderView (TextureView view)
 
abstract int setRenderView (SurfaceView view)
 
abstract int setRenderRotation (V2TXLiveRotation rotation)
 
abstract int setRenderFillMode (V2TXLiveFillMode mode)
 
abstract int startLivePlay (String url)
 
abstract int stopPlay ()
 
abstract int isPlaying ()
 
abstract int pauseAudio ()
 
abstract int resumeAudio ()
 
abstract int pauseVideo ()
 
abstract int resumeVideo ()
 
abstract int setPlayoutVolume (int volume)
 
abstract int setCacheParams (float minTime, float maxTime)
 
abstract int enableVolumeEvaluation (int intervalMs)
 
abstract int snapshot ()
 
abstract int enableObserveVideoFrame (boolean enable, V2TXLivePixelFormat pixelFormat, V2TXLiveBufferType bufferType)
 
abstract int enableReceiveSeiMessage (boolean enable, int payloadType)
 
abstract void showDebugView (boolean isShow)
 
abstract int setProperty (String key, Object value)
 

Member Function Documentation

◆ enableObserveVideoFrame()

abstract int enableObserveVideoFrame ( boolean  enable,
V2TXLivePixelFormat  pixelFormat,
V2TXLiveBufferType  bufferType 
)
abstract

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
enableWhether to enable custom rendering. [Default]: false
pixelFormatVideo pixel format for custom rendering callback V2TXLivePixelFormat
bufferTypeVideo 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()

abstract int enableReceiveSeiMessage ( boolean  enable,
int  payloadType 
)
abstract

Enables the receiving of SEI messages.

Parameters
enabletrue: enable; false (default): disable
payloadTypeThe 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()

abstract int enableVolumeEvaluation ( int  intervalMs)
abstract

Enables playback volume update.

After this feature is enabled, you can obtain the SDK’s volume evaluation through the V2TXLivePlayerObserver#onPlayoutVolumeUpdate(V2TXLivePlayer, int) callback.

Parameters
intervalMsInterval 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()

abstract int isPlaying ( )
abstract

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()

abstract int pauseAudio ( )
abstract

Pauses the audio stream of the player.

Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ pauseVideo()

abstract int pauseVideo ( )
abstract

Pauses the video stream of the player.

Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ resumeAudio()

abstract int resumeAudio ( )
abstract

Resumes the audio stream of the player.

Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ resumeVideo()

abstract int resumeVideo ( )
abstract

Resumes the video stream of the player.

Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ setCacheParams()

abstract int setCacheParams ( float  minTime,
float  maxTime 
)
abstract

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

Parameters
minTimeMinimum time for auto cache adjustment. The value must be greater than 0. [Default]: 1
maxTimeMaximum 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()

abstract void setObserver ( V2TXLivePlayerObserver  observer)
abstract

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
observerCallback target of the player. For more information, see V2TXLivePlayerObserver.

◆ setPlayoutVolume()

abstract int setPlayoutVolume ( int  volume)
abstract

Sets the volume.

Parameters
volumeVolume. Valid range: 0 - 100. [Default]: 100
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ setProperty()

abstract int setProperty ( String  key,
Object  value 
)
abstract

Calls the advanced API of V2TXLivePlayer.

Attention
This API is used to call some advanced features.
Parameters
keyKey of the advanced API.
valueParameter 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 null.

◆ setRenderFillMode()

abstract int setRenderFillMode ( V2TXLiveFillMode  mode)
abstract

Sets the fill mode of the view.

Parameters
modeFill 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()

abstract int setRenderRotation ( V2TXLiveRotation  rotation)
abstract

Sets the rotation angle of the player view.

Parameters
rotationRotation 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() [1/3]

abstract int setRenderView ( SurfaceView  view)
abstract

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

Parameters
viewPlayer rendering view.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ setRenderView() [2/3]

abstract int setRenderView ( TextureView  view)
abstract

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

Parameters
viewPlayer rendering view.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ setRenderView() [3/3]

abstract int setRenderView ( TXCloudVideoView  view)
abstract

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

Parameters
viewPlayer rendering view.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ showDebugView()

abstract void showDebugView ( boolean  isShow)
abstract

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

Parameters
isShowSpecifies whether to display the debug view. [Default]: false.

◆ snapshot()

abstract int snapshot ( )
abstract

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()

abstract int startLivePlay ( String  url)
abstract

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
urlURL 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()

abstract int stopPlay ( )
abstract

Stops playing the audio and video streams.

Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful