Error对象拒绝该Promise。如有可能,应使用IPlayerSessionError发送从媒体播放器收到的错误代码和消息
属性
setHandler
setHandler:为处理与给定组件ID关联的Kepler播放器操作请求,分配处理程序。 分配处理程序对于处理Kepler播放器请求和实现自定义Kepler播放器逻辑至关重要。此调用允许每个组件有一个处理程序。活动处理程序指上次调用setHandler时所设置的处理程序。(handler:IPlayerServerHandler, componentId: string) => void
参数
handler
IPlayerServerHandlercomponentId
string
示例
updateBufferedRanges
updateBufferedRanges:通知相关客户端有关Kepler播放器缓冲范围的信息。 更新服务器会话的播放缓冲范围对于反映媒体播放状态的变化、当前选定媒体及其他相关信息至关重要。(bufferedRanges: Array<ITimeRange>, sessionId?:IPlayerSessionId) => Promise<void>
参数
bufferedRanges
ITimeRange[]
sessionId?
IPlayerSessionId返回值
Promise<void>
在更新完成时进行解析的Promise。
updateStatus
updateStatus:通知相关客户端有关Kepler播放器会话状态更新的信息。 更新Kepler播放器服务器会话状态对于反映媒体播放状态的变化、当前选定媒体及其他相关信息至关重要。例如,应用将在(status: Array<IPlayerSessionStatus>) => Promise<void>
AudioPlayer或VideoPlayer(https://html.spec.whatwg.org/#event-handlers-on-elements,-document-objects,-and-window-objects,仅提供英文版)上注册媒体相关EventListener,然后更新对应的`IPlayerSessionStatus`参数并调用updateStatus。在适用情况下,Kepler播放器服务器在处理通过已安装`IPlayerServerHandler`实例接收到的Kepler播放器请求时,应发布会话状态更新。
参数
status
IPlayerSessionStatus[]
返回值
Promise<void>
在更新完成时进行解析的Promise。
示例
addTrack
addTrack:通知相关客户端有关Kepler播放器新轨道的信息。{Audio,Video}Player必须先在AudioTrackList | VideoTrackList | TextTrackList中注册为”addtrack” EventListener,然后才能调用此API。 更新服务器会话的新轨道对于反映媒体播放状态的变化、当前选定媒体及其他相关信息至关重要。应用可在HtmlMediaElement.{audioTracks,videoTracks,textTracks}属性上注册为”addtrack” EventListener,然后调用(newTrack:ITrackInfo, sessionId?:IPlayerSessionId) => Promise<void>
IPlayerServer.addTrack(如果触发该事件)。
例如:
参数
newTrack
ITrackInfosessionId?
IPlayerSessionId返回值
Promise<void>
在更新完成时进行解析的Promise。
removeTrack
removeTrack:通知相关客户端有关Kepler播放器已移除的现有轨道的信息。{Audio,Video}Player必须先在AudioTrackList | VideoTrackList | TextTrackList中注册为”removetrack” EventListener,然后才能调用此API。 更新服务器会话的已移除轨道对于反映媒体播放状态的变化、当前选定媒体及其他相关信息至关重要。应用可在HtmlMediaElement.{audioTracks,videoTracks,textTracks}属性上注册为”removetrack” EventListener,然后调用(removedTrack:ITrackInfo, sessionId?:IPlayerSessionId) => Promise<void>
IPlayerServer.removeTrack(如果触发该事件)。
例如:
参数
removedTrack
ITrackInfosessionId?
IPlayerSessionId返回值
Promise<void>
在更新完成时进行解析的Promise。
sendMessage
sendMessage:提供向交互组件发送自定义消息的方式。所有JSON类型都能作为消息发送((message: any, sessionId?:IPlayerSessionId) => Promise<void>
undefined除外)。
这在提供自定义消息方面尤为有用,客户端可利用这些消息更新用户界面。
参数
消息
any
sessionId?
IPlayerSessionId返回值
Promise<void>
这是一个Promise,会在消息发送时正常完成;在请求失败或未定义message时,则会返回一个错误并拒绝执行。
示例
sendError
sendError:提供将错误从服务组件发送到交互组件的途径。 应用可在HtmlMediaElement实例上注册为”error” EventListener,然后调用(error:IPlayerSessionError, sessionId?:IPlayerSessionId) => Promise<void>
IPlayerServer.addTrack(如果触发该事件)。
参数
error
IPlayerSessionErrorsessionId?
IPlayerSessionId返回值
Promise<void>
在错误发生时进行解析的Promise。

