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