Package com.jwplayer.pub.api.background

Class MediaSessionHelper

java.lang.Object

com.jwplayer.pub.api.background.MediaSessionHelper

All Implemented Interfaces:

EventListener, AdvertisingEvents.OnAdCompleteListener, AdvertisingEvents.OnAdErrorListener, AdvertisingEvents.OnAdPlayListener, AdvertisingEvents.OnAdSkippedListener, VideoPlayerEvents.OnBufferListener, VideoPlayerEvents.OnErrorListener, VideoPlayerEvents.OnPauseListener, VideoPlayerEvents.OnPlaylistCompleteListener, VideoPlayerEvents.OnPlayListener, VideoPlayerEvents.OnPlaylistItemListener, VideoPlayerEvents.OnPlaylistItemMetadataChangedListener, VideoPlayerEvents.OnSeekedListener, VideoPlayerEvents.OnTimeListener

public class MediaSessionHelper
extends Object
implements VideoPlayerEvents.OnPlayListener, VideoPlayerEvents.OnPauseListener, VideoPlayerEvents.OnBufferListener, VideoPlayerEvents.OnErrorListener, VideoPlayerEvents.OnPlaylistItemListener, VideoPlayerEvents.OnPlaylistItemMetadataChangedListener, VideoPlayerEvents.OnPlaylistCompleteListener, VideoPlayerEvents.OnTimeListener, VideoPlayerEvents.OnSeekedListener, AdvertisingEvents.OnAdPlayListener, AdvertisingEvents.OnAdErrorListener, AdvertisingEvents.OnAdSkippedListener, AdvertisingEvents.OnAdCompleteListener

Constructor Summary

Constructors

Modifier	Constructor	Description
	MediaSessionHelper(android.content.Context context, NotificationHelper notificationHelper, ServiceMediaApi serviceMediaApi)
protected	MediaSessionHelper(android.content.Context context, NotificationHelper notificationHelper, ServiceMediaApi serviceMediaApi, BGAFactory bgaFactory)

Method Summary

Modifier and Type	Method	Description
void	onAdComplete(AdCompleteEvent adCompleteEvent)	Fired whenever an ad has completed playback.
void	onAdError(AdErrorEvent adErrorEvent)	Fired whenever an error prevents the ad from playing.
void	onAdPlay(AdPlayEvent adPlayEvent)	Fired whenever an ad starts playing or when an ad is unpaused.
void	onAdSkipped(AdSkippedEvent adSkippedEvent)	Fired whenever an ad has been skipped.
void	onBitmapReady(android.graphics.Bitmap bitmap)
void	onBuffer(BufferEvent bufferEvent)	Fired when the player enters the BUFFERING state.
void	onError(ErrorEvent errorEvent)	Fired when a media error has occurred, causing the player to stop playback and go into IDLE mode.
void	onPause(PauseEvent pauseEvent)	Fired when the player enters the PAUSED state.
void	onPlay(PlayEvent playEvent)	Fired when the player enters the PLAYING state.
void	onPlaylistComplete(PlaylistCompleteEvent playlistCompleteEvent)	Fired when the player is done playing all items in the playlist.
void	onPlaylistItem(PlaylistItemEvent playlistItemEvent)	Fired when the playlist index changes to a new playlist item.
void	onPlaylistItemMetadataChanged(PlaylistItemMetadataChangedEvent event)	Fired when playlist item metadata (title, description, or image) is updated via JWPlayer.setPlaylistItemMetadata(String, String, String).
void	onSeeked(SeekedEvent seekedEvent)	Re-anchors the media session immediately after a seek, in whatever state the player is in.
void	onTime(TimeEvent timeEvent)	Re-anchors the media session's position while playing.
protected void	updateMediaSessionWith(JWPlayer player)

Methods inherited from class java.lang.Object

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

Constructor Details

MediaSessionHelper

public MediaSessionHelper(android.content.Context context,
 NotificationHelper notificationHelper,
 ServiceMediaApi serviceMediaApi)

MediaSessionHelper

protected MediaSessionHelper(android.content.Context context,
 NotificationHelper notificationHelper,
 ServiceMediaApi serviceMediaApi,
 BGAFactory bgaFactory)

Method Details

updateMediaSessionWith

protected void updateMediaSessionWith(JWPlayer player)

onPlaylistItem

public void onPlaylistItem(PlaylistItemEvent playlistItemEvent)

Description copied from interface: VideoPlayerEvents.OnPlaylistItemListener

Fired when the playlist index changes to a new playlist item. This event occurs before the player begins playing the new playlist item.

Specified by:

onPlaylistItem in interface VideoPlayerEvents.OnPlaylistItemListener

Parameters:

playlistItemEvent - The payload that accompanies the onPlaylistItem() event.

onPlaylistItemMetadataChanged

public void onPlaylistItemMetadataChanged(PlaylistItemMetadataChangedEvent event)

Description copied from interface: VideoPlayerEvents.OnPlaylistItemMetadataChangedListener

Fired when playlist item metadata (title, description, or image) is updated via JWPlayer.setPlaylistItemMetadata(String, String, String).

Specified by:

onPlaylistItemMetadataChanged in interface VideoPlayerEvents.OnPlaylistItemMetadataChangedListener

Parameters:

event - The payload that accompanies the onPlaylistItemMetadataChanged() event.

