Package com.jwplayer.pub.api.background

Class MediaServiceController

java.lang.Object

com.jwplayer.pub.api.background.MediaServiceController

All Implemented Interfaces:

android.content.ServiceConnection

public class MediaServiceController
extends Object
implements android.content.ServiceConnection

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MediaServiceController.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected androidx.appcompat.app.AppCompatActivity	mActivity
protected MediaService	mMediaService
protected Class<? extends MediaService>	mMediaServiceClass
protected MediaSessionHelper	mMediaSessionHelper	Deprecated. No longer used; the media session is owned by MediaService.
protected NotificationHelper	mNotificationHelper
protected ServiceMediaApi	mServiceMediaApi

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MediaServiceController(androidx.appcompat.app.AppCompatActivity activity, NotificationHelper notificationHelper, MediaSessionHelper mediaSessionHelper, ServiceMediaApi serviceMediaApi, Class<? extends MediaService> mediaServiceClass, BGAFactory bgaFactory)

Method Summary

Modifier and Type	Method	Description
void	bindService()
static MediaServiceController	enable(androidx.appcompat.app.AppCompatActivity activity, JWPlayer player, ServiceMediaApi serviceMediaApi)	Background audio in one line: builds a controller with the default notification (or with serviceMediaApi's buttons and transport behaviour, if not null), binds it now, and unbinds it when activity is destroyed.
void	onServiceConnected(android.content.ComponentName name, android.os.IBinder service)
void	onServiceDisconnected(android.content.ComponentName name)
void	unbindService()	Stops background audio.
void	updateServiceMediaApi(ServiceMediaApi serviceMediaApi)	Points background audio at another player.

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.content.ServiceConnection

onBindingDied, onNullBinding

Field Details

mMediaService

protected MediaService mMediaService

mActivity

protected androidx.appcompat.app.AppCompatActivity mActivity

mNotificationHelper

protected NotificationHelper mNotificationHelper

mMediaSessionHelper

@Deprecated
protected MediaSessionHelper mMediaSessionHelper

Deprecated.

No longer used; the media session is owned by MediaService.

mServiceMediaApi

protected ServiceMediaApi mServiceMediaApi

mMediaServiceClass

protected Class<? extends MediaService> mMediaServiceClass

Constructor Details

MediaServiceController

protected MediaServiceController(androidx.appcompat.app.AppCompatActivity activity,
 NotificationHelper notificationHelper,
 MediaSessionHelper mediaSessionHelper,
 ServiceMediaApi serviceMediaApi,
 Class<? extends MediaService> mediaServiceClass,
 BGAFactory bgaFactory)

Method Details

updateServiceMediaApi

public void updateServiceMediaApi(@NonNull
 ServiceMediaApi serviceMediaApi)

Points background audio at another player.

enable

@NonNull
public static MediaServiceController enable(@NonNull
 androidx.appcompat.app.AppCompatActivity activity,
 @NonNull
 JWPlayer player,
 @Nullable
 ServiceMediaApi serviceMediaApi)

Background audio in one line: builds a controller with the default notification (or with serviceMediaApi's buttons and transport behaviour, if not null), binds it now, and unbinds it when activity is destroyed. MediaService must still be declared in the app manifest.

 MediaServiceController.enable(this, player, null);
 // or, with custom buttons:
 MediaServiceController.enable(this, player, new MyServiceMediaApi(player));
 

The controller is unbound on every ON_DESTROY, including one caused by a configuration change, so background audio ends with the activity as it does with a manual unbindService() in onDestroy. An activity that is recreated on rotation should call enable again in onCreate (or handle the configuration change).

Returns:

the bound controller, for updateServiceMediaApi(com.jwplayer.pub.api.background.ServiceMediaApi) or an earlier unbindService()

bindService

public void bindService()

unbindService

public void unbindService()

Stops background audio. Safe to call more than once, and before the service has connected; the controller can be bound again afterwards.

onServiceConnected

public void onServiceConnected(android.content.ComponentName name,
 android.os.IBinder service)

Specified by:

onServiceConnected in interface android.content.ServiceConnection

onServiceDisconnected

public void onServiceDisconnected(android.content.ComponentName name)

Specified by:

onServiceDisconnected in interface android.content.ServiceConnection