MediaControlClientAsync
Class representing a client for a media control endpoint. This class is used to interact with the media control endpoint and perform various actions such as play, pause, seek, and more.
Implements
Constructors
new MediaControlClientAsync()
new MediaControlClientAsync(
client):MediaControlClientAsync
Parameters
client
Returns
Properties
client
readonlyclient:NativeClient
emptySession
readonlyemptySession:IMediaSessionId
Methods
addListener()
addListener(
listener):Promise<ISubscription>
Subscribes a listener to monitor changes in the media session state.
Parameters
listener
Returns
Promise<ISubscription>
Implementation of
IMediaControlClientAsync.addListener
destroy()
destroy():
void
Destroys the media control client asynchronously.
Returns
void
Implementation of
IMediaControlClientAsync.destroy
disableTextTrack()
disableTextTrack(
session?):Promise<void>
Sends a disableTextTrack request on the media control endpoint.
Parameters
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.disableTextTrack
enableShuffle()
enableShuffle(
enable,session?):Promise<void>
Sends a enableShuffle request on the media control endpoint.
Parameters
enable
boolean
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.enableShuffle
enableTextTrack()
enableTextTrack(
textTrack,session?):Promise<void>
Sends a enableTextTrack request on the media control endpoint.
Parameters
textTrack
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.enableTextTrack
fastForward()
fastForward(
session?):Promise<void>
Sends a fastForward request on the media control endpoint.
Parameters
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.fastForward
getEndpointPackageId()
getEndpointPackageId():
IPackageId
Gets the package ID of this endpoint.
Returns
Implementation of
IMediaControlClientAsync.getEndpointPackageId
getMetadata()
getMetadata(
id):Promise<IMediaMetadata>
Sends a getMetadata request on the media control endpoint.
Parameters
id
MediaId
Returns
Promise<IMediaMetadata>
Implementation of
IMediaControlClientAsync.getMetadata
getSessionState()
getSessionState(
session?):Promise<MediaSessionState[]>
Sends a getSessionState request on the media control endpoint.
Parameters
session?
Returns
Promise<MediaSessionState[]>
Implementation of
IMediaControlClientAsync.getSessionState
next()
next(
session?):Promise<void>
Sends a next request on the media control endpoint.
Parameters
session?
Returns
Promise<void>
Implementation of
pause()
pause(
session?):Promise<void>
Sends a pause requst on the media control endpoint.
Parameters
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.pause
play()
play(
session?):Promise<void>
Sends a play request on the media control endpoint.
Parameters
session?
Returns
Promise<void>
Implementation of
previous()
previous(
session?):Promise<void>
Sends a previous request on the media control endpoint.
Parameters
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.previous
rewind()
rewind(
session?):Promise<void>
Sends a rewind request on the media control endpoint.
Parameters
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.rewind
seek()
seek(
position,session?):Promise<void>
Sends a seek request on the media control endpoint.
Parameters
position
session?
Returns
Promise<void>
Implementation of
sendCustomAction()
sendCustomAction(
action,session?):Promise<void>
Sends a sendCustomAction request on the media control endpoint.
Parameters
action
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.sendCustomAction
setAudioTrack()
setAudioTrack(
audioTrack,session?):Promise<void>
Sends a setAudioTrack requst on the media control endpoint.
Parameters
audioTrack
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.setAudioTrack
setAudioVolume()
setAudioVolume(
volume,session?):Promise<void>
Sends a set audio volume request on the media control endpoint.
Parameters
volume
number
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.setAudioVolume
setPlaybackSpeed()
setPlaybackSpeed(
speed,session?):Promise<void>
Sends a setPlaybackSpeed request on the media control endpoint.
Parameters
speed
number
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.setPlaybackSpeed
setRating()
setRating(
id,rating,session?):Promise<void>
Sends a setRating request on the media control endpoint.
Parameters
id
MediaId
rating
number
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.setRating
setRepeatMode()
setRepeatMode(
mode,session?):Promise<void>
Sends a setRepeatMode request on the media control endpoint.
Parameters
mode
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.setRepeatMode
skipBackward()
skipBackward(
delta,session?):Promise<void>
Sends a skipBackward request on the media control endpoint.
Parameters
delta
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.skipBackward
skipForward()
skipForward(
delta,session?):Promise<void>
Sends a skipForward request on the media control endpoint.
Parameters
delta
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.skipForward
startOver()
startOver(
session?):Promise<void>
Sends a startOver request on the media control endpoint.
Parameters
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.startOver
stop()
stop(
session?):Promise<void>
Sends a stop request on the media control endpoint.
Parameters
session?
Returns
Promise<void>
Implementation of
togglePlayPause()
togglePlayPause(
session?):Promise<void>
Sends a togglePlayPause request on the media control endpoint.
Parameters
session?
Returns
Promise<void>
Implementation of
IMediaControlClientAsync.togglePlayPause
Last updated: Sep 30, 2025