onError

public void onError(ErrorEvent errorEvent)

Description copied from interface: VideoPlayerEvents.OnErrorListener

Fired when a media error has occurred, causing the player to stop playback and go into IDLE mode.

Specified by:

onError in interface VideoPlayerEvents.OnErrorListener

Parameters:

errorEvent - The payload that accompanies the onError() event.

onAdComplete

public void onAdComplete(AdCompleteEvent adCompleteEvent)

Description copied from interface: AdvertisingEvents.OnAdCompleteListener

Fired whenever an ad has completed playback.

Supported for VAST and IMA.

Specified by:

onAdComplete in interface AdvertisingEvents.OnAdCompleteListener

Parameters:

adCompleteEvent - The payload that accompanies the onAdComplete() event.

onAdSkipped

public void onAdSkipped(AdSkippedEvent adSkippedEvent)

Description copied from interface: AdvertisingEvents.OnAdSkippedListener

Fired whenever an ad has been skipped.

Supported for VAST and IMA.

Specified by:

onAdSkipped in interface AdvertisingEvents.OnAdSkippedListener

Parameters:

adSkippedEvent - The payload that accompanies the onAdSkipped() event.

onAdPlay

public void onAdPlay(AdPlayEvent adPlayEvent)

Description copied from interface: AdvertisingEvents.OnAdPlayListener

Fired whenever an ad starts playing or when an ad is unpaused.

Specified by:

onAdPlay in interface AdvertisingEvents.OnAdPlayListener

Parameters:

adPlayEvent - The payload that accompanies the onAdPlay() event.

onAdError

public void onAdError(AdErrorEvent adErrorEvent)

Description copied from interface: AdvertisingEvents.OnAdErrorListener

Fired whenever an error prevents the ad from playing.

Supported for VAST and IMA.

Specified by:

onAdError in interface AdvertisingEvents.OnAdErrorListener

Parameters:

adErrorEvent - The payload that accompanies the onAdError() event.

onBuffer

public void onBuffer(BufferEvent bufferEvent)

Description copied from interface: VideoPlayerEvents.OnBufferListener

Fired when the player enters the BUFFERING state.

Specified by:

onBuffer in interface VideoPlayerEvents.OnBufferListener

Parameters:

bufferEvent - The payload that accompanies the onBuffer() event.

onPause

public void onPause(PauseEvent pauseEvent)

Description copied from interface: VideoPlayerEvents.OnPauseListener

Fired when the player enters the PAUSED state.

Specified by:

onPause in interface VideoPlayerEvents.OnPauseListener

Parameters:

pauseEvent - The payload that accompanies the onPause() event.

onPlay

public void onPlay(PlayEvent playEvent)

Description copied from interface: VideoPlayerEvents.OnPlayListener

Fired when the player enters the PLAYING state.

Specified by:

onPlay in interface VideoPlayerEvents.OnPlayListener

Parameters:

playEvent - The payload that accompanies the onPlay() event.

onPlaylistComplete

public void onPlaylistComplete(PlaylistCompleteEvent playlistCompleteEvent)

Description copied from interface: VideoPlayerEvents.OnPlaylistCompleteListener

Fired when the player is done playing all items in the playlist. However, if the repeat option is set true, this is never fired.

Specified by:

onPlaylistComplete in interface VideoPlayerEvents.OnPlaylistCompleteListener

Parameters:

playlistCompleteEvent - The payload that accompanies the onPlaylistComplete() event.

onBitmapReady

public void onBitmapReady(android.graphics.Bitmap bitmap)

onTime

public void onTime(TimeEvent timeEvent)

Re-anchors the media session's position while playing.

updatePlaybackState(com.jwplayer.pub.api.PlayerState) only runs on state transitions, so between them the system had nothing but its own extrapolation to go on and drifted from the real playhead — and a seek during playback was not reflected at all until the next pause or buffer. Time events give a cheap, already-available tick to correct both.

Deliberately does not rebuild the notification: NotificationHelper bakes its content at build time and nothing shown there changes with position, so rebuilding it several times a second would be pure cost.

Specified by:

onTime in interface VideoPlayerEvents.OnTimeListener

Parameters:

timeEvent - The payload that accompanies the onTime() event.

onSeeked

public void onSeeked(SeekedEvent seekedEvent)

Re-anchors the media session immediately after a seek, in whatever state the player is in.

Needed because the periodic re-anchor in onTime(com.jwplayer.pub.api.events.TimeEvent) only runs while PLAYING. For VOD the time loop is stopped while paused (DVR keeps a slow loop, but the PLAYING gate excludes it either way). A seek requested from the lock screen or notification — ServiceMediaApi.onSeekTo, which the session advertises via ACTION_SEEK_TO — would otherwise leave the session holding the pre-seek anchor, so the scrubber would snap back to where it was and stay there until the next play. That is the second half of this ticket's own verification step.

Deliberately not throttled: a seek is user-initiated and infrequent, and the whole point is that it takes effect at once rather than up to a second later. It does stamp the throttle so the next periodic tick is measured from here. Notification is not rebuilt, for the same reason as onTime(com.jwplayer.pub.api.events.TimeEvent).

Specified by:

onSeeked in interface VideoPlayerEvents.OnSeekedListener

Parameters:

seekedEvent - The payload that accompanies the onSeeked() event.