Media Session Connector/com.theoplayer.android.connector.mediasession/MediaSessionConnector

MediaSessionConnector

class MediaSessionConnector(val mediaSession: MediaSessionCompat)

MediaSessionConnector connects an Android media session to a THEOplayer instance.

// Create and initialize the media session
mediaSession = MediaSessionCompat(this, TAG).apply {
    // Do not let MediaButtons restart the player when the app is not visible
    setMediaButtonReceiver(null)
}

// Create a MediaSessionConnector and attach the THEOplayer instance.
mediaSessionConnector = MediaSessionConnector(mediaSession)
mediaSessionConnector.player = player

// Optionally show debug logs
mediaSessionConnector.debug = true

// Set mediaSession to active
mediaSessionConnector.setActive(true)

See also

Constructors

MediaSessionConnector

constructor(mediaSession: MediaSessionCompat)

Properties

customActionProviders

var customActionProviders: Array<CustomActionProvider>

var debug: Boolean

enabledPlaybackActions

var enabledPlaybackActions: Long

val listeners: MutableList<MediaSessionListener>

val mediaSession: MediaSessionCompat

playbackPreparer

var playbackPreparer: PlaybackPreparer?

var player: Player?

var queueEditor: QueueEditor?

var queueNavigator: QueueNavigator?

var ratingCallback: RatingCallback?

shouldDispatchTimeUpdateEvents

var shouldDispatchTimeUpdateEvents: Boolean

Whether each time update event should trigger an update in playback state.

shouldDispatchUnsupportedActions

var shouldDispatchUnsupportedActions: Boolean

skipBackwardsInterval

var skipBackwardsInterval: Double

The interval the player should skip backward when rewinding, in seconds.

skipForwardInterval

var skipForwardInterval: Double

The interval the player should skip forward when fast-forwarding, in seconds.

Functions

fun addListener(listener: MediaSessionListener)

Add a listener for media session callback actions.

Release mediaSession.

getMediaSessionMetadata

fun getMediaSessionMetadata(): MediaMetadataCompat

Get metadata for the current media item.

getMediaSessionMetadataProvider

fun getMediaSessionMetadataProvider(): MediaMetadataProvider

Get metadata provider for the current media item.

invalidateMediaSessionMetadata

fun invalidateMediaSessionMetadata()

Force update of the current meta data.

invalidatePlaybackState

fun invalidatePlaybackState()

Force update of current playback state.

fun removeListener(listener: MediaSessionListener)

Remove a listener for media session callback actions.

fun setActive(active: Boolean)

Set mediaSession active flag.

setMediaSessionMetadata

fun setMediaSessionMetadata(sourceDescription: SourceDescription?)

Pass a custom description for the current media item.