Package org.mozilla.geckoview

Class MediaSession

Object

org.mozilla.geckoview.MediaSession

@UiThread
public class MediaSession
extends Object

The MediaSession API provides media controls and events for a GeckoSession. This includes support for the DOM Media Session API and regular HTML media content.

See Also:

• Media Session API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MediaSession.Delegate	Implement this delegate to receive media session events.
static class	MediaSession.ElementMetadata	The representation of a media element's metadata.
static class	MediaSession.Feature	Flags for supported media session features.
static class	MediaSession.Metadata	The representation of a media session's metadata.
static @interface	MediaSession.MSFeature	Media session feature flag definitions for supported media operations.
static class	MediaSession.PositionState	Holds the details of the media session's playback state.
static @interface	MediaSession.SystemAudioFocusChange	The permitted values for notifySystemAudioFocusChange(int): one of SYSTEM_AUDIO_FOCUS_GAIN, SYSTEM_AUDIO_FOCUS_TRANSIENT_LOSS, or SYSTEM_AUDIO_FOCUS_PERMANENT_LOSS.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SYSTEM_AUDIO_FOCUS_GAIN	The platform regained audio focus; resume what an interruption silenced.
static final int	SYSTEM_AUDIO_FOCUS_PERMANENT_LOSS	The platform took audio focus for good; the interruption is not resumed.
static final int	SYSTEM_AUDIO_FOCUS_TRANSIENT_LOSS	The platform took audio focus transiently (e.g.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MediaSession(GeckoSession session)	Create a new MediaSession for the given GeckoSession.

Method Summary

Modifier and Type	Method	Description
boolean	isActive()	Get whether the media session is active.
void	muteAudio(boolean mute)	Set whether audio should be muted.
void	nextTrack()	Select and play the next track.
void	notifySystemAudioFocusChange(int change)	Route a system audio-focus change to the tab's Audio Session interrupt.
void	pause()	Pause playback for the media session.
void	play()	Start playback for the media session.
void	previousTrack()	Select and play the previous track.
void	seekBackward()	Seek backward by a sensible number of seconds.
void	seekForward()	Seek forward by a sensible number of seconds.
void	seekTo(double time, boolean fast)	Seek to a specific time.
void	skipAd()	Skip the advertisement that is currently playing.
void	stop()	Stop playback for the media session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SYSTEM_AUDIO_FOCUS_GAIN

public static final int SYSTEM_AUDIO_FOCUS_GAIN

The platform regained audio focus; resume what an interruption silenced.

See Also:

• Constant Field Values

SYSTEM_AUDIO_FOCUS_TRANSIENT_LOSS

public static final int SYSTEM_AUDIO_FOCUS_TRANSIENT_LOSS

The platform took audio focus transiently (e.g. a call); resumable on gain.

See Also:

• Constant Field Values

SYSTEM_AUDIO_FOCUS_PERMANENT_LOSS

public static final int SYSTEM_AUDIO_FOCUS_PERMANENT_LOSS

The platform took audio focus for good; the interruption is not resumed.

See Also:

• Constant Field Values

Constructor Details

MediaSession

protected MediaSession(GeckoSession session)

Create a new MediaSession for the given GeckoSession.

Parameters:

session - The GeckoSession this media session is associated with.

Method Details

isActive

public boolean isActive()

Get whether the media session is active. Only active media sessions can be controlled.

Changes in the active state are notified via MediaSession.Delegate.onActivated(org.mozilla.geckoview.GeckoSession, org.mozilla.geckoview.MediaSession) and MediaSession.Delegate.onDeactivated(org.mozilla.geckoview.GeckoSession, org.mozilla.geckoview.MediaSession) respectively.

Returns:

True if this media session is active, false otherwise.

See Also:

• MediaSession.Delegate.onActivated(org.mozilla.geckoview.GeckoSession, org.mozilla.geckoview.MediaSession)
• MediaSession.Delegate.onDeactivated(org.mozilla.geckoview.GeckoSession, org.mozilla.geckoview.MediaSession)

pause

public void pause()

Pause playback for the media session.

stop

public void stop()

Stop playback for the media session.

play

public void play()

Start playback for the media session.

seekTo

public void seekTo(double time,
 boolean fast)

Seek to a specific time. Prefer using fast seeking when calling this in a sequence. Don't use fast seeking for the last or only call in a sequence.

Parameters:

time - The time in seconds to move the playback time to.

fast - Whether fast seeking should be used.

seekForward

public void seekForward()

Seek forward by a sensible number of seconds.

seekBackward

public void seekBackward()

Seek backward by a sensible number of seconds.

nextTrack

public void nextTrack()

Select and play the next track. Move playback to the next item in the playlist when supported.

previousTrack

public void previousTrack()

Select and play the previous track. Move playback to the previous item in the playlist when supported.

skipAd

public void skipAd()

Skip the advertisement that is currently playing.

muteAudio

public void muteAudio(boolean mute)

Set whether audio should be muted. Muting audio is supported by default and does not require the media session to be active.

Parameters:

mute - True if audio for this media session should be muted.

notifySystemAudioFocusChange

public void notifySystemAudioFocusChange(int change)

Route a system audio-focus change to the tab's Audio Session interrupt. A transient or permanent loss suspends the tab's audible sources (media elements, Web Audio, and Web Speech); a gain resumes what the interruption silenced. The user transport (pause()/play()) is a separate control surface for controllable media.

Parameters:

change - One of SYSTEM_AUDIO_FOCUS_GAIN, SYSTEM_AUDIO_FOCUS_TRANSIENT_LOSS, or SYSTEM_AUDIO_FOCUS_PERMANENT_LOSS.