as

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

PlayerClientMediaControlHandler

Implements

  • IMediaControlHandlerAsync

Constructors

new PlayerClientMediaControlHandler()

new PlayerClientMediaControlHandler(): PlayerClientMediaControlHandler

Returns

PlayerClientMediaControlHandler

Methods

handleFastForward()

handleFastForward(sessionId?): Promise<void>

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "fastforward" for current mediaplayer instance. w3cmedia will handle this internally by seek forward command to pipeline as a default mode.

Implementation of

IMediaControlHandlerAsync.handleFastForward


handlePause()

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

Parameters

sessionId?

IMediaSessionId

context?

ICommandContext

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "pause" for current mediaplayer instance. w3cmedia will handle this internally by initiating pause command to pipeline as a default mode.

Implementation of

IMediaControlHandlerAsync.handlePause


handlePlay()

handlePlay(sessionId?): Promise<void>

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "play" for current mediaplayer instance. w3cmedia will handle this internally by initiating play command to pipeline as a default mode.

Implementation of

IMediaControlHandlerAsync.handlePlay


handleRewind()

handleRewind(sessionId?): Promise<void>

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "rewind" for current mediaplayer instance. w3cmedia will handle this internally by seek backward command to pipeline as a default mode.

Implementation of

IMediaControlHandlerAsync.handleRewind


handleSeek()

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

Parameters

position

ITimeValue

sessionId?

IMediaSessionId

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "seek" for current mediaplayer instance. w3cmedia will handle this internally by seek forward/backward command to pipeline as a default mode.

Implementation of

IMediaControlHandlerAsync.handleSeek


handleSetAudioVolume()

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

Parameters

volume

number

sessionId?

IMediaSessionId

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "setVolume" for current mediaplayer instance. w3cmedia will handle this internally by initiating setvolume command as a default mode.

Implementation of

IMediaControlHandlerAsync.handleSetAudioVolume


handleSetPlaybackSpeed()

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

Parameters

speed

number

sessionId?

IMediaSessionId

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "setplaybackspeed" for current mediaplayer instance. w3cmedia will handle this internally by configure the playbackspeed command to pipeline as a default mode.

Implementation of

IMediaControlHandlerAsync.handleSetPlaybackSpeed


handleSkipBackward()

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

Parameters

delta

ITimeValue

sessionId?

IMediaSessionId

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "skipbackward" for current mediaplayer instance. w3cmedia will handle this internally by seek command with delta position to pipeline as a default mode.

Implementation of

IMediaControlHandlerAsync.handleSkipBackward


handleSkipForward()

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

Parameters

delta

ITimeValue

sessionId?

IMediaSessionId

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "skipforward" for current mediaplayer instance. w3cmedia will handle this internally by seek command with delta position to pipeline as a default mode.

Implementation of

IMediaControlHandlerAsync.handleSkipForward


handleStartOver()

handleStartOver(sessionId?): Promise<void>

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "startover" for current mediaplayer instance. w3cmedia will handle this internally by seek to start position and initiate the play command to pipeline as a default mode.

Implementation of

IMediaControlHandlerAsync.handleStartOver


handleStop()

handleStop(sessionId?): Promise<void>

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "stop" for current mediaplayer instance. w3cmedia will handle this internally by initiating pause command to pipeline as a default mode.

Implementation of

IMediaControlHandlerAsync.handleStop


handleTogglePlayPause()

handleTogglePlayPause(sessionId?): Promise<void>

Parameters

sessionId?

IMediaSessionId

Returns

Promise<void>

Brief

Callback from KMC server to execute the media control command "toggleplaypause" for current mediaplayer instance. w3cmedia will handle this internally by initiating play/pause based on current state of pipeline as a default mode.

Implementation of

IMediaControlHandlerAsync.handleTogglePlayPause


setPlayerClient()

setPlayerClient(playerClient): void

Parameters

playerClient

IPlayerClient

Returns

void

Brief

Sets player client instance for media control handling.


Last updated: Sep 30, 2025