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 and 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 class	MediaSession.PositionState Holds the details of the media session's playback state.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MediaSession(GeckoSession session)

Method Summary

Modifier and Type	Method and 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	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 Object

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

Constructor Detail

MediaSession

protected MediaSession(GeckoSession session)

Method Detail

isActive

public boolean isActive()

Get whether the media session is active. Only active media sessions can be controlled. Inactive media session may receive state events since some state events may be dispatched before the media session becomes active. 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.