kotlin-browser/web.mediasession/MediaSession

MediaSession

The MediaSession interface of the Media Session API allows a web page to provide custom behaviors for standard media playback interactions, and to report metadata that can be sent by the user agent to the device or operating system for presentation in standardized user interface elements.

MDN Reference

Properties

metadata

var metadata: MediaMetadata?

The metadata property of the MediaSession interface contains a MediaMetadata object providing descriptive information about the currently playing media, or null if the metadata has not been set.

playbackState

var playbackState: MediaSessionPlaybackState

The playbackState property of the playing or paused.

Functions

setActionHandler

fun setActionHandler(action: MediaSessionAction, handler: MediaSessionActionHandler?)

The setActionHandler() method of the MediaSession interface sets a handler for a media session action.

setCameraActive

suspend fun setCameraActive(active: Boolean)

The setCameraActive() method of the MediaSession interface is used to indicate to the user agent whether the user's camera is considered to be active.

setCameraActiveAsync

fun setCameraActiveAsync(active: Boolean): Promise<Void>

setMicrophoneActive

suspend fun setMicrophoneActive(active: Boolean)

The setMicrophoneActive() method of the MediaSession interface is used to indicate to the user agent whether the user's microphone is considered to be currently muted.

setMicrophoneActiveAsync

fun setMicrophoneActiveAsync(active: Boolean): Promise<Void>

setPositionState

fun setPositionState(state: MediaPositionState = definedExternally)

The setPositionState() method of the document's media playback position and speed for presentation by user's device in any kind of interface that provides details about ongoing media.