KeplerMediaControlHandler
Extends
Implements
IMediaControlHandlerAsync
Constructors
new KeplerMediaControlHandler()
new KeplerMediaControlHandler():
KeplerMediaControlHandler
Returns
Inherited from
MediaControlHandler.constructor
Properties
mediaPlayer
mediaPlayer:
MediaPlayer
Inherited from
MediaControlHandler.mediaPlayer
Methods
handleCustomAction()
handleCustomAction(
action,sessionId?):Promise<void>
Parameters
action
Action
sessionId?
IMediaSessionId
Returns
Promise<void>
Brief
Callback from KMC server to execute the media control command "customAction" for current mediaplayer instance. This is NOP for w3cmedia playback handling as this is playlist management feature. App clients are requested to choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleCustomAction
Overrides
MediaControlHandler.handleCustomAction
handleDisableTextTrack()
handleDisableTextTrack(
sessionId?):Promise<void>
Parameters
sessionId?
IMediaSessionId
Returns
Promise<void>
Brief
Callback from KMC server to execute the media control command "disableTextTrack" for current mediaplayer instance. w3cmedia will handle this internally by initiating disableTextTrack command as a default mode. alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly. Note: Currently this is NOP in default mode and handling will be available in future releases.
Implementation of
IMediaControlHandlerAsync.handleDisableTextTrack
Overrides
MediaControlHandler.handleDisableTextTrack
handleEnableShuffle()
handleEnableShuffle(
enable,sessionId?):Promise<void>
Parameters
enable
boolean
sessionId?
IMediaSessionId
Returns
Promise<void>
Brief
Callback from KMC server to execute the media control command "shuffle" for current mediaplayer instance. This is NOP for w3cmedia playback handling as this is playlist management feature. App clients are requested to choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleEnableShuffle
Overrides
MediaControlHandler.handleEnableShuffle
handleEnableTextTrack()
handleEnableTextTrack(
textTrack,sessionId?):Promise<void>
Parameters
textTrack
ITrack
sessionId?
IMediaSessionId
Returns
Promise<void>
Brief
Callback from KMC server to execute the media control command "enableTextTrack" for current mediaplayer instance. w3cmedia will handle this internally by initiating enableTextTrack command as a default mode. alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly. Note: Currently this is NOP in default mode and handling will be available in future releases.
Implementation of
IMediaControlHandlerAsync.handleEnableTextTrack
Overrides
MediaControlHandler.handleEnableTextTrack
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. alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleFastForward
Overrides
MediaControlHandler.handleFastForward
handleGetMetadataInfo()
handleGetMetadataInfo(
id):Promise<IMediaMetadata>
Parameters
id
MediaId
Returns
Promise<IMediaMetadata>
Brief
Callback from KMC server to execute the media control command "getMetaInfo" for current mediaplayer instance. This is NOP for w3cmedia playback handling as this is playlist management feature. App clients are requested to choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleGetMetadataInfo
Overrides
MediaControlHandler.handleGetMetadataInfo
handleGetSessionState()
handleGetSessionState(
sessionId?):Promise<MediaSessionState[]>
Parameters
sessionId?
IMediaSessionId
Returns
Promise<MediaSessionState[]>
Brief
Callback from KMC server to execute the media control command "getSessionState" for current mediaplayer instance. w3cmedia will handle this internally by updating the sessionstate as a default. alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleGetSessionState
Overrides
MediaControlHandler.handleGetSessionState
handleNext()
handleNext(
sessionId?):Promise<void>
Parameters
sessionId?
IMediaSessionId
Returns
Promise<void>
Brief
Callback from KMC server to execute the media control command "next" for current mediaplayer instance. This is NOP for w3cmedia playback handling as this is playlist management feature. App clients are requested to choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleNext
Overrides
MediaControlHandler.handleNext
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, alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handlePause
Overrides
MediaControlHandler.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, alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handlePlay
Overrides
MediaControlHandler.handlePlay
handlePrevious()
handlePrevious():
Promise<void>
Returns
Promise<void>
Brief
Callback from KMC server to execute the media control command "previous" for current mediaplayer instance. This is NOP for w3cmedia playback handling as this is playlist management feature. App clients are requested to choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handlePrevious
Overrides
MediaControlHandler.handlePrevious
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. alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleRewind
Overrides
MediaControlHandler.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. alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleSeek
Overrides
MediaControlHandler.handleSeek
handleSetAudioTrack()
handleSetAudioTrack(
audioTrack,sessionId?):Promise<void>
Parameters
audioTrack
ITrack
sessionId?
IMediaSessionId
Returns
Promise<void>
Brief
Callback from KMC server to execute the media control command "setAudioTrack" for current mediaplayer instance. w3cmedia will handle this internally by initiating setaudiotrack command as a default mode. alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly. Note: Currently this is NOP in default mode and handling will be available in future releases.
Implementation of
IMediaControlHandlerAsync.handleSetAudioTrack
Overrides
MediaControlHandler.handleSetAudioTrack
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. alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleSetAudioVolume
Overrides
MediaControlHandler.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. alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleSetPlaybackSpeed
Overrides
MediaControlHandler.handleSetPlaybackSpeed
handleSetRating()
handleSetRating(
id,rating,sessionId?):Promise<void>
Parameters
id
MediaId
rating
number
sessionId?
IMediaSessionId
Returns
Promise<void>
Brief
Callback from KMC server to execute the media control command "setRating" for current mediaplayer instance. This is NOP for w3cmedia playback handling as this is playlist management feature. App clients are requested to choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleSetRating
Overrides
MediaControlHandler.handleSetRating
handleSetRepeatMode()
handleSetRepeatMode(
mode,sessionId?):Promise<void>
Parameters
mode
RepeatMode
sessionId?
IMediaSessionId
Returns
Promise<void>
Brief
Callback from KMC server to execute the media control command "repeate" for current mediaplayer instance. This is NOP for w3cmedia playback handling as this is playlist management feature. App clients are requested to choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleSetRepeatMode
Overrides
MediaControlHandler.handleSetRepeatMode
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. alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleSkipBackward
Overrides
MediaControlHandler.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. alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleSkipForward
Overrides
MediaControlHandler.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, alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleStartOver
Overrides
MediaControlHandler.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, alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleStop
Overrides
MediaControlHandler.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, alternatively App client can choose to override the callback function using OverrideMediaControlHandler and implement accordingly.
Implementation of
IMediaControlHandlerAsync.handleTogglePlayPause
Overrides
MediaControlHandler.handleTogglePlayPause
Last updated: Sep 30, 2025
