Class MediaControlsApi

constructor

• new MediaControlsApi(playerId: string): MediaControlsApi

  Parameters

  • playerId: string

  Returns MediaControlsApi

ReadonlynativeId

isEnabled

• isEnabled(): Promise<boolean>

  Indicates whether the Player publishes media control information and registers media command handlers.

  The initial value is configured via MediaControlConfig.isEnabled. Disabling this integration clears the Player's media controls metadata and removes the Player's command handlers.

  Limitations

  • Google IMA SDK instances that were already created can still publish their own media control information.
  • This API only controls the Bitmovin Player media controls integration. It does not manage media controls, sessions, command handlers, or metadata created directly by the app or by other libraries.

  Returns Promise<boolean>

  true if the media controls integration is enabled, false otherwise. Always false on Android.

  Platform

  iOS, tvOS

setEnabled

• setEnabled(enabled: boolean): Promise<void>

  Enables or disables the Player's media controls integration at runtime.

  Parameters

  • enabled: boolean

    Whether the media controls integration should be enabled.

  Returns Promise<void>

  Platform

  iOS, tvOS