Interface MediaControlConfiguration

Describes the configuration of media controls and media sessions across platforms.

For Android, this applies to the Media Session functionality, providing the platform with a uniform way of interacting with the player, and the Notification to display information on the media currently playing.

For Web, this applies to the Media Session API for customizing media notifications and access to platform media keys.

For iOS, this applies to the Now Playing functionality for setting information on the media that is currently playing, and the Remote Command Center responds to remote control events sent by external accessories and system controls.

interface MediaControlConfiguration {
    convertSkipToSeek?: boolean;
    mediaSessionEnabled?: boolean;
    skipBackwardInterval?: number;
    skipForwardInterval?: number;
}

Properties

convertSkipToSeek?: boolean

A flag that allows next/previous track commands to be interpreted as skip forward/backward commands, according to the configured skip intervals.

Default Value

false

Remarks


- This property only applies to iOS and Android.

mediaSessionEnabled?: boolean

Whether the media session feature is enabled.

Default Value

true

Remarks


- This property only applies to Web and Android.

skipBackwardInterval?: number

The amount of seconds the player will skip backward.

Default Value

5 on Web and android, 15 on iOS.
skipForwardInterval?: number

The amount of seconds the player will skip forward.

Default Value

5 on Web and android, 15 on iOS.