as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support

IMediaControlHandlerAsync

When implemented, handles media control callbacks.

Properties

handleCustomAction()

handleCustomAction: (action, sessionId?) => Promise<void>

Handles a request for a custom action.

Parameters

action

Action

sessionId?

IMediaSessionId

Returns

Promise<void>


handleDisableTextTrack()

handleDisableTextTrack: (sessionId?) => Promise<void>

Handles a disable text track request initiated through a media control.

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>


handleEnableShuffle()

handleEnableShuffle: (enable, sessionId?) => Promise<void>

Handles an enable shuffle request initiated through a media control.

Parameters

enable

boolean

sessionId?

IMediaSessionId

Returns

Promise<void>


handleEnableTextTrack()

handleEnableTextTrack: (textTrack, sessionId?) => Promise<void>

Handles an enable text track request initiated through a media control.

Parameters

textTrack

ITrack

sessionId?

IMediaSessionId

Returns

Promise<void>


handleFastForward()

handleFastForward: (sessionId?) => Promise<void>

Handles a fast forward request initiated through a media control.

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>


handleGetMetadataInfo()

handleGetMetadataInfo: (id) => Promise<IMediaMetadata>

Handles a request for the metadata of the specified media item.

Parameters

id

MediaId

Returns

Promise<IMediaMetadata>


handleGetSessionState()

handleGetSessionState: (sessionId?) => Promise<MediaSessionState[]>

Handles a request for the session state.

Parameters

sessionId?

IMediaSessionId

Returns

Promise<MediaSessionState[]>


handleNext()

handleNext: (sessionId?) => Promise<void>

Handles a next request initiated through a media control.

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>


handlePause()

handlePause: (sessionId?, context?) => Promise<void>

Handles a pause request initiated through a media control.

Parameters

sessionId?

IMediaSessionId

context?

ICommandContext

Returns

Promise<void>


handlePlay()

handlePlay: (sessionId?) => Promise<void>

Handles a play request initiated through a media control.

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>


handlePrevious()

handlePrevious: (sessionId?) => Promise<void>

Handles a previous request initiated through a media control.

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>


handleRewind()

handleRewind: (sessionId?) => Promise<void>

Handles a rewind request initiated through a media control.

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>


handleSeek()

handleSeek: (position, sessionId?) => Promise<void>

Handles a seek request initiated through a media control.

Parameters

position

ITimeValue

sessionId?

IMediaSessionId

Returns

Promise<void>


handleSetAudioTrack()

handleSetAudioTrack: (audioTrack, sessionId?) => Promise<void>

Handles a set audio track request initiated through a media control.

Parameters

audioTrack

ITrack

sessionId?

IMediaSessionId

Returns

Promise<void>


handleSetAudioVolume()

handleSetAudioVolume: (volume, sessionId?) => Promise<void>

Handles a set audio volume request initiated through a media control.

Parameters

volume

number

sessionId?

IMediaSessionId

Returns

Promise<void>


handleSetPlaybackSpeed()

handleSetPlaybackSpeed: (speed, sessionId?) => Promise<void>

Handles a set playback speed request initiated through a media control.

Parameters

speed

number

sessionId?

IMediaSessionId

Returns

Promise<void>


handleSetRating()

handleSetRating: (id, rating, sessionId?) => Promise<void>

Handles a set rating request.

Parameters

id

MediaId

rating

number

sessionId?

IMediaSessionId

Returns

Promise<void>


handleSetRepeatMode()

handleSetRepeatMode: (mode, sessionId?) => Promise<void>

Handles a set repeat mode request initiated through a media control.

Parameters

mode

RepeatMode

sessionId?

IMediaSessionId

Returns

Promise<void>


handleSkipBackward()

handleSkipBackward: (delta, sessionId?) => Promise<void>

Handles a skip backward request initiated through a media control.

Parameters

delta

ITimeValue

sessionId?

IMediaSessionId

Returns

Promise<void>


handleSkipForward()

handleSkipForward: (delta, sessionId?) => Promise<void>

Handles a skip forward request initiated through a media control.

Parameters

delta

ITimeValue

sessionId?

IMediaSessionId

Returns

Promise<void>


handleStartOver()

handleStartOver: (sessionId?) => Promise<void>

Handles a start over request initiated through a media control.

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>


handleStop()

handleStop: (sessionId?) => Promise<void>

Handles a stop request initiated through a media control.

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>


handleTogglePlayPause()

handleTogglePlayPause: (sessionId?) => Promise<void>

Handles a toggle play pause request initiated through a media control.

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>


Last updated: Sep 30, 2025