IMediaControlClientAsync
interface for media control clients
Properties
play
play:
(sessionId?:IMediaSessionId) => Promise<void>
Sends a play request on the media control endpoint.
pause
pause:
(sessionId?:IMediaSessionId) => Promise<void>
Sends a pause requst on the media control endpoint.
togglePlayPause
togglePlayPause:
(sessionId?:IMediaSessionId) => Promise<void>
Sends a togglePlayPause request on the media control endpoint.
stop
stop:
(sessionId?:IMediaSessionId) => Promise<void>
Sends a stop request on the media control endpoint.
startOver
startOver:
(sessionId?:IMediaSessionId) => Promise<void>
Sends a startOver request on the media control endpoint.
fastForward
fastForward:
(sessionId?:IMediaSessionId) => Promise<void>
Sends a fastForward request on the media control endpoint.
rewind
rewind:
(sessionId?:IMediaSessionId) => Promise<void>
Sends a rewind request on the media control endpoint.
setPlaybackSpeed
setPlaybackSpeed:
(speed: number, sessionId?:IMediaSessionId) => Promise<void>
Sends a setPlaybackSpeed request on the media control endpoint.
skipForward
skipForward:
(delta:ITimeValue, sessionId?:IMediaSessionId) => Promise<void>
Sends a skipForward request on the media control endpoint.
skipBackward
skipBackward:
(delta:ITimeValue, sessionId?:IMediaSessionId) => Promise<void>
Sends a skipBackward request on the media control endpoint.
seek
seek:
(position:ITimeValue, sessionId?:IMediaSessionId) => Promise<void>
Sends a seek request on the media control endpoint.
setAudioVolume
setAudioVolume:
(volume: number, sessionId?:IMediaSessionId) => Promise<void>
Sends a set audio volume request on the media control endpoint.
setAudioTrack
setAudioTrack:
(track:ITrack, sessionId?:IMediaSessionId) => Promise<void>
Sends a setAudioTrack requst on the media control endpoint.
enableTextTrack
enableTextTrack:
(track:ITrack, sessionId?:IMediaSessionId) => Promise<void>
Sends a enableTextTrack request on the media control endpoint.
disableTextTrack
disableTextTrack:
(sessionId?:IMediaSessionId) => Promise<void>
Sends a disableTextTrack request on the media control endpoint.
next
next:
(sessionId?:IMediaSessionId) => Promise<void>
Sends a next request on the media control endpoint.
previous
previous:
(sessionId?:IMediaSessionId) => Promise<void>
Sends a previous request on the media control endpoint.
enableShuffle
enableShuffle:
(enable: boolean, sessionId?:IMediaSessionId) => Promise<void>
Sends a enableShuffle request on the media control endpoint.
setRepeatMode
setRepeatMode:
(mode:RepeatMode, sessionId?:IMediaSessionId) => Promise<void>
Sends a setRepeatMode request on the media control endpoint.
setRating
setRating:
(id: MediaId, rating: number, sessionId?:IMediaSessionId) => Promise<void>
Sends a setRating request on the media control endpoint.
getMetadata
getMetadata:
(id: MediaId) => Promise<IMediaMetadata>
Sends a getMetadata request on the media control endpoint.
sendCustomAction
sendCustomAction:
(action:Action, sessionId?:IMediaSessionId) => Promise<void>
Sends a sendCustomAction request on the media control endpoint.
getSessionState
getSessionState:
(sessionId?:IMediaSessionId) => Promise<MediaSessionState[]>
Sends a getSessionState request on the media control endpoint.
getEndpointPackageId
getEndpointPackageId:
() =>IPackageId
Gets the package ID of this endpoint.
addListener
addListener:
(listener:IMediaControlListener) => Promise<ISubscription>
Subscribes a listener to monitor changes in the media session state.
destroy
destroy:
() => void
Destroys the media control client asynchronously.
Last updated: Jul 22, 2026
