tencent cloud

文档反馈

API 文档

最后更新时间:2022-08-17 16:38:44

    TXVodPlayer

    点播播放器

    请参见 TXVodPlayer
    主要负责从指定的点播流地址拉取音视频数据,并进行解码和本地渲染播放。
    播放器包含如下能力:

    • 支持 FLV、MP4 及 HLS 多种播放格式,支持 基础播放(URL 播放) 和 点播播放(Fileid 播放)两种播放方式 。
    • 屏幕截图,可以截取当前播放流的视频画面。
    • 通过手势操作,调节亮度、声音、进度等。
    • 可以手动切换不同的清晰度,也可根据网络带宽自适应选择清晰度。
    • 可以指定不同倍速播放,并开启镜像和硬件加速。
    • 完整能力,请参见 点播超级播放器 - 能力清单

    播放器配置接口

    API 描述
    setConfig 设置播放器配置信息,配置信息请参见 TXVodPlayConfig
    setPlayerView 设置播放器的视频渲染 TXCloudVideoView。
    setPlayerView 设置播放器的视频渲染 TextureView。
    setSurface 设置播放器的视频渲染 SurfaceView。
    setStringOption 设置播放器业务参数,参数格式为<string,object>

    播放基础接口

    API 描述
    startPlay 播放 HTTP URL 形式地址。
    startPlay 以 fileId 形式播放,传入TXPlayInfoParams参数。
    stopPlay 停止播放。
    isPlaying 是否正在播放。
    pause 暂停播放,停止获取流数据,保留最后一帧画面。
    resume 恢复播放,重新获取流数据。
    seek 跳转到视频流指定时间点,单位秒。
    seek 跳转到视频流指定时间点,单位毫秒。
    getCurrentPlaybackTime 获取当前播放位置,单位秒。
    getBufferDuration 获取缓存的总时长,单位秒。
    getDuration 获取总时长,单位秒。
    getPlayableDuration 获取可播放时长,单位秒。
    getWidth 获取视频宽度。
    getHeight 获取视频高度。
    setAutoPlay 设置点播是否 startPlay 后自动开始播放,默认自动播放。
    setStartTime 设置播放开始时间。
    setToken 加密 HLS 的 token。
    setLoop 设置是否循环播放。
    isLoop 返回是否循环播放状态。

    视频相关接口

    API 描述
    enableHardwareDecode 启用或禁用视频硬解码。
    snapshot 获取当前视频帧图像。
    注意:由于获取当前帧图像是比较耗时的操作,所以截图会通过异步回调出来。
    setMirror 设置镜像。
    setRate 设置点播的播放速率,默认1.0。
    getBitrateIndex 返回当前播放的码率索引。
    setBitrateIndex 设置当前正在播放的码率索引,无缝切换清晰度。清晰度切换可能需要等待一小段时间。
    setRenderMode 设置 图像平铺模式
    setRenderRotation 设置 图像渲染角度

    音频相关接口

    API 描述
    setMute 设置是否静音播放。
    setAudioPlayoutVolume 设置音量大小,范围:0 - 100。
    setRequestAudioFocus 设置是否自动获取音频焦点 默认自动获取。

    事件通知接口

    API 描述
    setPlayListener 设置播放器的回调(已弃用,建议使用 setVodListener)。
    setVodListener 设置播放器的回调。
    onNotifyEvent 点播播放事件通知。
    onNetSuccess 点播播放网络状态通知。
    onNetFailed 播放 fileId 网络异常通知。

    TRTC 相关接口

    通过以下接口,可以把点播播放器的音视频流通过 TRTC 进行推送,更多 TRTC 服务请参见 TRTC 产品概述

    API 描述
    attachTRTC 点播绑定到 TRTC 服务。
    detachTRTC 点播解绑 TRTC 服务。
    publishVideo 开始推送视频流。
    unpublishVideo 取消推送视频流。
    publishAudio 开始推送音频流。
    unpublishAudio 取消推送音频流。

    ITXVodPlayListener

    腾讯云点播回调通知。

    SDK 基础回调

    API 描述
    onPlayEvent 点播播放事件通知,请参见 播放事件列表事件参数
    onNetStatus 点播播放器 网络状态通知

    TXVodPlayConfig

    点播播放器配置类。

    基础配置接口

    API 描述
    setConnectRetryCount 设置播放器重连次数。
    setConnectRetryInterval 设置播放器重连间隔,单位秒。
    setTimeout 设置播放器连接超时时间,单位秒。
    setCacheFolderPath 设置点播缓存目录,点播 MP4、HLS 有效。
    setMaxCacheItems 设置缓存文件个数。接口废弃,请使用TXPlayerGlobalSetting#setMaxCacheSize 进行全局配置。
    setPlayerType 设置播放器类型。
    setHeaders 设置自定义 HTTP headers。
    setEnableAccurateSeek 设置是否精确 seek,默认 true。
    setAutoRotate 播放 MP4 文件时,若设为 YES 则根据文件中的旋转角度自动旋转。
    旋转角度可在 PLAY_EVT_CHANGE_ROTATION 事件中获得。默认 YES。
    setSmoothSwitchBitrate 平滑切换多码率 HLS,默认 false。
    setCacheMp4ExtName 缓存 MP4 文件扩展名。
    setProgressInterval 设置进度回调间隔,单位毫秒。
    setMaxBufferSize 最大预加载大小,单位 MB。
    setMaxPreloadSize 设置预加载最大缓冲大小,单位:MB。
    setExtInfo 设置拓展信息。
    setPreferredResolution 播放 HLS 有多条码流时,根据设定的 preferredResolution 选最优的码流进行起播,preferredResolution 是宽高的乘积(width * height), 启播前设置才有效。

    TXPlayerGlobalSetting

    点播播放器全局配置类

    API 描述
    setCacheFolderPath 设置播放引擎的cache目录。设置后,离线下载,预下载,播放器等会优先从此目录读取和存储
    setMaxCacheSize 设置播放引擎的最大缓存大小。设置后会根据设定值自动清理Cache目录的文件。单位MB。

    TXVodPreloadManager

    点播播放器预下载接口类

    API 描述
    getInstance 获取 TXVodPreloadManager 实例对象,单例模式。
    startPreload 启动预下载前,请先设置好播放引擎的缓存目录。 TXPlayerGlobalSetting#setCacheFolderPath 和缓存大小。TXPlayerGlobalSetting#setMaxCacheSize。
    stopPreload 停止预下载。

    TXVodDownloadManager

    点播播放器视频下载接口类。当前只支持下载非嵌套 m3u8 视频源,对 simpleAES 加密视频源将进行腾讯云私有加密算法加密以提升安全性。

    API 描述
    getInstance 获取 TXVodDownloadManager 实例对象,单例模式。
    setHeaders 设置下载 HTTP 头。
    setListener 设置下载回调方法,下载前必须设好。
    startDownloadUrl 以 URL 方式开始下载。
    startDownload 以 fileid 方式开始下载。
    stopDownload 停止下载,ITXVodDownloadListener.onDownloadStop 回调时停止成功。
    deleteDownloadMediaInfo 删除下载信息。
    getDownloadMediaInfoList 获取所有用户的下载列表信息。
    getDownloadMediaInfo 获取下载信息。

    ITXVodDownloadListener

    腾讯云视频下载回调通知。

    API 描述
    onDownloadStart 下载开始
    onDownloadProgress 下载进度更新
    onDownloadStop 下载停止
    onDownloadFinish 下载结束
    onDownloadError 下载过程中遇到错误

    TXVodDownloadDataSource

    腾讯云视频fildid下载源,下载时作为参数传入。

    API 描述
    TXVodDownloadDataSource 构造函数,传入 appid,fileid,quality,pSign,username 等参数
    getAppId 获取传入的 appid
    getFileId 获取传入的 fileid
    getPSign 获取传入的 psign
    getQuality 获取传入的 quality
    getUserName 获取传入的 userName,默认“default”

    TXVodDownloadMediaInfo

    腾讯云视频下载信息,可获取下载进度,播放链接等等信息

    API 描述
    getDataSource fileid下载时获取传入的 fileid 下载源
    getDuration 获取下载的总时长
    getPlayableDuration 获取已下载的可播放时长
    getSize 获取下载文件总大小,只针对 fileid 下载源有效
    getDownloadSize 获取已下载文件大小,只针对 fileid 下载源有效
    getProgress 获取当前下载进度
    getPlayPath 获取当前播放路径,可传给 TXVodPlayer 播放
    getDownloadState 获取下载状态
    isDownloadFinished 判断是否下载完成

    错误码表

    常规事件

    code 事件定义 含义说明
    2004 PLAY_EVT_PLAY_BEGIN 视频播放开始(若有转菊花效果,此时将停止)。
    2005 PLAY_EVT_PLAY_PROGRESS 视频播放进度,会通知当前播放进度、加载进度和总体时长。
    2007 PLAY_EVT_PLAY_LOADING 视频播放 loading,如果能够恢复,之后会有 LOADING_END 事件。
    2014 PLAY_EVT_VOD_LOADING_END 视频播放 loading 结束,视频继续播放。
    2006 PLAY_EVT_PLAY_END 视频播放结束。
    2013 PLAY_EVT_VOD_PLAY_PREPARED 播放器已准备完成,可以播放。
    2003 PLAY_EVT_RCV_FIRST_I_FRAME 网络接收到首个可渲染的视频数据包(IDR)。
    2009 PLAY_EVT_CHANGE_RESOLUTION 视频分辨率改变。
    2011 PLAY_EVT_CHANGE_ROTATION MP4 视频旋转角度。

    警告事件

    code 事件定义 含义说明
    -2301 PLAY_ERR_NET_DISCONNECT 网络断连,且经多次重连亦不能恢复,更多重试请自行重启播放。
    -2305 PLAY_ERR_HLS_KEY HLS 解密 key 获取失败。
    2101 PLAY_WARNING_VIDEO_DECODE_FAIL 当前视频帧解码失败。
    2102 PLAY_WARNING_AUDIO_DECODE_FAIL 当前音频帧解码失败
    2103 PLAY_WARNING_RECONNECT 网络断连, 已启动自动重连 (重连超过三次就直接抛送 PLAY_ERR_NET_DISCONNECT)。
    2106 PLAY_WARNING_HW_ACCELERATION_FAIL 硬解启动失败,采用软解。
    -2304 PLAY_ERR_HEVC_DECODE_FAIL H265 解码失败。
    -2303 PLAY_ERR_FILE_NOT_FOUND 播放的文件不存在。
    </string,object>
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持