as

Settings
Sign out
Notifications
Alexa
亚马逊应用商店
Ring
AWS
文档
Support
Contact Us
My Cases
新手入门
设计和开发
应用发布
参考
支持
原生
Skip to main content
媒体控制客户端的接口

属性

play

play: (sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送播放请求。

参数

sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

pause

pause: (sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送暂停请求。

参数

sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

togglePlayPause

togglePlayPause: (sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送togglePlayPause请求。

参数

sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

stop

stop: (sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送停止请求。

参数

sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

startOver

startOver: (sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送startOver请求。

参数

sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

fastForward

fastForward: (sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送fastForward请求。

参数

sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

rewind

rewind: (sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送快退请求。

参数

sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

setPlaybackSpeed

setPlaybackSpeed: (speed: number, sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送setPlaybackSpeed请求。

参数

speed
number 设置的速度。
sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

skipForward

skipForward: (delta: ITimeValue, sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送skipForward请求。

参数

delta
ITimeValue 向前跳过的时间间隔。
sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

skipBackward

skipBackward: (delta: ITimeValue, sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送skipBackward请求。

参数

delta
ITimeValue 向后跳过的时间间隔。
sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

seek

seek: (position: ITimeValue, sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送搜索请求。

参数

position
ITimeValue 播放定位的时间位置。
sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

setAudioVolume

setAudioVolume: (volume: number, sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送设置音量请求。

参数

volume
number 设置的音量。
sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

setAudioTrack

setAudioTrack: (track: ITrack, sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送setAudioTrack请求。

参数

track
ITrack 设置的音轨。
sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

enableTextTrack

enableTextTrack: (track: ITrack, sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送enableTextTrack请求。

参数

track
ITrack 启用的音轨。
sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

disableTextTrack

disableTextTrack: (sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送disableTextTrack请求。

参数

sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

next

next: (sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送下一首请求。

参数

sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

previous

previous: (sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送上一首请求。

参数

sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

enableShuffle

enableShuffle: (enable: boolean, sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送enableShuffle请求。

参数

enable
boolean 当设置为true时随机播放启用;否则false。
sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

setRepeatMode

setRepeatMode: (mode: RepeatMode, sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送setRepeatMode请求。

参数

mode
RepeatMode 设置的模式。
sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

setRating

setRating: (id: MediaId, rating: number, sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送setRating请求。

参数

id
MediaId 媒体的ID。
rating
number 设置的评分。
sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

getMetadata

getMetadata: (id: MediaId) => Promise<IMediaMetadata>
向媒体控制终端节点发送getMetadata请求。

参数

id
MediaId 媒体的ID。

返回值

Promise<IMediaMetadata> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

sendCustomAction

sendCustomAction: (action: Action, sessionId?: IMediaSessionId) => Promise<void>
向媒体控制终端节点发送sendCustomAction请求。

参数

action
Action 发送的操作。
sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则目标会话由终端节点决定。

返回值

Promise<void> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

getSessionState

getSessionState: (sessionId?: IMediaSessionId) => Promise<MediaSessionState[]>
向媒体控制终端节点发送getSessionState请求。

参数

sessionId?
IMediaSessionId 可选。请求的目标会话ID。若未提供,则该请求将被视为针对所有可用会话。

返回值

Promise<MediaSessionState[]> 这是一个Promise,会在成功处理请求时正常完成;在请求失败时,则会返回一个错误并拒绝执行。

getEndpointPackageId

getEndpointPackageId: () => IPackageId
获取此终端节点的程序包ID。

返回值

IPackageId 程序包编号。

addListener

addListener: (listener: IMediaControlListener) => Promise<ISubscription>
订阅一个侦听器,以监控媒体会话状态的变化。

参数

listener
IMediaControlListener 要添加的侦听器。

返回值

Promise<ISubscription> 这是一个Promise,当成功完成时,会返回一个ISubscription对象。当不再需要侦听器时,此对象可用于取消订阅侦听器。

destroy

destroy: () => void
异步销毁媒体控制客户端。
最后修改于 2026年8月25日