as

Settings
Sign out
Notifications
Alexa
亚马逊应用商店
Ring
AWS
文档
Support
Contact Us
My Cases
新手入门
设计和开发
应用发布
参考
支持

IPlayerClient

IPlayerClient

一个接口,用于代表一个PlayerClient。

属性

load

load: (mediaInfo: IPlayerSessionMediaInfo, loadParams?: IPlayerSessionLoadParams, sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer发送请求,以使用给定URL加载内容。


unload

unload: (sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer中的媒体会话发送请求,以卸载媒体内容。例如,要同步卸载媒体内容,如果应用转入后台状态,请调用。


unloadSync

unloadSync: (timeoutMsec: number, sessionId?: IPlayerSessionId) => IUnloadSyncStatus

向PlayerServer中的媒体会话发送请求,以同步卸载媒体内容。当应用转入后台状态时,使用此API释放媒体资源。

2.2.0


setVideoView

setVideoView: (viewHandle: IViewHandle, sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer中的媒体会话发送请求,以使用加载的内容设置KeplerVideoSurfaceView。

只有在调用某个加载API并成功加载媒体内容后,再调用setVideoView。


clearVideoView

clearVideoView: (sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer中的媒体会话发送请求,以清除渲染视频内容的KeplerVideoSurfaceView。


setTextView

setTextView: (viewHandle: IViewHandle, sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer中的媒体会话发送请求,以使用加载的内容设置KeplerCaptionsView。

只有在调用某个加载API并成功加载媒体内容后,再调用setTextView。


clearTextView

clearTextView: (sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer中的媒体会话发送请求,以清除渲染字幕内容的KeplerCaptionsView。


play

play: (sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer发送请求以开始或恢复播放。

媒体会话应更新其以反映新的播放状态。Kepler播放器服务器可能会将播放速度重置为正常速度。


pause

pause: (sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer发送请求以暂停播放。

媒体会话应更新其以反映新的播放状态。


seek

seek: (position: number, isRelative?: boolean, sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer发送请求以跳转至给定的播放位置(以秒为单位)。

媒体会话应更新其以反映新的播放位置。


setMute

setMute: (isMuted: boolean, sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer发送请求以将播放设为静音或取消静音。

媒体会话应更新其以反映新的播放状态。


setPlaybackRate

setPlaybackRate: (playbackRate: number, sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer发送请求以设置媒体播放的播放速率。

媒体会话应更新其以反映新的播放状态。


setVolume

setVolume: (volume: number, sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer发送请求以设置媒体播放的音量。

媒体会话应更新其以反映新的播放状态。


setActiveTrack

setActiveTrack: (trackType: ITrackType, trackId: string, sessionId?: IPlayerSessionId) => Promise<void>

向PlayerServer发送请求以设置媒体播放的活动轨道。

媒体会话应更新其以反映新的播放状态。


setMediaControlFocus

setMediaControlFocus: (componentInstance: IComponentInstance, mediaControlHandler?: PlayerClientMediaControlHandler) => Promise<void>

注册PlayerClientMediaControlHandler实例

自版本2.1.0起可用。


getCurrentPosition

getCurrentPosition: (sessionId?: IPlayerSessionId) => Promise<number>

向PlayerServer发送请求以获取媒体播放的当前播放位置(以秒为单位)。

媒体会话应更新其以反映新的播放状态。


registerBufferedRangesListener

registerBufferedRangesListener: (listener: IPlayerSessionBufferedRangesListener, sessionId?: IPlayerSessionId) => Promise<ISubscription>

订阅一个侦听器,以监控缓冲范围的变化。


registerStatusListener

registerStatusListener: (listener: IPlayerSessionStatusListener, sessionId?: IPlayerSessionId) => Promise<ISubscription>

订阅一个侦听器,以监控播放器会话状态的变化。


registerPositionListener

registerPositionListener: (listener: IPlayerSessionPositionListener, interval: number, sessionId?: IPlayerSessionId) => Promise<ISubscription>

订阅一个侦听器,以监控播放位置的更新。播放位置将以秒为单位。


registerTrackListener

registerTrackListener: (listener: IPlayerSessionTrackListener, sessionId?: IPlayerSessionId) => Promise<ISubscription>

订阅一个侦听器,以监控轨道信息的变化。


registerMessageListener

registerMessageListener: (listener: IPlayerSessionMessageListener, sessionId?: IPlayerSessionId) => Promise<ISubscription>

订阅一个侦听器,以接收来自服务组件的消息。


registerErrorListener

registerErrorListener: (listener: IPlayerSessionErrorListener, sessionId?: IPlayerSessionId) => Promise<ISubscription>

订阅一个侦听器,以接收来自服务组件的错误。


sendMessage

sendMessage: (message: any, sessionId?: IPlayerSessionId) => Promise<void>

为交互式组件提供一种向服务组件发送自定义消息的方法。所有JSON类型都能作为消息发送(undefined除外)。


destroy

destroy: () => void

销毁Kepler播放器客户端实例并停止Kepler播放器服务。当交互式组件销毁时,客户端应该调用此API来清理媒体资源。


Last updated: 2026年7月22日