播放管理器 PlayerManager
简介
ESPlayerManager 是一套集成了广告、视频播放功能的完整的播放管理组件。 ESPlayerManager支持开发者可以自定义以下功能:
- 集成自有视频播放器
- 视频播放界面
- 视频播放事件监听
- 广告播放界面
- 广告播放事件监听
示例
你可以在quicktvui-playground 上查看示例。
你可以在quicktvui-api-demo-vue3 上查看API Demo。
API
DataStructure
ESMediaItem
媒资条目
| Name | Description | Type | Default |
|---|---|---|---|
| id | 媒资的唯一标识符 | number / string | - |
| mediaSourceList | 媒资资源列表 | ESMediaSourceList | - |
| playerType | 播放器的类型 | number | - |
| interceptors | 媒资条目拦截器 | Array<ESIPlayerInterceptor> | - |
| position | 媒资播放位置 | ESPlayerPosition | - |
| metadata | 媒资信息 | ESMediaMetadata | - |
| previousRollADList | 前贴片广告资源列表 | ESMediaSourceList | - |
| middleRollADList | 中插广告资源列表 | ESMediaSourceList | - |
| postRollADList | 后贴广告资源列表 | ESMediaSourceList | - |
| adPlayerType | 广告播放器类型 | number | - |
ESMediaItemList
媒资条目列表
| Name | Description | Type | Default |
|---|---|---|---|
| index | 默认播放媒资条目的索引 | number | - |
| list | 媒资条目列表 | Array<ESMediaItem> | - |
| interceptors | 媒资条目列表拦截器 | Array<ESIPlayerInterceptor> | - |
| metadata | 媒资信息 | ESMediaMetadata | - |
Attributes
| Name | Description | Type | Default |
|---|---|---|---|
| playerList | 播放器数组列表 | Array<ESIPlayer> | [] |
| playerViewList | 播放器视图数组列表 | Array<ESIPlayerManagerView> | [] |
| adPlayerList | 广告播放器数组列表 | Array<ESIPlayer | |
| adPlayerViewList | 广告播放器视图数组列表 | Array<ESIPlayerManagerView> | [] |
| adChannel | 广告的渠道 | string | '' |
| adDebug | 是否开启广告调试模式 | boolean | false |
| adTest | 是否开启广告测试环境 | boolean | false |
| playMediaAuto | 是否自动播放媒资 | boolean | true |
| playMediaSourceAuto | 是否自动播放媒资数据源 | boolean | true |
| playMediaSourceListMode | 媒资数据源播放模式 | ESPlayerPlayMode | ES_PLAYER_PLAY_MODE_ONCE |
| playerBackgroundColor | 播放管理器背景颜色 | string | transparent |
| smallWindowWidth | 播放小窗口模式宽度 | number | 976 |
| smallWindowHeight | 播放小窗口模式高度 | number | 557 |
| fullWindowWidth | 播放全屏窗口模式宽度 | number | 1920 |
| fullWindowHeight | 播放全屏窗口模式高度 | number | 1080 |
| floatWindowWidth | 播放浮动窗口模式宽度 | number | 400 |
| floatWindowHeight | 播放浮动窗口模式高度 | number | 230 |
| initPlayerWindowType | 初始化播放窗口模式 | ESPlayerWindowType | ES_PLAYER_WINDOW_TYPE_SMALL |
| isEnabled | 播放管理器是否可用 | boolean | true |
Events
| Name | Description | Type |
|---|---|---|
| onPlayerInitialized | 播放器初始化事件 | Function |
| onPlayerPlayMediaSourceList | 播放媒资资源列表事件 | Function |
| onPlayerPlayMediaSource | 播放媒资资源事件 | Function |
| onPlayerInterceptSuccess | 播放拦截器成功事件 | Function |
| onPlayerInterceptError | 播放拦截器错误事件 | Function |
| onPlayerSizeChanged | 播放器尺寸变化事件 | Function |
| onPlayerPreparing | 播放器准备中事件 | Function |
| onPlayerPrepared | 播放器准备好事件 | Function |
| onPlayerBufferStart | 播放器开始缓冲事件 | Function |
| onPlayerBufferEnd | 播放器缓冲结束事件 | Function |
| onPlayerPlaying | 播放器开始播放事件 | Function |
| onPlayerProgressChanged | 播放进度事件 | Function |
| onPlayerDurationChanged | 播放总长度事件 | Function |
| onPlayerSeekStart | 播放器开始快进事件 | Function |
| onPlayerSeekCompleted | 播放器快进结束事件 | Function |
| onPlayerPaused | 播放器暂停播放事件 | Function |
| onPlayerResumed | 播放器恢复播放事件 | Function |
| onPlayerStopped | 播放器停止播放事件 | Function |
| onPlayerCompleted | 播放器播放完毕事件 | Function |
| onPlayerError | 播放错误事件 | Function |
| onPlayerInfo | 播放信息事件 | Function |
| onPlayerNoMediaSourceCanPlay | 无媒资资源可播放事件 | Function |
| onPlayerVolumeChanged | 播放器音量变化事件 | Function |
| onPlayerLeftVolumeChanged | 播放器左声道音量变化事件 | Function |
| onPlayerRightVolumeChanged | 播放器右声道音量变化事件 | Function |
| onPlayerDefinitionListChanged | 播放器媒资清晰度列表事件 | Function |
| onPlayerDefinitionChanged | 播放器媒资清晰度事件 | Function |
| onPlayerPlayRateListChanged | 播放速率列表事件 | Function |
| onPlayerPlayRateChanged | 播放速率事件 | Function |
| onPlayerDecodeListChanged | 播放器解码方式列表事件 | Function |
| onPlayerDecodeChanged | 播放器解码方式事件 | Function |
| onPlayerAspectRatioListChanged | 画面比例列表事件 | Function |
| onPlayerAspectRatioChanged | 画面比例事件 | Function |
| onPlayerPlayMediaSourceListModeListChanged | 播放媒资资源列表模式列表事件 | Function |
| onPlayerPlayMediaSourceListModeChanged | 播放媒资资源列表模式事件 | Function |
| onPlayerRenderListChanged | 渲染模式列表事件 | Function |
| onPlayerRenderChanged | 渲染模式事件 | Function |
| onPlayerViewSizeChanged | 播放器尺寸变化事件 | Function |
| onPlayerViewChanged | 播放器视图变化事件 | Function |
| onPlayerClickable | 播放器视图可点击事件 | Function |
| onPlayerPlayMediaList | 播放媒资条目列表事件 | Function |
| onPlayerPlayMedia | 播放媒资条目事件 | Function |
| onPlayerInterceptSuccess | 播放拦截器成功事件 | Function |
| onPlayerInterceptError | 播放拦截器错误事件 | Function |
| onPlayerNoMediaCanPlay | 无媒资可播放事件 | Function |
| onPlayerPlayMediaListModeListChanged | 播放媒资列表模式列表事件 | Function |
| onPlayerPlayMediaListModeChanged | 播放媒资列表模式事件 | Function |
| onPlayerPlayMediaSourceListModeListChanged | 播放媒资资源列表模式列表事件 | Function |
| onPlayerPlayMediaSourceListModeChanged | 播放媒资资源列表模式事件 | Function |
| onPlayerWindowTypeChanged | 播放管理器窗口变化事件 | Function |
Exposes
| Name | Description | Type |
|---|---|---|
| initialize | 初始化 | Function |
| isInitialized | 判断播放管理器是否初始化 | Function |
| setVisible | 设置播放管理器是否可见 | Function |
| playMediaSourceList | 播放媒资资源列表 | Function |
| playMediaSourceByIndex | 根据媒资资源索引进行播放 | Function |
| playMediaSourceById | 根据媒资资源唯一标识符进行播放 | Function |
| playMediaSource | 播放媒资资源 | Function |
| playNextMediaSource | 播放下一个媒资资源 | Function |
| playPreviousMediaSource | 播放上一个媒资资源 | Function |
| getMediaSourceList | 获取正在播放的媒资资源列表 | Function |
| getMediaSource | 根据媒资资源索引获取媒资资源 | Function |
| getPlayingMediaSourceIndex | 获取正在播放的媒资资源的索引 | Function |
| getPlayingMediaSourceList | 获取正在播放的媒资资源列表 | Function |
| getPlayingMediaSource | 获取正在播放的媒资资源 | Function |
| play | 播放器的播放方法 | Function |
| start | 播放器的开始播放方法 | Function |
| pause | 播放器的暂停播放方法 | Function |
| resume | 恢复播放器播放 | Function |
| stop | 停止播放器播放 | Function |
| reset | 重置播放器 | Function |
| release | 回收播放器资源 | Function |
| seekTo | 播放快进 | Function |
| getDuration | 获取播放总时长 | Function |
| getCurrentPosition | 获取当前播放的进度 | Function |
| setSize | 设置播放器的尺寸 | Function |
| setPlayRate | 设置播放速率 | Function |
| setPlayMode | 设置播放模式 | Function |
| setDefinition | 设置播放媒资清晰度 | Function |
| setCache | 设置播放缓存策略 | Function |
| setDecode | 设置播放解码方式 | Function |
| setRender | 设置播放渲染方式 | Function |
| setAspectRatio | 设置播放画面比例 | Function |
| getLeftVolume | 获取左声道音量 | Function |
| getRightVolume | 获取右声道音量 | Function |
| setLeftVolume | 设置左声道音量 | Function |
| setRightVolume | 设置右声道音量 | Function |
| setVolume | 设置左右声道音量 | Function |
| getVolume | 获取音量 | Function |
| setStopped | 设置播放管理器的停止状态 | Function |
| setEnabled | 设置播放管理器的可用状态 | Function |
| setProgressCallback | 设置播放进度回调 | Function |
| setDurationCallback | 设置播放总进度回调 | Function |
| invalidate | 刷新播放视图 | Function |
| playMediaList | 播放媒资列表 | Function |
| playMediaByIndex | 播放指定索引的媒资 | Function |
| playMediaById | 播放指定唯一标识符的媒资 | Function |
| playMedia | 播放媒资 | Function |
| addMediaToLast | 添加媒资列表到播放列表的末尾 | Function |
| addMediaToFirst | 添加媒资列表到播放列表的首位 | Function |
| addMediaToIndex | 添加媒资列表到播放列表的指定位置 | Function |
| replaceMedia | 替换媒资列表指定位置媒资 | Function |
| getMediaList | 获取播放的媒资列表 | Function |
| getMedia | 获取指定索引的媒资 | Function |
| getPlayingMediaIndex | 获取正在播放的媒资的索引 | Function |
| getPlayingMediaList | 获取正在播放的媒资列表 | Function |
| getPlayingMedia | 获取正在播放的媒资 | Function |
| getWindowType | 获取当前播放管理器的窗口类型 | Function |
| setFloatWindow | 设置播放管理器浮动窗口 | Function |
| setSmallWindow | 设置播放管理器小窗口 | Function |
| setFullWindow | 设置播放管理器全屏窗口 | Function |
| setWindowType | 设置播放管理器窗口 | Function |
| setPlayMediaListMode | 设置播放媒资模式 | Function |
| canPlayNextMedia | 判断是否可以播放视频列表下一个媒资 | Function |
| playNextMedia | 播放下一个媒资 | Function |
| canPlayPreviousMedia | 判断是否可以播放视频列表上一个媒资 | Function |
| playPreviousMedia | 播放上一个媒资 | Function |
| onKeyDown | 处理按键按下逻辑 | Function |
| onKeyUp | 处理按键抬起逻辑 | Function |
| onBackPressed | 处理返回键逻辑 | Function |