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.
◆ liteav::V2TXLivePlayer
| class liteav::V2TXLivePlayer |
◆ ~V2TXLivePlayer()
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 nullptr.
◆ enableObserveVideoFrame()
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]: false |
| 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()
| virtual int32_t enableReceiveSeiMessage |
( |
bool |
enable, |
|
|
int |
payloadType |
|
) |
| |
|
pure virtual |
Enables the receiving of SEI messages.
- Parameters
-
| enable | true: enable; false (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
◆ enableVolumeEvaluation()
| virtual int32_t enableVolumeEvaluation |
( |
int32_t |
intervalMs | ) |
|
|
pure virtual |
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
-
| 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
◆ isPlaying()
| virtual int32_t isPlaying |
( |
| ) |
|
|
pure virtual |
Indicates whether the player is playing the audio and video streams.
- Returns
- Indicates whether the player is playing the audio and video streams.
◆ pauseAudio()
| virtual int32_t pauseAudio |
( |
| ) |
|
|
pure virtual |
Pauses the audio stream of the player.
- Returns
- Return code V2TXLiveCode
◆ pauseVideo()
| virtual int32_t pauseVideo |
( |
| ) |
|
|
pure virtual |
Pauses the video stream of the player.
- Returns
- Return code V2TXLiveCode
◆ resumeAudio()
| virtual int32_t resumeAudio |
( |
| ) |
|
|
pure virtual |
Resumes the audio stream of the player.
- Returns
- Return code V2TXLiveCode
◆ resumeVideo()
| virtual int32_t resumeVideo |
( |
| ) |
|
|
pure virtual |
Resumes the video stream of the player.
- Returns
- Return code V2TXLiveCode
◆ setCacheParams()
| virtual int32_t setCacheParams |
( |
float |
minTime, |
|
|
float |
maxTime |
|
) |
| |
|
pure virtual |
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()
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
-
◆ setPlayoutVolume()
| virtual int32_t setPlayoutVolume |
( |
int32_t |
volume | ) |
|
|
pure virtual |
Sets the volume.
- Parameters
-
| volume | Volume. Valid range: 0 - 100. [Default]: 100 |
- Returns
- Return code V2TXLiveCode
◆ setRenderFillMode()
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
◆ setRenderRotation()
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
◆ setRenderView()
| virtual int32_t setRenderView |
( |
void * |
view | ) |
|
|
pure virtual |
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
◆ showDebugView()
| virtual void showDebugView |
( |
bool |
isShow | ) |
|
|
pure virtual |
Indicates whether the debug view of the player video status information is displayed.
- Parameters
-
| isShow | Specifies whether to display the debug view. [Default]: false. |
◆ snapshot()
| virtual int32_t snapshot |
( |
| ) |
|
|
pure virtual |
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.
◆ startPlay()
| virtual int32_t startPlay |
( |
const char * |
url | ) |
|
|
pure virtual |
Starts playing the audio and video streams.
- 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.
◆ stopPlay()
| virtual int32_t stopPlay |
( |
| ) |
|
|
pure virtual |
Stops playing the audio and video streams.
- Returns
- Return code V2TXLiveCode
◆ createV2TXLivePlayer()
Gets the V2TXLivePlayer object pointer during dynamic DLL loading.
- Returns
- The
V2TXLivePlayer object pointer is returned. Please call releaseV2TXLivePlayer to destruct the object.
- Attention
- This API works on Windows, macOS, and iOS.
◆ releaseV2TXLivePlayer()
Destructs the V2TXLivePlayer object.
- Parameters
-
| player | Pointer to the V2TXLivePlayer object |
