Copyright (c) 2021 Tencent. All rights reserved.
Module: V2TXLivePlayer @ TXLiteAVSDK
Function: 腾讯云直播播放器
功能
腾讯云直播播放器。
主要负责从指定的直播流地址拉取音视频数据，并进行解码和本地渲染播放。
介绍
播放器包含如下能力：
支持 RTMP、HTTP-FLV、HLS、TRTC、WebRTC 协议。
屏幕截图，可以截取当前直播流的视频画面。
延时调节，可以设置播放器缓存自动调整的最小和最大时间。
自定义的视频数据处理，您可以根据项目需要处理直播流中的视频数据后，再进行渲染以及播放。
v2txliveplayer
V2TXLivePlayer
函数列表 | 描述 |
设置播放器回调 | |
设置播放器的视频渲染 View。该控件负责显示视频内容 | |
设置播放器画面的旋转角度 | |
设置画面的填充模式 | |
设置播放器画面的镜像模式 | |
开始播放音视频流 | |
停止播放音视频流 | |
播放器是否正在播放中 | |
暂停播放器的音频流 | |
恢复播放器的音频流 | |
暂停播放器的视频流 | |
恢复播放器的视频流 | |
设置播放器音量 | |
设置播放器缓存自动调整的最小和最大时间 ( 单位：秒 ) | |
直播流无缝切换，支持 FLV 和 LEB | |
启用播放音量大小提示 | |
截取播放过程中的视频画面 | |
开启接收 SEI 消息 | |
是否显示播放器状态信息的调试浮层 | |
调用 V2TXLivePlayer 的高级 API 接口 | |
开始录制音视频流 | |
停止录制音视频流 |
setObserver
setObserver
setObserver | (observer: V2TXLivePlayerObserver) |
设置播放器回调
通过设置回调，可以监听 V2TXLivePlayer 播放器的一些回调事件，
包括播放器状态、播放音量回调、音视频首帧回调、统计数据、警告和错误信息等。
参数 | 描述 |
observer | 播放器的回调目标对象，更多信息请查看 V2TXLivePlayerObserver |
setRenderView
setRenderView
setRenderView | (view: string) |
设置播放器的视频渲染 View。该控件负责显示视频内容
参数 | 描述 |
view | 播放器渲染 View。 |
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK：成功。
setRenderRotation
setRenderRotation
setRenderRotation |
设置播放器画面的旋转角度
参数 | 描述 |
rotation | V2TXLiveRotation0【默认值】: 0度, 不旋转。 V2TXLiveRotation90: 顺时针旋转90度。 V2TXLiveRotation180: 顺时针旋转180度。 V2TXLiveRotation270: 顺时针旋转270度。 |
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
setRenderFillMode
setRenderFillMode
setRenderFillMode |
设置画面的填充模式
参数 | 描述 |
mode | V2TXLiveFillModeFill 【默认值】: 图像铺满屏幕，不留黑边，如果图像宽高比不同于屏幕宽高比，部分画面内容会被裁剪掉。 V2TXLiveFillModeFit: 图像适应屏幕，保持画面完整，但如果图像宽高比不同于屏幕宽高比，会有黑边的存在。 V2TXLiveFillModeScaleFill: 图像拉伸铺满，因此长度和宽度可能不会按比例变化。 |
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
setRenderMirrorMode
setRenderMirrorMode
setRenderMirrorMode | (enable: boolean) |
设置播放器画面的镜像模式
开启镜像模式后，视频画面将左右翻转，您可以根据需要随时切换观看效果。
参数 | 描述 |
enable | 是否开启播放端镜像模式。【默认值】：false。 |
返回值说明：
返回值 V2TXLiveCode
V2TXLIVE_OK: 成功
startPlay
startPlay
startPlay | (url: string) |
开始播放音视频流
参数 | 描述 |
url | 音视频流的播放地址，支持 RTMP, HTTP-FLV, TRTC。 |
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK：操作成功，开始连接并播放。
V2TXLIVE_ERROR_INVALID_PARAMETER：操作失败，url 不合法。
V2TXLIVE_ERROR_REFUSED：RTC 不支持同一设备上同时推拉同一个 StreamId。
stopPlay
stopPlay
stopPlay | () |
停止播放音视频流
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
isPlaying
isPlaying
isPlaying | () |
播放器是否正在播放中
返回值说明：
是否正在播放。
1: 正在播放中。
0: 已经停止播放。
pauseAudio
pauseAudio
pauseAudio | () |
暂停播放器的音频流
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
resumeAudio
resumeAudio
resumeAudio | () |
恢复播放器的音频流
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
pauseVideo
pauseVideo
pauseVideo | () |
暂停播放器的视频流
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
resumeVideo
resumeVideo
resumeVideo | () |
恢复播放器的视频流
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
setPlayoutVolume
setPlayoutVolume
setPlayoutVolume | (volume: number) |
设置播放器音量
参数 | 描述 |
volume | 音量大小，取值范围0 - 100。【默认值】: 100。 |
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
setCacheParams
setCacheParams
setCacheParams | (minTime: number |
| maxTime: number) |
设置播放器缓存自动调整的最小和最大时间 ( 单位：秒 )
参数 | 描述 |
maxTime | 缓存自动调整的最大时间，取值需要大于0。【默认值】：5。 |
minTime | 缓存自动调整的最小时间，取值需要大于0。【默认值】：1。 |
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
V2TXLIVE_ERROR_INVALID_PARAMETER: 操作失败，minTime 和 maxTime 需要大于0。
V2TXLIVE_ERROR_REFUSED: 播放器处于播放状态，不支持修改缓存策略。
switchStream
switchStream
switchStream | (newUrl: string) |
直播流无缝切换，支持 FLV 和 LEB
参数 | 描述 |
newUrl | 新的拉流地址。 |
enableVolumeEvaluation
enableVolumeEvaluation
enableVolumeEvaluation | (intervalMs: number) |
启用播放音量大小提示
开启后可以在 V2TXLivePlayerObserver 回调中获取到 SDK 对音量大小值的评估。
参数 | 描述 |
intervalMs | 决定了 onPlayoutVolumeUpdate 回调的触发间隔，单位为ms，最小间隔为100ms，如果小于等于0则会关闭回调，建议设置为300ms；【默认值】：0，不开启。 |
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
snapshot
snapshot
snapshot | () |
截取播放过程中的视频画面
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
V2TXLIVE_ERROR_REFUSED: 播放器处于停止状态，不允许调用截图操作。
enableReceiveSeiMessage
enableReceiveSeiMessage
enableReceiveSeiMessage | (enable: boolean |
| payloadType: number) |
开启接收 SEI 消息
参数 | 描述 |
enable | true: 开启接收 SEI 消息; false: 关闭接收 SEI 消息。【默认值】: false。 |
payloadType | 指定接收 SEI 消息的 payloadType，支持 5、242、243，请与发送端的 payloadType 保持一致。 |
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
showDebugView
showDebugView
showDebugView | (isShow: boolean) |
是否显示播放器状态信息的调试浮层
参数 | 描述 |
isShow | 是否显示。【默认值】：false。 |
setProperty
setProperty
setProperty | (key: string |
| value: Object) |
调用 V2TXLivePlayer 的高级 API 接口
参数 | 描述 |
key | 高级 API 对应的 key。 |
value | 调用 key 所对应的高级 API 时，需要的参数。 |
注意
该接口用于调用一些高级功能。
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK: 成功。
V2TXLIVE_ERROR_INVALID_PARAMETER: 操作失败，key 不允许为 null。
startLocalRecording
startLocalRecording
startLocalRecording |
开始录制音视频流
注意
拉流开启后才能开始录制，非拉流状态下开启录制无效。
录制过程中不要动态切换软/硬解，生成的视频极有可能出现异常。
返回值说明：
返回值 V2TXLiveCode。
V2TXLIVE_OK : 成功。 V2TXLIVE_ERROR_INVALID_PARAMETER : 参数不合法，例如 filePath 为空。 V2TXLIVE_ERROR_REFUSED : API被拒绝，拉流尚未开始。stopLocalRecording
stopLocalRecording
stopLocalRecording | () |
停止录制音视频流
注意
当停止拉流后，如果视频还在录制中，SDK 内部会自动结束录制。
