播放器 ESIPlayer
简介
ESIPlayer 是一套播放器通用接口。各个播放器可以根据接口实现对应业务的播放器。
数据结构
ESMediaSource
媒资资源
参数 | 描述 | 类型 | 必填 |
---|---|---|---|
id | 媒资资源唯一标识符 | number | string | 否 |
uri | 媒资资源地址 | any | 是 |
definition | 媒资资源清晰度 | ESPlayerDefinition | 否 |
interceptors | 媒资资源拦截器 | Array<ESIPlayerInterceptor> | 否 |
metadata | 媒资资源信息 | ESMediaMetadata | 否 |
ESMediaSourceList
媒资资源列表
参数 | 描述 | 类型 | 必填 |
---|---|---|---|
index | 默认播放媒资资源的索引 | number | 是 |
list | 媒资资源列表 | Array<ESMediaSource> | 是 |
interceptors | 媒资资源列表拦截器 | Array<ESIPlayerInterceptor> | 否 |
metadata | 媒资资源信息 | ESMediaMetadata | 否 |
position | 媒资资源播放位置 | ESPlayerPosition | 否 |
属性
参数 | 描述 | 类型 | 必填 | 默认值 |
---|---|---|---|---|
playerType | 播放器类型 | number | 是 | -1 |
playMediaSourceAuto | 是否自动播放媒资数据源 | boolean | 否 | true |
backgroundColor | 播放器背景颜色 | string | 否 | transparent |
playerWidth | 播放器宽度 | number | 否 | 1920 |
playerHeight | 播放器高度 | number | 否 | 1080 |
playerZIndex | 播放器z-index | number | 否 | 1 |
事件
onPlayerInitialized
完整事件声明:onPlayerInitialized():void
播放器初始化事件。
onPlayerPlayMediaSourceList
完整事件声明:onPlayerPlayMediaSourceList(mediaSourceList: ESMediaSourceList):void
播放媒资资源列表事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
mediaSourceList | 媒资资源列表 | ESMediaSourceList | 是 |
onPlayerPlayMediaSource
完整事件声明:onPlayerPlayMediaSource(mediaSource: ESMediaSource):void
播放媒资资源事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
mediaSource | 媒资资源 | ESMediaSource | 是 |
onPlayerInterceptSuccess
完整事件声明:onPlayerInterceptSuccess(result: ESPlayerInterceptResult):void
播放拦截器成功事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
result | 拦截器结果 | ESPlayerInterceptResult | 是 |
onPlayerInterceptError
完整事件声明:onPlayerInterceptError(error: ESPlayerInterceptError):void
播放拦截器错误事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
error | 拦截器错误 | ESPlayerInterceptError | 是 |
onPlayerSizeChanged
完整事件声明:onPlayerSizeChanged(playerWidth: number, playerHeight: number):void
播放器尺寸变化事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
playerWidth | 播放器宽度 | number | 是 |
playerHeight | 播放器高度 | number | 是 |
onPlayerPreparing
完整事件声明:onPlayerPreparing():void
播放器准备中事件。
onPlayerPrepared
完整事件声明:onPlayerPrepared():void
播放器准备好事件。
onPlayerBufferStart
完整事件声明:onPlayerBufferStart():void
播放器开始缓冲事件。
onPlayerBufferEnd
完整事件声明:onPlayerBufferEnd():void
播放器缓冲结束事件。
onPlayerPlaying
完整事件声明:onPlayerPlaying():void
播放器开始播放事件。
onPlayerProgressChanged
完整事件声明:onPlayerProgressChanged(progress: number):void
播放进度事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
progress | 播放进度 | number | 是 |
onPlayerDurationChanged
完整事件声明:onPlayerDurationChanged(duration: number):void
播放总长度事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
duration | 视频播放总长度 | number | 是 |
onPlayerSeekStart
完整事件声明:onPlayerSeekStart():void
播放器开始快进事件。
onPlayerSeekCompleted
完整事件声明:onPlayerSeekCompleted():void
播放器快进结束事件。
onPlayerPaused
完整事件声明:onPlayerPaused():void
播放器暂停播放事件。
onPlayerResumed
完整事件声明:onPlayerResumed():void
播放器恢复播放事件。
onPlayerStopped
完整事件声明:onPlayerStopped():void
播放器停止播放事件。
onPlayerCompleted
完整事件声明:onPlayerCompleted():void
播放器播放完毕事件。
onPlayerError
完整事件声明:onPlayerError(error: ESPlayerError):void
播放错误事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
error | 播放错误 | ESPlayerError | 是 |
onPlayerInfo
完整事件声明:onPlayerInfo(info: ESPlayerInfo):void
播放信息事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
info | 播放信息 | ESPlayerInfo | 是 |
onPlayerNoMediaSourceCanPlay
完整事件声明:onPlayerNoMediaSourceCanPlay(next: boolean):void
无媒资资源可播放事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
next | 是否是向后播放顺序 | boolean | 是 |
onPlayerVolumeChanged
完整事件声明:onPlayerVolumeChanged(leftVolume: number, rightVolume: number):void
播放器音量变化事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
leftVolume | 左声道音量 | number | 是 |
rightVolume | 右声道音量 | number | 是 |
onPlayerLeftVolumeChanged
完整事件声明:onPlayerLeftVolumeChanged(volume: number):void
播放器左声道音量变化事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
volume | 左声道音量 | number | 是 |
onPlayerRightVolumeChanged
完整事件声明:onPlayerRightVolumeChanged(volume: number):void
播放器右声道音量变化事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
volume | 右声道音量 | number | 是 |
onPlayerDefinitionListChanged
完整事件声明:onPlayerDefinitionListChanged(definitionList: Array<ESPlayerDefinition>):void
播放器媒资清晰度列表事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
definitionList | 清晰度列表 | Array<ESPlayerDefinition> | 是 |
onPlayerDefinitionChanged
完整事件声明:onPlayerDefinitionChanged(definition: ESPlayerDefinition):void
播放器媒资清晰度事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
definition | 媒资当前清晰度 | ESPlayerDefinition | 是 |
onPlayerPlayRateListChanged
完整事件声明:onPlayerPlayRateListChanged(rateList: Array<ESPlayerRate>):void
播放速率列表事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
rateList | 播放速率列表 | Array<ESPlayerRate> | 是 |
onPlayerPlayRateChanged
完整事件声明:onPlayerPlayRateChanged(rate: ESPlayerRate):void
播放速率事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
rate | 播放速率 | ESPlayerRate | 是 |
onPlayerDecodeListChanged
完整事件声明:onPlayerDecodeListChanged(decodeList: Array<ESPlayerDecode>):void
播放器解码方式列表事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
decodeList | 解码方式列表 | Array<ESPlayerDecode> | 是 |
onPlayerDecodeChanged
完整事件声明:onPlayerDecodeChanged(decode: ESPlayerDecode):void
播放器解码方式事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
decode | 解码方式 | ESPlayerDecode | 是 |
onPlayerAspectRatioListChanged
完整事件声明:onPlayerAspectRatioListChanged(aspectRatioList: Array<ESPlayerAspectRatio>):void
画面比例列表事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
aspectRatioList | 画面比例列表 | Array<ESPlayerAspectRatio> | 是 |
onPlayerAspectRatioChanged
完整事件声明:onPlayerAspectRatioChanged(aspectRatio: ESPlayerAspectRatio):void
画面比例事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
aspectRatio | 画面比例 | ESPlayerAspectRatio | 是 |
onPlayerPlayMediaSourceListModeListChanged
完整事件声明:onPlayerPlayMediaSourceListModeListChanged(playModeList: Array<ESPlayerPlayMode>): void
播放媒资资源列表模式列表事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
playModeList | 播放媒资资源列表模式列表 | Array<ESPlayerPlayMode> | 是 |
onPlayerPlayMediaSourceListModeChanged
完整事件声明:onPlayerPlayMediaSourceListModeChanged(playMode: ESPlayerPlayMode): void
播放媒资资源列表模式事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
playMode | 播放媒资资源列表模式 | ESPlayerPlayMode | 是 |
onPlayerRenderListChanged
完整事件声明:onPlayerRenderListChanged(renderList: Array<ESPlayerRender>):void
渲染模式列表事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
renderList | 渲染模式列表 | Array<ESPlayerRender> | 是 |
onPlayerRenderChanged
完整事件声明:onPlayerRenderChanged(render: ESPlayerRender):void
渲染模式事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
render | 渲染模式 | ESPlayerRender | 是 |
onPlayerViewSizeChanged
完整事件声明:onPlayerViewSizeChanged(playerWidth: number, playerHeight: number):void
播放器尺寸变化事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
playerWidth | 播放器宽度 | number | 是 |
playerHeight | 播放器高度 | number | 是 |
onPlayerViewChanged
完整事件声明:onPlayerViewChanged():void
播放器视图变化事件。
onPlayerClickable
完整事件声明:onPlayerClickable(playerClickable: boolean): void
播放器视图可点击事件。
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
playerClickable | 是否可以点击 | boolean | 是 |
接口
initialize
该方法用于初始化播放管理器。
完整方法声明:function initialize(): void
参数
无返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
isInitialized
该方法用于判断播放管理器是否初始化。
完整方法声明:function isInitialized(): boolean
参数
无返回值:
返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 是否初始化。 | boolean | false |
setVisible
该方法用于设置播放管理器是否可见。
完整方法声明:function setVisible(value: boolean): void
- 参数:
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
value | 是否可见 | boolean | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
playMediaSourceList
该方法用于播放媒资资源列表。
完整方法声明:function playMediaSourceList(mediaSourceList: ESMediaSourceList): void
- 参数:
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
mediaSourceList | 媒资资源列表 | ESMediaSourceList | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
playMediaSourceByIndex
该方法用于根据媒资资源索引进行播放。
完整方法声明:function playMediaSourceByIndex(index: number): void
- 参数:
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
index | 媒资资源索引 | number | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
playMediaSourceById
该方法用于根据媒资资源唯一标识符进行播放。
完整方法声明:function playMediaSourceById(id: string): void
- 参数:
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
id | 媒资资源唯一标识符 | string | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
playMediaSource
该方法用于播放媒资资源。
完整方法声明:function playMediaSource(mediaSource: ESMediaSource): void
- 参数:
参数 | 描述 | 类型 | 非空 |
---|---|---|---|
mediaSource | 媒资资源 | ESMediaSource | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
playNextMediaSource
该方法用于播放下一个媒资资源。
完整方法声明:function playNextMediaSource(): void
参数:
无返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
playPreviousMediaSource
该方法用于播放上一个媒资资源。
完整方法声明:function playPreviousMediaSource(): void
参数:
无返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
getMediaSourceList
该方法用于获取正在播放的媒资资源列表。
完整方法声明:function getMediaSourceList(): Array<ESMediaSource> | null
参数:
无返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 媒资资源列表 | Array<ESMediaSource> | null |
getMediaSource
该方法用于根据媒资资源索引获取媒资资源。
完整方法声明:function getMediaSource(index: number): ESMediaSource | null
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
index | 媒资资源索引 | number | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 媒资资源列表 | ESMediaSource | null | null |
getPlayingMediaSourceIndex
该方法用于获取正在播放的媒资资源的索引。
完整方法声明:function getPlayingMediaSourceIndex(): number
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 媒资资源的索引 | number | -1 |
getPlayingMediaSourceList
该方法用于获取正在播放的媒资资源列表。
完整方法声明:function getPlayingMediaSourceList(): ESMediaSourceList | null
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 媒资资源列表 | ESMediaSourceList | null | null |
getPlayingMediaSource
该方法用于获取正在播放的媒资资源。
完整方法声明:function getPlayingMediaSource(): ESMediaSource | null
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 正在播放的媒资资源 | ESMediaSource | null | null |
play
该方法用于调用播放器的播放方法。
完整方法声明:function play(...params: Array<any>): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
params | 可变参数列表 | Array<any> | 否 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
start
该方法用于调用播放器的开始播放方法。
完整方法声明:function start(position: number): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
position | 媒资开始播放的位置 | number | 否 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
pause
该方法用于暂停播放器播放。
完整方法声明:function pause(): void
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
resume
该方法用于恢复播放器播放。
完整方法声明:function resume(): void
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
stop
该方法用于停止播放器播放。
完整方法声明:function stop(): void
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
reset
该方法用于重置播放器。
完整方法声明:function reset(): void
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
release
该方法用于回收播放器资源。
完整方法声明:function release(): void
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
seekTo
该方法用于播放快进。
完整方法声明:function seekTo(progress: number): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
progress | 媒资播放的进度 | number | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
getDuration
该方法用于获取播放总时长。
完整方法声明:function getDuration(): void
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
getCurrentPosition
该方法用于获取当前播放的进度。
完整方法声明:function getCurrentPosition(): void
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setSize
该方法用于设置播放器的尺寸。
完整方法声明:function setSize(width: number, height: number): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
width | 播放器的宽度 | number | 是 |
height | 播放器的高度 | number | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setPlayRate
该方法用于设置播放速率。
完整方法声明:function setPlayRate(playRate: ESPlayerRate): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
playRate | 播放速率 | ESPlayerRate | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setPlayMode
该方法用于设置播放模式。
完整方法声明:function setPlayMode(playMode: ESPlayerPlayMode): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
playMode | 播放模式 | ESPlayerPlayMode | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setDefinition
该方法用于设置播放媒资清晰度。
完整方法声明:function setDefinition(definition: ESPlayerDefinition): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
definition | 媒资清晰度 | ESPlayerDefinition | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setCache
该方法用于设置播放缓存策略。
完整方法声明:function setCache(cache: ESPlayerCache): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
cache | 缓存策略 | ESPlayerCache | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setDecode
该方法用于设置播放解码方式。
完整方法声明:function setDecode(decode: ESPlayerDecode): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
decode | 解码方式 | ESPlayerDecode | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setRender
该方法用于设置播放渲染方式。
完整方法声明:function setRender(render: ESPlayerRender): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
render | 渲染方式 | ESPlayerRender | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setAspectRatio
该方法用于设置播放画面比例。
完整方法声明:function setAspectRatio(aspectRatio: ESPlayerAspectRatio): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
aspectRatio | 画面比例 | ESPlayerAspectRatio | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
getLeftVolume
该方法用于获取左声道音量。
完整方法声明:function getLeftVolume(): void
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
getRightVolume
该方法用于获取右声道音量。
完整方法声明:function getRightVolume(): void
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setLeftVolume
该方法用于设置左声道音量。
完整方法声明:function setLeftVolume(leftVolume: number): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
leftVolume | 左声道音量 | number | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setRightVolume
该方法用于设置右声道音量。
完整方法声明:function setRightVolume(rightVolume: number): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
rightVolume | 右声道音量 | number | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setVolume
该方法用于设置右声道音量。
完整方法声明:function setVolume(volume: number): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
volume | 音量 | number | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
getVolume
该方法用于设置右声道音量。
完整方法声明:function getVolume(): void
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setStopped
该方法用于设置播放管理器的停止状态。
完整方法声明:function setStopped(stopped: boolean): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
stopped | 是否停止状态 | boolean | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setEnabled
该方法用于设置播放管理器的可用状态。
完整方法声明:function setEnabled(enabled: boolean): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
enabled | 是否可用状态 | boolean | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setProgressCallback
该方法用于设置播放进度回调。
完整方法声明:function setProgressCallback(callback: ESPlayerProgressCallback): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
callback | 进度回调 | ESPlayerProgressCallback | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
setDurationCallback
该方法用于设置播放总进度回调。
完整方法声明:function setDurationCallback(callback: ESPlayerDurationCallback): void
- 参数:
属性 | 描述 | 类型 | 非空 |
---|---|---|---|
callback | 总进度回调 | ESPlayerDurationCallback | 是 |
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |
invalidate
该方法用于刷新播放视图。
完整方法声明:function invalidate(): void
- 参数:
无
- 返回值:
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
无 | 无返回值 | void |