TXVodSDKEventDef API 简介
点播播放器用到的常量类。
视频分辨率
TX_Enum_Type_VideoResolution
值 | 参数名 | 描述 |
0 | VIDEO_RESOLUTION_TYPE_360_640 | 建议码率 800kbps。 |
1 | VIDEO_RESOLUTION_TYPE_540_960 | 建议码率 1200kbps。 |
2 | VIDEO_RESOLUTION_TYPE_720_1280 | 建议码率 1800kbps。 |
30 | VIDEO_RESOLUTION_TYPE_1080_1920 | 建议码率 3000kbps。 |
画面质量档位
TX_Enum_Type_VideoQuality
值 | 参数名 | 描述 |
1 | VIDEO_QUALITY_STANDARD_DEFINITION | 标清：采用 360 × 640 的分辨率。 |
2 | VIDEO_QUALITY_HIGH_DEFINITION | 高清：采用 540 × 960 的分辨率。 |
3 | VIDEO_QUALITY_SUPER_DEFINITION | 超清：采用 720 × 1280 的分辨率。 |
4 | VIDEO_QUALITY_LINKMIC_MAIN_PUBLISHER | 连麦场景下的大主播使用。 |
5 | VIDEO_QUALITY_LINKMIC_SUB_PUBLISHER | 连麦场景下的小主播（连麦的观众）使用。 |
7 | VIDEO_QUALITY_ULTRA_DEFINITION | 蓝光：采用 1080 × 1920 的分辨率。 |
画面旋转方向
TX_Enum_Type_HomeOrientation
值 | 参数名 | 描述 |
0 | HOME_ORIENTATION_RIGHT | HOME 键在右边，横屏模式。 |
1 | HOME_ORIENTATION_DOWN | HOME 键在下面，手机直播中最常见的竖屏直播模式。 |
2 | HOME_ORIENTATION_LEFT | HOME 键在左边，横屏模式。 |
3 | HOME_ORIENTATION_UP | HOME 键在上边，竖屏直播。 |
画面填充模式
TX_Enum_Type_RenderMode
值 | 参数名 | 描述 |
0 | RENDER_MODE_FILL_SCREEN | 视频画面全屏铺满。 |
1 | RENDER_MODE_FILL_EDGE | 视频画面自适应屏幕。 |
播放事件列表
值 | 参数名 | 描述 |
2002 | VOD_PLAY_EVT_HIT_CACHE | 启播命中缓存。 |
2003 | VOD_PLAY_EVT_RCV_FIRST_I_FRAME | 渲染视频首帧事件。 |
2004 | VOD_PLAY_EVT_PLAY_BEGIN | 视频播放开始。 |
2005 | VOD_PLAY_EVT_PLAY_PROGRESS | 视频播放进度。 |
2006 | VOD_PLAY_EVT_PLAY_END | 视频播放结束。 |
6001 | VOD_PLAY_EVT_LOOP_ONCE_COMPLETE | 循环一轮播放结束。 |
2007 | VOD_PLAY_EVT_PLAY_LOADING | 视频播放 Loading。 |
2008 | VOD_PLAY_EVT_START_VIDEO_DECODER | 解码器启动。 |
2009 | VOD_PLAY_EVT_CHANGE_RESOLUTION | 视频分辨率改变。 |
2010 | VOD_PLAY_EVT_GET_PLAYINFO_SUCC | 获取点播文件信息成功。 |
2011 | VOD_PLAY_EVT_CHANGE_ROTATION | 视频旋转信息。 |
2013 | VOD_PLAY_EVT_VOD_PLAY_PREPARED | 视频加载完毕。 |
2014 | VOD_PLAY_EVT_VOD_LOADING_END | 视频缓冲结束。 |
2017 | VOD_PLAY_EVT_VOD_PLAY_FIRST_VIDEO_PACKET | 收到首帧数据（12.0 版本开始支持）。 |
2019 | VOD_PLAY_EVT_VOD_PLAY_SEEK_COMPLETE | Seek 完成（10.3版本开始支持）。 |
2020 | VOD_PLAY_EVT_SELECT_TRACK_COMPLETE | 切换轨道完成。 |
2026 | VOD_PLAY_EVT_RCV_FIRST_AUDIO_FRAME | 音频首次播放。 |
2103 | PLAY_WARNING_RECONNECT | 网络断连，已启动自动重连。 |
2030 | VOD_PLAY_EVT_VIDEO_SEI | 视频 SEI 信息事件。 |
2031 | VOD_PLAY_EVT_HEVC_DOWNGRADE_PLAYBACK | HEVC 降级播放 |
-2301 | VOD_PLAY_ERR_NET_DISCONNECT | 网络断连，且经多次重连抢救无效。 |
-2303 | VOD_PLAY_ERR_FILE_NOT_FOUND | 文件不存在。 |
-2304 | PLAY_ERR_HEVC_DECODE_FAIL | HEVC 解码失败。 |
-2305 | VOD_PLAY_ERR_HLS_KEY | HLS 解密 key 获取失败。 |
-2306 | VOD_PLAY_ERR_GET_PLAYINFO_FAIL | 获取点播文件信息失败。 |
2106 | PLAY_WARNING_HW_ACCELERATION_FAIL | 硬解启动失败，采用软解。 |
-5 | VOD_PLAY_ERR_LICENCE_CHECK_FAIL | License 不合法，播放失败。 注：在 startVodPlay 之前，需要通过 TXLiveBase#setLicence 设置 License 后方可成功播放，否则将播放失败（黑屏），全局仅设置一次即可。直播 License、短视频 License 和播放器 License 均可使用，若您暂未获取上述 License ，可单击 播放器 License 进行申请，正式版 License 需购买。 |
-6004 | VOD_PLAY_ERR_SYSTEM_PLAY_FAIL | 系统播放器播放错误。 |
-6005 | VOD_PLAY_ERR_DEMUXER_TIMEOUT | 解封装超时。 |
-6006 | VOD_PLAY_ERR_DECODE_VIDEO_FAIL | 视频解码错误，视频格式不支持。 |
-6007 | VOD_PLAY_ERR_DECODE_AUDIO_FAIL | 音频解码错误，音频格式不支持。 |
-6008 | VOD_PLAY_ERR_DECODE_SUBTITLE_FAIL | 字幕解码错误。 |
-6009 | VOD_PLAY_ERR_RENDER_FAIL | 视频渲染错误。 |
-6010 | VOD_PLAY_ERR_PROCESS_VIDEO_FAIL | 视频后处理错误。 |
-6011 | VOD_PLAY_ERR_DOWNLOAD_FAIL | 视频下载出错。 |
-6101 | VOD_PLAY_ERR_DRM | DRM 播放失败 |
画中画控制器状态
值 | 参数名 | 描述 |
0 | TX_VOD_PLAYER_PIP_STATE_UNDEFINED | 无效状态。 |
1 | TX_VOD_PLAYER_PIP_STATE_WILL_START | 画中画即将开始。 |
2 | TX_VOD_PLAYER_PIP_STATE_DID_START | 画中画已经开始。 |
3 | TX_VOD_PLAYER_PIP_STATE_WILL_STOP | 画中画即将结束。 |
4 | TX_VOD_PLAYER_PIP_STATE_RESTORE_UI | 重置 UI。 |
画中画错误类型
值 | 参数名 | 描述 |
0 | TX_VOD_PLAYER_PIP_ERROR_TYPE_NONE | 无错误。 |
1 | TX_VOD_PLAYER_PIP_ERROR_TYPE_DEVICE_NOT_SUPPORT | 设备或系统版本不支持（iPad iOS9+ 才支持 PIP）。 |
2 | TX_VOD_PLAYER_PIP_ERROR_TYPE_PLAYER_NOT_SUPPORT | 播放器不支持。 |
3 | TX_VOD_PLAYER_PIP_ERROR_TYPE_VIDEO_NOT_SUPPORT | 视频不支持。 |
4 | TX_VOD_PLAYER_PIP_ERROR_TYPE_PIP_IS_NOT_POSSIBLE | PIP 控制器不可用。 |
5 | TX_VOD_PLAYER_PIP_ERROR_TYPE_ERROR_FROM_SYSTEM | PIP 控制器报错。 |
10 | TX_VOD_PLAYER_PIP_ERROR_TYPE_PLAYER_NOT_EXIST | 播放器对象不存在。 |
11 | TX_VOD_PLAYER_PIP_ERROR_TYPE_PIP_IS_RUNNING | PIP 功能已经运行。 |
12 | TX_VOD_PLAYER_PIP_ERROR_TYPE_PIP_NOT_RUNNING | PIP 功能没有启动。 |
13 | TX_VOD_PLAYER_PIP_ERROR_TYPE_PIP_START_TIMEOUT | PIP 启动超时。 |
20 | TX_VOD_PLAYER_PIP_ERROR_TYPE_SEAMLESS_PIP_ERROR | 无缝 PIP 功能启动失败。 |
21 | TX_VOD_PLAYER_PIP_ERROR_TYPE_SEAMLESS_PIP_NOT_SUPPORT | 不支持无缝切换 PIP。 |
22 | TX_VOD_PLAYER_PIP_ERROR_TYPE_SEAMLESS_PIP_IS_RUNNING | 无缝 PIP 功能已经运行。 |
AirPlay 状态(仅支持系统播放器)
值 | 参数名 | 描述 |
0 | TX_VOD_PLAYER_AIRPLAY_STATE_NOT_RUNNING | 未运行。 |
1 | TX_VOD_PLAYER_AIRPLAY_STATE_DID_RUNNING | 运行中。 |
AirPlay 错误类型(仅支持系统播放器)
值 | 参数名 | 描述 |
0 | TX_VOD_PLAYER_AIRPLAY_ERROR_TYPE_NONE | 无错误。 |
1 | TX_VOD_PLAYER_AIRPLAY_ERROR_TYPE_PLAYER_NOT_SUPPORT | 播放器不支持。 |
2 | TX_VOD_PLAYER_AIRPLAY_ERROR_TYPE_VIDEO_NOT_SUPPORT | 视频不支持。 |
10 | TX_VOD_PLAYER_AIRPLAY_ERROR_TYPE_PLAYER_INVALID | 播放器对象不可用。 |
11 | TX_VOD_PLAYER_AIRPLAY_ERROR_TYPE_PLAYER_STATE | 播放器状态错误。 |
外挂字幕类型
TX_VOD_PLAYER_SUBTITLE_MIME_TYPE
值 | 参数名 | 描述 |
0 | TX_VOD_PLAYER_MIMETYPE_TEXT_SRT | 外挂字幕 SRT 格式。 |
1 | TX_VOD_PLAYER_MIMETYPE_TEXT_VTT | 外挂字幕 VTT 格式。 |
播放事件参数
值 | 参数名 | 描述 |
"CPU_USAGE" | NET_STATUS_CPU_USAGE | 当前瞬时 CPU 使用率。 |
"VIDEO_WIDTH" | NET_STATUS_VIDEO_WIDTH | 视频分辨率-宽。 |
"VIDEO_HEIGHT" | NET_STATUS_VIDEO_HEIGHT | 视频分辨率-高。 |
"NET_SPEED" | NET_STATUS_NET_SPEED | 当前的网络数据接收速度，单位：KBps。 |
"VIDEO_FPS" | NET_STATUS_VIDEO_FPS | 当前流媒体的视频帧率。 |
"VIDEO_BITRATE" | NET_STATUS_VIDEO_BITRATE | 当前流媒体的视频码率，单位 bps。 |
"AUDIO_BITRATE"; | NET_STATUS_AUDIO_BITRATE | 当前流媒体的音频码率，单位 bps。 |
"VIDEO_CACHE" | NET_STATUS_VIDEO_CACHE | 缓冲区（jitterbuffer）大小，缓冲区当前长度为0，说明离卡顿就不远了，单位：KBps。 |
"SERVER_IP" | NET_STATUS_SERVER_IP | 连接的服务器 IP。 |
"EVT_UTC_TIME" | VOD_PLAY_EVENT_UTC_TIME | UTC 时间。 |
"EVT_BLOCK_DURATION" | VOD_PLAY_EVENT_BLOCK_DURATION | 卡顿时间（毫秒）。 |
"EVT_ERROR_CODE" | VOD_PLAY_EVT_ERROR_CODE | 播放器错误码。 |
"EVT_TIME" | VOD_PLAY_EVENT_TIME | 事件发生时间。 |
"EVT_MSG" | VOD_PLAY_EVENT_MSG | 事件说明。 |
"EVT_PARAM1" | VOD_PLAY_EVENT_PARAM1 | 事件参数1。 |
"EVT_PARAM2" | VOD_PLAY_EVENT_PARAM2 | 事件参数2。 |
"EVT_GET_MSG" | VOD_PLAY_EVENT_GET_MSG | 消息内容。收到 PLAY_EVT_GET_MESSAGE 事件时，通过该字段获取消息内容。 |
"EVT_PLAY_COVER_URL" | VOD_PLAY_EVENT_PLAY_COVER_URL | 视频封面。 |
"EVT_PLAY_URL" | VOD_PLAY_EVENT_PLAY_URL | 视频地址。 |
"EVT_PLAY_NAME" | VOD_PLAY_EVENT_PLAY_NAME | 视频名称。 |
"EVT_PLAY_DESCRIPTION" | VOD_PLAY_EVENT_PLAY_DESCRIPTION | 视频简介。 |
"EVT_PLAY_PROGRESS" | VOD_PLAY_EVENT_PLAY_PROGRESS | 播放进度。 |
"EVT_PLAY_DURATION" | VOD_PLAY_EVENT_PLAY_DURATION | 视频总时长。 |
"EVT_PLAYABLE_DURATION" | VOD_PLAY_EVENT_PLAYABLE_DURATION | 点播可播放时长。 |
"EVT_IMAGESPRIT_WEBVTTURL" | VOD_PLAY_EVENT_IMAGESPRIT_WEBVTTURL | 雪碧图 web vtt 描述文件下载 URL。 |
"EVT_IMAGESPRIT_IMAGEURL_LIST" | VOD_PLAY_EVENT_IMAGESPRIT_IMAGEURL_LIST | 雪碧图图片下载 URL。 |
"VOD_KEY_VIDEO_CODEC_TYPE" | VOD_KEY_VIDEO_CODEC_TYPE | 视频编码类型。 |
"VOD_KEY_BACKUP_URL_MEDIA_TYPE" | VOD_KEY_BACKUP_URL_MEDIA_TYPE | 备选播放资源（VOD_KEY_BACKUP_URL）对应的类型（12.0 版本新增）。 |
"PARAM_MODULE_TYPE" | PLAYER_OPTION_PARAM_MODULE_TYPE | module 类型参数。 |
"PARAM_MODULE_CONFIG" | PLAYER_OPTION_PARAM_MODULE_CONFIG | module 配置。 |
"ENABLE_SENSOR" | PLAYER_OPTION_PARAM_MODULE_VR_ENABLE_SENSOR | 是否开启传感器，默认 true。 |
"FOV" | PLAYER_OPTION_PARAM_MODULE_VR_FOV | 视场角，默认65.0f度，限制范围30.0f度到110.0f度。 |
"ANGLE_X" | PLAYER_OPTION_PARAM_MODULE_VR_ANGLE_X | 水平旋转角度，正值右转，负值左转。0°表示正前方，取值范围-180°到180°。 |
"ANGLE_Y" | PLAYER_OPTION_PARAM_MODULE_VR_ANGLE_Y | 垂直旋转角度，正值上转，负值下转。0°表示水平视⻆，取值范围-85°到85°。 |
"ANGLE_RATE" | PLAYER_OPTION_PARAM_MODULE_VR_ANGLE_RATE | 手势滑动距离与角度比例，比例越大灵敏度越高，默认值为1/3.0f。 |
"ANGLE_SLOPE_THRESHOLD" | PLAYER_OPTION_PARAM_MODULE_VR_ANGLE_SLOPE_THRESHOLD | 旋转 XY 角度斜率阈值，默认值为0.5f，阀值范围内只选取长边旋转。 |
"EVT_KEY_FRAME_CONTENT_LIST" | VOD_PLAY_EVENT_KEY_FRAME_CONTENT_LIST | 视频关键帧描述信息。 |
"EVT_KEY_FRAME_TIME_LIST" | VOD_PLAY_EVENT_KEY_FRAME_TIME_LIST | 关键帧时间。 |
"EVT_PLAY_PDT_TIME_MS" | VOD_PLAY_EVENT_PLAY_PDT_TIME_MS | 播放 PDT 时间（毫秒）。 |
"VOD_KEY_CUSTOM_DATA" | VOD_KEY_CUSTOM_DATA | 自定义透传上报字段 Key（11.7 版本新增）。 |
"EVT_KEY_VIDEO_ROTATION" | VOD_PLAY_EVENT_KEY_VIDEO_ROTATION | MP4视频旋转角度。 |
"EVT_KEY_SELECT_TRACK_INDEX" | EVT_KEY_SELECT_TRACK_INDEX | 外挂字幕 Event 参数返回：切换的媒体轨道 index。 |
"EVT_KEY_SELECT_TRACK_ERROR_CODE" | EVT_KEY_SELECT_TRACK_ERROR_CODE | 外挂字幕 Event 参数返回：切换媒体轨道的返回错误码。 |
"VOD_PLAY_BUFFERING_LOADING_TYPE" | VOD_PLAY_BUFFERING_LOADING_TYPE | 播放器 Loading 的 Type 类型。 |
"MONET_AC_DO_ROTATE" | PLAYER_OPTION_PARAM_MODULE_VR_DO_ROTATE | VR 旋转角度。 |
"EVT_KEY_WATER_MARK_TEXT" | EVT_KEY_WATER_MARK_TEXT | 幽灵水印文本（11.5版本开始支持）。 |
"EVT_KEY_SEI_TYPE" | EVT_KEY_SEI_TYPE | 视频 SEI 类型。 |
"EVT_KEY_SEI_SIZE" | EVT_KEY_SEI_SIZE | 视频 SEI 数据 buffer 大小。 |
"EVT_KEY_SEI_DATA" | EVT_KEY_SEI_DATA | 视频 SEI 数据 buffer。 |
播放器媒资类型
值 | 参数名 | 描述 |
0 | MEDIA_TYPE_AUTO | auto 类型。 |
1 | MEDIA_TYPE_HLS_VOD | 自适应码率播放 HLS 点播媒资。 |
2 | MEDIA_TYPE_HLS_LIVE | 自适应码率播放 HLS 直播媒资。 |
3 | MEDIA_TYPE_FILE_VOD | MP4等通用文件点播媒资。 |
4 | MEDIA_TYPE_DASH_VOD | DASH 点播媒资。 |
MP4 加密等级
值 | 参数名 | 描述 |
0 | MP4_ENCRYPTION_LEVEL_NONE | MP4 不加密播放。 |
1 | MP4_ENCRYPTION_LEVEL_L1 | L1， MP4 在线加密播放。 |
2 | MP4_ENCRYPTION_LEVEL_L2 | L2， MP4 本地加密播放。 |
module 类型
TX_VOD_PLAYER_OPTION_PARAM_MODULE_TYPE
值 | 参数名 | 描述 |
0 | PLAYER_OPTION_PARAM_MODULE_TYPE_NONE | 空类型，即关闭超分和 VR 等。 |
1 | PLAYER_OPTION_PARAM_MODULE_TYPE_SR | 超分类型。 |
11 | PLAYER_OPTION_PARAM_MODULE_TYPE_VR_PANORAMA | VR 全景模型，单目。 |
12 | PLAYER_OPTION_PARAM_MODULE_TYPE_VR_BINOCULAR | VR 全景模型，双目。 |
未分类变量
值 | 参数名 | 描述 |
0 | PLAYER_SYSTEM_MEDIA_PLAYER | 系统播放器。 |
1 | PLAYER_THUMB_PLAYER | 自研播放器，支持软解，兼容性更好。 |
-1 | INDEX_AUTO | 自适应码率 index 标识。 |
"450" | PLAYER_OPTION_KEY_SUBTITLE_OUTPUT_TYPE | 外挂字幕输出类型配置 Key。 |
"VOD_KEY_BACKUP_URL" | VOD_KEY_BACKUP_URL | 降级播放备选 URL Key。 |
"text/x-subrip" | VOD_PLAY_MIMETYPE_TEXT_SRT | 外挂字幕 SRT 格式。 |
"text/vtt" | VOD_PLAY_MIMETYPE_TEXT_VTT | 外挂字幕 VTT 格式。 |
