Ta strona zawiera fragmenty kodu i opisy funkcji dostępnych do dostosowywania aplikacji Android TV Receiver.
Konfigurowanie bibliotek
Aby udostępnić interfejsy API Cast Connect w aplikacji na Androida TV:
-
Otwórz plik
build.gradle
w katalogu modułu aplikacji. -
Sprawdź, czy
google()
jest uwzględniona w wymienionychrepositories
.repositories { google() }
-
W zależności od typu urządzenia docelowego aplikacji dodaj najnowsze wersje bibliotek do zależności:
-
W przypadku aplikacji Odbiornik na Androida:
dependencies { implementation 'com.google.android.gms:play-services-cast-tv:21.1.1' implementation 'com.google.android.gms:play-services-cast:22.0.0' }
-
W aplikacji Sender na Androida:
dependencies { implementation 'com.google.android.gms:play-services-cast:21.1.1' implementation 'com.google.android.gms:play-services-cast-framework:22.0.0' }
-
W przypadku aplikacji Odbiornik na Androida:
-
Zapisz zmiany i kliknij
Sync Project with Gradle Files
na pasku narzędzi.
-
Upewnij się, że
Podfile
jest kierowany nagoogle-cast-sdk
4.8.3 lub nowszą wersję -
kierować na system iOS 14 lub nowszy, Więcej informacji znajdziesz w informacjach o wersji.
platform: ios, '14' def target_pods pod 'google-cast-sdk', '~>4.8.3' end
- Wymaga przeglądarki Chromium w wersji M87 lub nowszej.
-
Dodawanie biblioteki Web Sender API do projektu
<script src="//www.gstatic.com/cv/js/sender/v1/cast_sender.js?loadCastFramework=1"></script>
Wymagania dotyczące AndroidX
Nowe wersje Usług Google Play wymagają zaktualizowania aplikacji, aby mogła używać przestrzeni nazw androidx
. Postępuj zgodnie z instrukcjami dotyczącymi migacji do AndroidX.
Aplikacja na Androida TV – wymagania wstępne
Aby obsługiwać Cast Connect w aplikacji na Androida TV, musisz utworzyć i obsługiwać zdarzenia z sesji multimedialnej. Dane z sesji multimedialnej zawierają podstawowe informacje o stanie multimediów, np. pozycję, stan odtwarzania itp. Twoja sesja multimediów jest też używana przez bibliotekę Cast Connect do sygnalizowania, że otrzymała określone wiadomości od nadawcy, np. o wstrzymaniu.
Więcej informacji o sesji multimediów i jej inicjowaniu znajdziesz w przewodniku po sesjach multimediów.
Cykl życia sesji multimediów
Aplikacja powinna utworzyć sesję multimediów, gdy rozpocznie się odtwarzanie, i zakończyć ją, gdy nie będzie już można jej kontrolować. Jeśli na przykład Twoja aplikacja to aplikacja do odtwarzania filmów, powinna ona kończyć sesję, gdy użytkownik przestanie odtwarzać treści – albo przez wybranie opcji „Wstecz”, aby przejść do innych treści, albo przez przeniesienie aplikacji na drugi plan. Jeśli Twoja aplikacja to aplikacja muzyczna, powinna ona kończyć sesję, gdy nie odtwarza już żadnych multimediów.
Aktualizowanie stanu sesji
Dane w sesji multimediów powinny być aktualizowane zgodnie ze stanem odtwarzacza. Na przykład gdy odtwarzanie jest wstrzymane, należy zaktualizować stan odtwarzania oraz obsługiwane działania. W tabeli poniżej znajdziesz listę stanów, za które odpowiadasz.
MediaMetadataCompat
Pole metadanych | Opis |
---|---|
METADATA_KEY_TITLE (wymagany) | Tytuł multimediów. |
METADATA_KEY_DISPLAY_SUBTITLE | Podtytuł. |
METADATA_KEY_DISPLAY_ICON_URI | Adres URL ikony. |
METADATA_KEY_DURATION (wymagany) | Czas trwania multimediów. |
METADATA_KEY_MEDIA_URI | Identyfikator treści. |
METADATA_KEY_ARTIST | wykonawca; |
METADATA_KEY_ALBUM | albumu, |
PlaybackStateCompat
Wymagana metoda | Opis |
---|---|
setActions() | Ustawia obsługiwane polecenia multimedialne. |
setState() | Ustaw stan odtwarzania i bieżącą pozycję. |
MediaSessionCompat
Wymagana metoda | Opis |
---|---|
setRepeatMode() | Ustawia tryb powtarzania. |
setShuffleMode() | Ustawia tryb odtwarzania losowego. |
setMetadata() | Ustawia metadane multimediów. |
setPlaybackState() | Ustawia stan odtwarzania. |
private fun updateMediaSession() { val metadata = MediaMetadataCompat.Builder() .putString(MediaMetadataCompat.METADATA_KEY_TITLE, "title") .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_SUBTITLE, "subtitle") .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_ICON_URI, mMovie.getCardImageUrl()) .build() val playbackState = PlaybackStateCompat.Builder() .setState( PlaybackStateCompat.STATE_PLAYING, player.getPosition(), player.getPlaybackSpeed(), System.currentTimeMillis() ) .build() mediaSession.setMetadata(metadata) mediaSession.setPlaybackState(playbackState) }
private void updateMediaSession() { MediaMetadataCompat metadata = new MediaMetadataCompat.Builder() .putString(MediaMetadataCompat.METADATA_KEY_TITLE, "title") .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_SUBTITLE, "subtitle") .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_ICON_URI,mMovie.getCardImageUrl()) .build(); PlaybackStateCompat playbackState = new PlaybackStateCompat.Builder() .setState( PlaybackStateCompat.STATE_PLAYING, player.getPosition(), player.getPlaybackSpeed(), System.currentTimeMillis()) .build(); mediaSession.setMetadata(metadata); mediaSession.setPlaybackState(playbackState); }
Obsługa kontroli transportu
Aplikacja powinna implementować wywołanie zwrotne kontroli transportu sesji multimedialnej. W tabeli poniżej znajdziesz informacje o tym, jakie działania związane z kontrolą transportu muszą obsługiwać:
MediaSessionCompat.Callback
Działania | Opis |
---|---|
onPlay() | Wznów |
onPause() | Wstrzymaj |
onSeekTo() | Przewijanie do pozycji |
onStop() | Zatrzymaj bieżące multimedia. |
class MyMediaSessionCallback : MediaSessionCompat.Callback() { override fun onPause() { // Pause the player and update the play state. ... } override fun onPlay() { // Resume the player and update the play state. ... } override fun onSeekTo (long pos) { // Seek and update the play state. ... } ... } mediaSession.setCallback( MyMediaSessionCallback() );
public MyMediaSessionCallback extends MediaSessionCompat.Callback { public void onPause() { // Pause the player and update the play state. ... } public void onPlay() { // Resume the player and update the play state. ... } public void onSeekTo (long pos) { // Seek and update the play state. ... } ... } mediaSession.setCallback(new MyMediaSessionCallback());
Konfigurowanie obsługi przesyłania
Gdy aplikacja nadawcy wysyła żądanie uruchomienia, tworzy się intencja z przestrzenią nazw aplikacji. Twoja aplikacja jest odpowiedzialna za obsługę tego obiektu i tworzenie jego instancji CastReceiverContext
po uruchomieniu aplikacji na telewizor. Obiekt CastReceiverContext
jest potrzebny do interakcji z Castem podczas korzystania z aplikacji telewizyjnej. Ten obiekt umożliwia Twojej aplikacji na telewizor przyjmowanie wiadomości multimedialnych przesyłanych przez Cast z dowolnych połączonych nadawców.
Konfiguracja Androida TV
Dodawanie filtra zamiaru uruchomienia
Dodaj nowy filtr intencji do działania, które ma obsługiwać intencję uruchamiania z aplikacji nadawcy:
<activity android:name="com.example.activity">
<intent-filter>
<action android:name="com.google.android.gms.cast.tv.action.LAUNCH" />
<category android:name="android.intent.category.DEFAULT" />
</intent-filter>
</activity>
Określ dostawcę opcji odbiornika
Musisz wdrożyć ReceiverOptionsProvider
, aby udostępnić:CastReceiverOptions
:
class MyReceiverOptionsProvider : ReceiverOptionsProvider { override fun getOptions(context: Context?): CastReceiverOptions { return CastReceiverOptions.Builder(context) .setStatusText("My App") .build() } }
public class MyReceiverOptionsProvider implements ReceiverOptionsProvider { @Override public CastReceiverOptions getOptions(Context context) { return new CastReceiverOptions.Builder(context) .setStatusText("My App") .build(); } }
Następnie w sekcji AndroidManifest
określ dostawcę opcji:
<meta-data
android:name="com.google.android.gms.cast.tv.RECEIVER_OPTIONS_PROVIDER_CLASS_NAME"
android:value="com.example.mysimpleatvapplication.MyReceiverOptionsProvider" />
Wartość ReceiverOptionsProvider
jest używana do przekazywania wartości CastReceiverOptions
podczas inicjowania CastReceiverContext
.
Kontekst odbiornika Cast
Inicjalizacja funkcji CastReceiverContext
podczas tworzenia aplikacji:
override fun onCreate() { CastReceiverContext.initInstance(this) ... }
@Override public void onCreate() { CastReceiverContext.initInstance(this); ... }
Uruchom CastReceiverContext
, gdy aplikacja przejdzie na pierwszy plan:
CastReceiverContext.getInstance().start()
CastReceiverContext.getInstance().start();
Wywołaj stop()
na
CastReceiverContext
po przejściu aplikacji do tła w przypadku aplikacji do odtwarzania filmów lub aplikacji, które nie obsługują odtwarzania w tle:
// Player has stopped. CastReceiverContext.getInstance().stop()
// Player has stopped. CastReceiverContext.getInstance().stop();
Jeśli Twoja aplikacja obsługuje odtwarzanie w tle, gdy przestanie odtwarzać w tle, wywołaj stop()
na CastReceiverContext
.
Aby zarządzać wywoływaniem metody CastReceiverContext.start()
CastReceiverContext.stop()
, zwłaszcza jeśli natywna aplikacja ma wiele aktywności, zdecydowanie zalecamy korzystanie z interfejsu LifecycleObserver z biblioteki androidx.lifecycle
. Zapobiega to warunkom wyścigu, gdy wywołujesz funkcje start()
i stop()
z różnych działań.
// Create a LifecycleObserver class. class MyLifecycleObserver : DefaultLifecycleObserver { override fun onStart(owner: LifecycleOwner) { // App prepares to enter foreground. CastReceiverContext.getInstance().start() } override fun onStop(owner: LifecycleOwner) { // App has moved to the background or has terminated. CastReceiverContext.getInstance().stop() } } // Add the observer when your application is being created. class MyApplication : Application() { fun onCreate() { super.onCreate() // Initialize CastReceiverContext. CastReceiverContext.initInstance(this /* android.content.Context */) // Register LifecycleObserver ProcessLifecycleOwner.get().lifecycle.addObserver( MyLifecycleObserver()) } }
// Create a LifecycleObserver class. public class MyLifecycleObserver implements DefaultLifecycleObserver { @Override public void onStart(LifecycleOwner owner) { // App prepares to enter foreground. CastReceiverContext.getInstance().start(); } @Override public void onStop(LifecycleOwner owner) { // App has moved to the background or has terminated. CastReceiverContext.getInstance().stop(); } } // Add the observer when your application is being created. public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); // Initialize CastReceiverContext. CastReceiverContext.initInstance(this /* android.content.Context */); // Register LifecycleObserver ProcessLifecycleOwner.get().getLifecycle().addObserver( new MyLifecycleObserver()); } }
// In AndroidManifest.xml set MyApplication as the application class
<application
...
android:name=".MyApplication">
Łączenie MediaSession z MediaManager
Podczas tworzenia MediaSession
musisz też podać bieżący token MediaSession
, aby CastReceiverContext
wiedział, dokąd wysyłać polecenia i jak pobrać stan odtwarzania multimediów:
val mediaManager: MediaManager = receiverContext.getMediaManager() mediaManager.setSessionCompatToken(currentMediaSession.getSessionToken())
MediaManager mediaManager = receiverContext.getMediaManager(); mediaManager.setSessionCompatToken(currentMediaSession.getSessionToken());
Gdy MediaSession
zostanie zwolnione z powodu braku odtwarzania, należy ustawić token null na MediaManager
:
myPlayer.stop() mediaSession.release() mediaManager.setSessionCompatToken(null)
myPlayer.stop(); mediaSession.release(); mediaManager.setSessionCompatToken(null);
Jeśli Twoja aplikacja obsługuje odtwarzanie multimediów w tle, zamiast wywoływać ją
CastReceiverContext.stop()
w momencie, gdy zostaje ona wysłana do uruchamiania w tle, powinnaś wywoływać ją tylko wtedy, gdy jest w tle i nie odtwarza już multimediów. Na przykład:
class MyLifecycleObserver : DefaultLifecycleObserver { ... // App has moved to the background. override fun onPause(owner: LifecycleOwner) { mIsBackground = true myStopCastReceiverContextIfNeeded() } } // Stop playback on the player. private fun myStopPlayback() { myPlayer.stop() myStopCastReceiverContextIfNeeded() } // Stop the CastReceiverContext when both the player has // stopped and the app has moved to the background. private fun myStopCastReceiverContextIfNeeded() { if (mIsBackground && myPlayer.isStopped()) { CastReceiverContext.getInstance().stop() } }
public class MyLifecycleObserver implements DefaultLifecycleObserver { ... // App has moved to the background. @Override public void onPause(LifecycleOwner owner) { mIsBackground = true; myStopCastReceiverContextIfNeeded(); } } // Stop playback on the player. private void myStopPlayback() { myPlayer.stop(); myStopCastReceiverContextIfNeeded(); } // Stop the CastReceiverContext when both the player has // stopped and the app has moved to the background. private void myStopCastReceiverContextIfNeeded() { if (mIsBackground && myPlayer.isStopped()) { CastReceiverContext.getInstance().stop(); } }
Korzystanie z Exoplayera z Cast Connect
Jeśli używasz Exoplayer
, możesz użyć MediaSessionConnector
, aby automatycznie utrzymywać sesję i wszystkie powiązane informacje, w tym stan odtwarzania, zamiast ręcznie śledzić zmiany.
MediaSessionConnector.MediaButtonEventHandler
może być używany do obsługi zdarzeń MediaButton przez wywołanie
setMediaButtonEventHandler(MediaButtonEventHandler)
które są domyślnie obsługiwane przez
MediaSessionCompat.Callback
.
Aby zintegrować MediaSessionConnector
w aplikacji, dodaj te elementy do klasy aktywności odtwarzacza lub do miejsca, w którym zarządzasz sesją multimedialną:
class PlayerActivity : Activity() { private var mMediaSession: MediaSessionCompat? = null private var mMediaSessionConnector: MediaSessionConnector? = null private var mMediaManager: MediaManager? = null override fun onCreate(savedInstanceState: Bundle?) { ... mMediaSession = MediaSessionCompat(this, LOG_TAG) mMediaSessionConnector = MediaSessionConnector(mMediaSession!!) ... } override fun onStart() { ... mMediaManager = receiverContext.getMediaManager() mMediaManager!!.setSessionCompatToken(currentMediaSession.getSessionToken()) mMediaSessionConnector!!.setPlayer(mExoPlayer) mMediaSessionConnector!!.setMediaMetadataProvider(mMediaMetadataProvider) mMediaSession!!.isActive = true ... } override fun onStop() { ... mMediaSessionConnector!!.setPlayer(null) mMediaSession!!.release() mMediaManager!!.setSessionCompatToken(null) ... } }
public class PlayerActivity extends Activity { private MediaSessionCompat mMediaSession; private MediaSessionConnector mMediaSessionConnector; private MediaManager mMediaManager; @Override protected void onCreate(Bundle savedInstanceState) { ... mMediaSession = new MediaSessionCompat(this, LOG_TAG); mMediaSessionConnector = new MediaSessionConnector(mMediaSession); ... } @Override protected void onStart() { ... mMediaManager = receiverContext.getMediaManager(); mMediaManager.setSessionCompatToken(currentMediaSession.getSessionToken()); mMediaSessionConnector.setPlayer(mExoPlayer); mMediaSessionConnector.setMediaMetadataProvider(mMediaMetadataProvider); mMediaSession.setActive(true); ... } @Override protected void onStop() { ... mMediaSessionConnector.setPlayer(null); mMediaSession.release(); mMediaManager.setSessionCompatToken(null); ... } }
Konfiguracja aplikacji nadawcy
Włączanie obsługi Cast Connect
Gdy zaktualizujesz aplikację przesyłającą, aby obsługiwała Cast Connect, możesz zadeklarować jej gotowość, ustawiając flagę androidReceiverCompatible
LaunchOptions
na wartość „true”.
Wymaga wersji play-services-cast-framework
19.0.0
lub nowszej.
Flaga androidReceiverCompatible
jest ustawiona w pliku LaunchOptions
(który jest częścią pliku CastOptions
):
class CastOptionsProvider : OptionsProvider { override fun getCastOptions(context: Context?): CastOptions { val launchOptions: LaunchOptions = Builder() .setAndroidReceiverCompatible(true) .build() return CastOptions.Builder() .setLaunchOptions(launchOptions) ... .build() } }
public class CastOptionsProvider implements OptionsProvider { @Override public CastOptions getCastOptions(Context context) { LaunchOptions launchOptions = new LaunchOptions.Builder() .setAndroidReceiverCompatible(true) .build(); return new CastOptions.Builder() .setLaunchOptions(launchOptions) ... .build(); } }
Wymagana jest usługa google-cast-sdk
w wersji v4.4.8
lub nowszej.
Flaga androidReceiverCompatible
jest ustawiona w pliku GCKLaunchOptions
(który jest częścią pliku GCKCastOptions
):
let options = GCKCastOptions(discoveryCriteria: GCKDiscoveryCriteria(applicationID: kReceiverAppID)) ... let launchOptions = GCKLaunchOptions() launchOptions.androidReceiverCompatible = true options.launchOptions = launchOptions GCKCastContext.setSharedInstanceWith(options)
Wymagana jest przeglądarka Chromium w wersjiM87
lub nowszej.
const context = cast.framework.CastContext.getInstance(); const castOptions = new cast.framework.CastOptions(); castOptions.receiverApplicationId = kReceiverAppID; castOptions.androidReceiverCompatible = true; context.setOptions(castOptions);
Konfiguracja konsoli dla deweloperów w Cast
Konfigurowanie aplikacji na Androida TV
Dodaj nazwę pakietu aplikacji na Androida TV w Konsoli dewelopera Cast, aby powiązać ją z identyfikatorem aplikacji Cast.
Rejestrowanie urządzeń dewelopera
Zarejestruj numer seryjny urządzenia z Androidem TV, którego będziesz używać do tworzenia aplikacji, w konsoli dewelopera Cast.
Z powodów bezpieczeństwa bez rejestracji Cast Connect będzie działać tylko w przypadku aplikacji zainstalowanych ze Sklepu Google Play.
Więcej informacji o rejestrowaniu urządzenia Cast lub Android TV na potrzeby tworzenia aplikacji do przesyłania treści znajdziesz na stronie rejestracji.
Wczytywanie multimediów
Jeśli w aplikacji na Androida TV masz już zaimplementowaną obsługę precyzyjnych linków, w pliku manifestu Androida TV powinna być skonfigurowana podobna definicja:
<activity android:name="com.example.activity">
<intent-filter>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<data android:scheme="https"/>
<data android:host="www.example.com"/>
<data android:pathPattern=".*"/>
</intent-filter>
</activity>
Ładowanie według elementu nadawcy
W przypadku nadawców możesz przekazać precyzyjny link, ustawiając wartość entity
w informacjach o mediach dla żądania wczytania:
val mediaToLoad = MediaInfo.Builder("some-id") .setEntity("https://example.com/watch/some-id") ... .build() val loadRequest = MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") ... .build() remoteMediaClient.load(loadRequest)
MediaInfo mediaToLoad = new MediaInfo.Builder("some-id") .setEntity("https://example.com/watch/some-id") ... .build(); MediaLoadRequestData loadRequest = new MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") ... .build(); remoteMediaClient.load(loadRequest);
let mediaInfoBuilder = GCKMediaInformationBuilder(entity: "https://example.com/watch/some-id") ... mediaInformation = mediaInfoBuilder.build() let mediaLoadRequestDataBuilder = GCKMediaLoadRequestDataBuilder() mediaLoadRequestDataBuilder.mediaInformation = mediaInformation mediaLoadRequestDataBuilder.credentials = "user-credentials" ... let mediaLoadRequestData = mediaLoadRequestDataBuilder.build() remoteMediaClient?.loadMedia(with: mediaLoadRequestData)
Wymaga przeglądarki Chromium w wersjiM87
lub nowszej.
let mediaInfo = new chrome.cast.media.MediaInfo('some-id"', 'video/mp4'); mediaInfo.entity = 'https://example.com/watch/some-id'; ... let request = new chrome.cast.media.LoadRequest(mediaInfo); request.credentials = 'user-credentials'; ... cast.framework.CastContext.getInstance().getCurrentSession().loadMedia(request);
Polecenie wczytania jest wysyłane za pomocą intencjonalnego działania z precyzyjnym linkiem i nazwą pakietu zdefiniowaną w Konsoli dewelopera.
Konfigurowanie danych logowania do usługi ATV w nadajniku
Możliwe, że aplikacja odbiornika internetowego i aplikacja na Androida obsługują różne precyzyjne linki i funkcje credentials
(np. jeśli na tych dwóch platformach inaczej obsługujesz uwierzytelnianie). Aby rozwiązać ten problem, możesz podać alternatywne entity
i credentials
na Androidzie TV:
val mediaToLoad = MediaInfo.Builder("some-id") .setEntity("https://example.com/watch/some-id") .setAtvEntity("myscheme://example.com/atv/some-id") ... .build() val loadRequest = MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") .setAtvCredentials("atv-user-credentials") ... .build() remoteMediaClient.load(loadRequest)
MediaInfo mediaToLoad = new MediaInfo.Builder("some-id") .setEntity("https://example.com/watch/some-id") .setAtvEntity("myscheme://example.com/atv/some-id") ... .build(); MediaLoadRequestData loadRequest = new MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") .setAtvCredentials("atv-user-credentials") ... .build(); remoteMediaClient.load(loadRequest);
let mediaInfoBuilder = GCKMediaInformationBuilder(entity: "https://example.com/watch/some-id") mediaInfoBuilder.atvEntity = "myscheme://example.com/atv/some-id" ... mediaInformation = mediaInfoBuilder.build() let mediaLoadRequestDataBuilder = GCKMediaLoadRequestDataBuilder() mediaLoadRequestDataBuilder.mediaInformation = mediaInformation mediaLoadRequestDataBuilder.credentials = "user-credentials" mediaLoadRequestDataBuilder.atvCredentials = "atv-user-credentials" ... let mediaLoadRequestData = mediaLoadRequestDataBuilder.build() remoteMediaClient?.loadMedia(with: mediaLoadRequestData)
Wymagana jest przeglądarka Chromium w wersjiM87
lub nowszej.
let mediaInfo = new chrome.cast.media.MediaInfo('some-id"', 'video/mp4'); mediaInfo.entity = 'https://example.com/watch/some-id'; mediaInfo.atvEntity = 'myscheme://example.com/atv/some-id'; ... let request = new chrome.cast.media.LoadRequest(mediaInfo); request.credentials = 'user-credentials'; request.atvCredentials = 'atv-user-credentials'; ... cast.framework.CastContext.getInstance().getCurrentSession().loadMedia(request);
Jeśli aplikacja Web Receiver jest uruchomiona, używa ona wartości entity
i credentials
w żądaniu wczytania. Jeśli jednak uruchomisz aplikację na Androida TV, pakiet SDK zastąpi entity
i credentials
wartościami atvEntity
i atvCredentials
(jeśli są określone).
Ładowanie za pomocą identyfikatora treści lub MediaQueueData
Jeśli nie używasz entity
ani atvEntity
, a w informacjach o mediach podajesz identyfikator treści lub adres URL treści albo używasz bardziej szczegółowych danych żądania wczytywania multimediów, musisz dodać w aplikacji na Androida TV następujący wstępnie zdefiniowany filtr intencji:
<activity android:name="com.example.activity">
<intent-filter>
<action android:name="com.google.android.gms.cast.tv.action.LOAD"/>
<category android:name="android.intent.category.DEFAULT" />
</intent-filter>
</activity>
Po stronie nadawcy, podobnie jak w przypadku ładowania według elementu, możesz utworzyć żądanie wczytania z informacjami o treści i wywołać funkcję load()
.
val mediaToLoad = MediaInfo.Builder("some-id").build() val loadRequest = MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") ... .build() remoteMediaClient.load(loadRequest)
MediaInfo mediaToLoad = new MediaInfo.Builder("some-id").build(); MediaLoadRequestData loadRequest = new MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") ... .build(); remoteMediaClient.load(loadRequest);
let mediaInfoBuilder = GCKMediaInformationBuilder(contentId: "some-id") ... mediaInformation = mediaInfoBuilder.build() let mediaLoadRequestDataBuilder = GCKMediaLoadRequestDataBuilder() mediaLoadRequestDataBuilder.mediaInformation = mediaInformation mediaLoadRequestDataBuilder.credentials = "user-credentials" ... let mediaLoadRequestData = mediaLoadRequestDataBuilder.build() remoteMediaClient?.loadMedia(with: mediaLoadRequestData)
Wymagana jest przeglądarka Chromium w wersjiM87
lub nowszej.
let mediaInfo = new chrome.cast.media.MediaInfo('some-id"', 'video/mp4'); ... let request = new chrome.cast.media.LoadRequest(mediaInfo); ... cast.framework.CastContext.getInstance().getCurrentSession().loadMedia(request);
Obsługa żądań dotyczących wczytywania
Aby obsługiwać te żądania wczytywania, w swojej aktywności musisz obsługiwać intencje w wywołaniach zwrotnych cyklu życia aktywności:
class MyActivity : Activity() { override fun onStart() { super.onStart() val mediaManager = CastReceiverContext.getInstance().getMediaManager() // Pass the intent to the SDK. You can also do this in onCreate(). if (mediaManager.onNewIntent(intent)) { // If the SDK recognizes the intent, you should early return. return } // If the SDK doesn't recognize the intent, you can handle the intent with // your own logic. ... } // For some cases, a new load intent triggers onNewIntent() instead of // onStart(). override fun onNewIntent(intent: Intent) { val mediaManager = CastReceiverContext.getInstance().getMediaManager() // Pass the intent to the SDK. You can also do this in onCreate(). if (mediaManager.onNewIntent(intent)) { // If the SDK recognizes the intent, you should early return. return } // If the SDK doesn't recognize the intent, you can handle the intent with // your own logic. ... } }
public class MyActivity extends Activity { @Override protected void onStart() { super.onStart(); MediaManager mediaManager = CastReceiverContext.getInstance().getMediaManager(); // Pass the intent to the SDK. You can also do this in onCreate(). if (mediaManager.onNewIntent(getIntent())) { // If the SDK recognizes the intent, you should early return. return; } // If the SDK doesn't recognize the intent, you can handle the intent with // your own logic. ... } // For some cases, a new load intent triggers onNewIntent() instead of // onStart(). @Override protected void onNewIntent(Intent intent) { MediaManager mediaManager = CastReceiverContext.getInstance().getMediaManager(); // Pass the intent to the SDK. You can also do this in onCreate(). if (mediaManager.onNewIntent(intent)) { // If the SDK recognizes the intent, you should early return. return; } // If the SDK doesn't recognize the intent, you can handle the intent with // your own logic. ... } }
Jeśli MediaManager
wykryje, że jest to intencja załadowania, wyodrębnia obiekt MediaLoadRequestData
z intencji i wywołuje MediaLoadCommandCallback.onLoad()
.
Aby obsłużyć żądanie wczytania, musisz zastąpić tę metodę. Powrót wywołania musi zostać zarejestrowany przed wywołaniem metody MediaManager.onNewIntent()
(zalecamy użycie metody Activity lub Application onCreate()
).
class MyActivity : Activity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) val mediaManager = CastReceiverContext.getInstance().getMediaManager() mediaManager.setMediaLoadCommandCallback(MyMediaLoadCommandCallback()) } } class MyMediaLoadCommandCallback : MediaLoadCommandCallback() { override fun onLoad( senderId: String?, loadRequestData: MediaLoadRequestData ): Task{ return Tasks.call { // Resolve the entity into your data structure and load media. val mediaInfo = loadRequestData.getMediaInfo() if (!checkMediaInfoSupported(mediaInfo)) { // Throw MediaException to indicate load failure. throw MediaException( MediaError.Builder() .setDetailedErrorCode(DetailedErrorCode.LOAD_FAILED) .setReason(MediaError.ERROR_REASON_INVALID_REQUEST) .build() ) } myFillMediaInfo(MediaInfoWriter(mediaInfo)) myPlayerLoad(mediaInfo.getContentUrl()) // Update media metadata and state (this clears all previous status // overrides). castReceiverContext.getMediaManager() .setDataFromLoad(loadRequestData) ... castReceiverContext.getMediaManager().broadcastMediaStatus() // Return the resolved MediaLoadRequestData to indicate load success. return loadRequestData } } private fun myPlayerLoad(contentURL: String) { myPlayer.load(contentURL) // Update the MediaSession state. val playbackState: PlaybackStateCompat = Builder() .setState( player.getState(), player.getPosition(), System.currentTimeMillis() ) ... .build() mediaSession.setPlaybackState(playbackState) }
public class MyActivity extends Activity { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); MediaManager mediaManager = CastReceiverContext.getInstance().getMediaManager(); mediaManager.setMediaLoadCommandCallback(new MyMediaLoadCommandCallback()); } } public class MyMediaLoadCommandCallback extends MediaLoadCommandCallback { @Override public TaskonLoad(String senderId, MediaLoadRequestData loadRequestData) { return Tasks.call(() -> { // Resolve the entity into your data structure and load media. MediaInfo mediaInfo = loadRequestData.getMediaInfo(); if (!checkMediaInfoSupported(mediaInfo)) { // Throw MediaException to indicate load failure. throw new MediaException( new MediaError.Builder() .setDetailedErrorCode(DetailedErrorCode.LOAD_FAILED) .setReason(MediaError.ERROR_REASON_INVALID_REQUEST) .build()); } myFillMediaInfo(new MediaInfoWriter(mediaInfo)); myPlayerLoad(mediaInfo.getContentUrl()); // Update media metadata and state (this clears all previous status // overrides). castReceiverContext.getMediaManager() .setDataFromLoad(loadRequestData); ... castReceiverContext.getMediaManager().broadcastMediaStatus(); // Return the resolved MediaLoadRequestData to indicate load success. return loadRequestData; }); } private void myPlayerLoad(String contentURL) { myPlayer.load(contentURL); // Update the MediaSession state. PlaybackStateCompat playbackState = new PlaybackStateCompat.Builder() .setState( player.getState(), player.getPosition(), System.currentTimeMillis()) ... .build(); mediaSession.setPlaybackState(playbackState); }
Aby przetworzyć intencję wczytania, możesz ją przeanalizować w definiowanych przez siebie strukturach danych (MediaLoadRequestData
w przypadku żądań wczytania).
Obsługa poleceń dotyczących multimediów
Podstawowe sterowanie odtwarzaniem
Podstawowe polecenia integracji obejmują polecenia zgodne z sesją multimediów. Te polecenia są powiadamiane za pomocą wywołań zwrotnych sesji multimediów. Aby to umożliwić, musisz zarejestrować wywołanie zwrotne sesji multimediów (być może już to robisz).
private class MyMediaSessionCallback : MediaSessionCompat.Callback() { override fun onPause() { // Pause the player and update the play state. myPlayer.pause() } override fun onPlay() { // Resume the player and update the play state. myPlayer.play() } override fun onSeekTo(pos: Long) { // Seek and update the play state. myPlayer.seekTo(pos) } ... } mediaSession.setCallback(MyMediaSessionCallback())
private class MyMediaSessionCallback extends MediaSessionCompat.Callback { @Override public void onPause() { // Pause the player and update the play state. myPlayer.pause(); } @Override public void onPlay() { // Resume the player and update the play state. myPlayer.play(); } @Override public void onSeekTo(long pos) { // Seek and update the play state. myPlayer.seekTo(pos); } ... } mediaSession.setCallback(new MyMediaSessionCallback());
Obsługa poleceń sterowania przesyłaniem
Niektóre polecenia przesyłania nie są dostępne w MediaSession
, na przykład skipAd()
lub setActiveMediaTracks()
.
Tutaj należy też zaimplementować niektóre polecenia kolejki, ponieważ kolejka Cast nie jest w pełni zgodna z koleją MediaSession
.
class MyMediaCommandCallback : MediaCommandCallback() { override fun onSkipAd(requestData: RequestData?): Task<Void?> { // Skip your ad ... return Tasks.forResult(null) } } val mediaManager = CastReceiverContext.getInstance().getMediaManager() mediaManager.setMediaCommandCallback(MyMediaCommandCallback())
public class MyMediaCommandCallback extends MediaCommandCallback { @Override public TaskonSkipAd(RequestData requestData) { // Skip your ad ... return Tasks.forResult(null); } } MediaManager mediaManager = CastReceiverContext.getInstance().getMediaManager(); mediaManager.setMediaCommandCallback(new MyMediaCommandCallback());
Określanie obsługiwanych poleceń dotyczących multimediów
Podobnie jak w przypadku odbiornika przesyłania, aplikacja na Androida TV powinna określać, które komendy są obsługiwane, aby nadawcy mogli włączać lub wyłączać określone elementy sterujące w interfejsie. W przypadku poleceń, które są częścią MediaSession
, określ je w PlaybackStateCompat
.
Dodatkowe polecenia należy podać w polu MediaStatusModifier
.
// Set media session supported commands val playbackState: PlaybackStateCompat = PlaybackStateCompat.Builder() .setActions(PlaybackStateCompat.ACTION_PLAY or PlaybackStateCompat.ACTION_PAUSE) .setState(PlaybackStateCompat.STATE_PLAYING) .build() mediaSession.setPlaybackState(playbackState) // Set additional commands in MediaStatusModifier val mediaManager = CastReceiverContext.getInstance().getMediaManager() mediaManager.getMediaStatusModifier() .setMediaCommandSupported(MediaStatus.COMMAND_QUEUE_NEXT)
// Set media session supported commands PlaybackStateCompat playbackState = new PlaybackStateCompat.Builder() .setActions(PlaybackStateCompat.ACTION_PLAY | PlaybackStateCompat.ACTION_PAUSE) .setState(PlaybackStateCompat.STATE_PLAYING) .build(); mediaSession.setPlaybackState(playbackState); // Set additional commands in MediaStatusModifier MediaManager mediaManager = CastReceiverContext.getInstance().getMediaManager(); mediaManager.getMediaStatusModifier() .setMediaCommandSupported(MediaStatus.COMMAND_QUEUE_NEXT);
Ukrywanie nieobsługiwanych przycisków
Jeśli aplikacja Android TV obsługuje tylko podstawowe funkcje sterowania multimediami, a aplikacja Web Receiver obsługuje funkcje bardziej zaawansowane, sprawdź, czy aplikacja nadawcza działa prawidłowo podczas przesyłania treści do aplikacji Android TV. Jeśli na przykład aplikacja Android TV nie obsługuje zmiany szybkości odtwarzania, a aplikacja Web Receiver obsługuje tę funkcję, prawidłowo skonfiguruj obsługiwane działania na każdej platformie i upewnij się, że aplikacja nadawcza poprawnie renderuje interfejs użytkownika.
Zmiana stanu multimediów
Aby obsługiwać zaawansowane funkcje, takie jak ścieżki, reklamy, transmisje na żywo i kolejkowanie, aplikacja Android TV musi udostępniać dodatkowe informacje, których nie można uzyskać za pomocą MediaSession
.
Aby Ci to ułatwić, udostępniamy zajęcia MediaStatusModifier
. MediaStatusModifier
będzie zawsze działać na podstawie MediaSession
ustawionego w CastReceiverContext
.
Aby utworzyć i przesłać
MediaStatus
:
val mediaManager: MediaManager = castReceiverContext.getMediaManager() val statusModifier: MediaStatusModifier = mediaManager.getMediaStatusModifier() statusModifier .setLiveSeekableRange(seekableRange) .setAdBreakStatus(adBreakStatus) .setCustomData(customData) mediaManager.broadcastMediaStatus()
MediaManager mediaManager = castReceiverContext.getMediaManager(); MediaStatusModifier statusModifier = mediaManager.getMediaStatusModifier(); statusModifier .setLiveSeekableRange(seekableRange) .setAdBreakStatus(adBreakStatus) .setCustomData(customData); mediaManager.broadcastMediaStatus();
Nasza biblioteka klienta otrzyma podstawową wartość MediaStatus
z MediaSession
, a Twoja aplikacja na Androida TV może określić dodatkowy stan i zastąpić stan za pomocą modyfikatora MediaStatus
.
Niektóre stany i metadane można ustawić zarówno w MediaSession
, jak i MediaStatusModifier
. Zdecydowanie zalecamy ich konfigurowanie tylko w pliku MediaSession
. Nadal możesz używać modyfikatora, aby zastąpić stany w MediaSession
. Nie jest to jednak zalecane, ponieważ stan w modyfikatorze ma zawsze wyższy priorytet niż wartości podane w MediaSession
.
Przechwytywanie MediaStatus przed wysłaniem
Podobnie jak w przypadku pakietu SDK Web Receiver, jeśli chcesz wprowadzić drobne poprawki przed wysłaniem, możesz określić parametr MediaStatusInterceptor
, aby przetworzyć MediaStatus
, który ma zostać wysłany. Przekazujemy MediaStatusWriter
, aby zmodyfikować MediaStatus
przed wysłaniem.
mediaManager.setMediaStatusInterceptor(object : MediaStatusInterceptor { override fun intercept(mediaStatusWriter: MediaStatusWriter) { // Perform customization. mediaStatusWriter.setCustomData(JSONObject("{data: \"my Hello\"}")) } })
mediaManager.setMediaStatusInterceptor(new MediaStatusInterceptor() { @Override public void intercept(MediaStatusWriter mediaStatusWriter) { // Perform customization. mediaStatusWriter.setCustomData(new JSONObject("{data: \"my Hello\"}")); } });
Zarządzanie danymi logowania użytkowników
Aplikacja na Androida TV może zezwalać tylko niektórym użytkownikom na uruchamianie sesji aplikacji lub dołączanie do niej. Możesz na przykład zezwolić nadawcy na uruchomienie lub dołączenie tylko wtedy, gdy:
- Aplikacja nadawcy jest zalogowana na to samo konto i profil co aplikacja ATV.
- Aplikacja nadawcy jest zalogowana na to samo konto, ale inny profil niż aplikacja na ATV.
Jeśli Twoja aplikacja może obsługiwać wielu użytkowników lub użytkowników anonimowych, możesz zezwolić dowolnemu użytkownikowi na dołączenie do sesji ATV. Jeśli użytkownik poda dane logowania, Twoja aplikacja ATV musi je obsługiwać, aby można było prawidłowo śledzić postępy użytkownika i inne dane.
Gdy aplikacja nadawcy uruchamia lub dołącza do aplikacji na Android TV, powinna przekazać dane logowania, które wskazują, kto dołącza do sesji.
Zanim nadawca uruchomi i dołączy do aplikacji na Androida TV, możesz określić sprawdzacz uruchomienia, aby sprawdzić, czy dane uwierzytelniające nadawcy są dozwolone. W przeciwnym razie SDK Cast Connect uruchamia odbiornik internetowy.
Dane logowania do aplikacji nadawcy
Po stronie nadawcy możesz określić CredentialsData
, aby wskazać, kto dołącza do sesji.
Wartość credentials
to ciąg znaków, który może być zdefiniowany przez użytkownika, o ile tylko aplikacja ATV potrafi go odczytać. Wartość credentialsType
określa, z której platformy pochodzi wartość CredentialsData
. Może to być też wartość niestandardowa. Domyślnie jest ona ustawiona na platformę, z której jest wysyłana.
Wartość CredentialsData
jest przekazywana do aplikacji na Androida TV tylko podczas uruchamiania lub łączenia. Jeśli ustawisz go ponownie podczas połączenia, nie zostanie on przekazany do aplikacji Android TV. Jeśli nadawca przełączy profil podczas połączenia, możesz pozostać w sesji lub zadzwonić do SessionManager.endCurrentCastSession(boolean stopCasting)
, jeśli uważasz, że nowy profil jest niezgodny z sesją.
Wartość
CredentialsData
dla każdego nadawcy można pobrać za pomocą
getSenders
na
CastReceiverContext
w celu uzyskania wartości SenderInfo
,
getCastLaunchRequest()
w celu uzyskania wartości
CastLaunchRequest
,
a następnie
getCredentialsData()
.
Wymaga wersji play-services-cast-framework
19.0.0
lub nowszej.
CastContext.getSharedInstance().setLaunchCredentialsData( CredentialsData.Builder() .setCredentials("{\"userId\": \"abc\"}") .build() )
CastContext.getSharedInstance().setLaunchCredentialsData( new CredentialsData.Builder() .setCredentials("{\"userId\": \"abc\"}") .build());
Wymagana jest usługa google-cast-sdk
w wersji v4.8.3
lub nowszej.
Po ustawieniu opcji można do niego zadzwonić w dowolnym momencie:GCKCastContext.setSharedInstanceWith(options)
.
GCKCastContext.sharedInstance().setLaunch( GCKCredentialsData(credentials: "{\"userId\": \"abc\"}")
Wymagana jest przeglądarka Chromium w wersjiM87
lub nowszej.
Po ustawieniu opcji można do niego zadzwonić w każdej chwili:
cast.framework.CastContext.getInstance().setOptions(options);
.
let credentialsData = new chrome.cast.CredentialsData("{\"userId\": \"abc\"}"); cast.framework.CastContext.getInstance().setLaunchCredentialsData(credentialsData);
Implementacja sprawdzania prośby o uruchomienie ATV
Wartość CredentialsData
jest przekazywana do aplikacji na Androida TV, gdy nadawca próbuje uruchomić lub dołączyć. Możesz wdrożyć LaunchRequestChecker
.
, aby zatwierdzić lub odrzucić tę prośbę.
Jeśli żądanie zostanie odrzucone, zamiast uruchamiania aplikacji ATV natywnie zostanie załadowany odbiornik internetowy. Jeśli urządzenie ATV nie może obsłużyć żądania użytkownika dotyczącego uruchomienia lub dołączenia, odrzuć żądanie. Może się tak zdarzyć, gdy inny użytkownik jest zalogowany w aplikacji ATV niż ten, który wysyła żądanie, a Twoja aplikacja nie może obsługiwać przełączania danych logowania, lub gdy w aplikacji ATV nie ma aktualnie zalogowanego użytkownika.
Jeśli żądanie zostanie zaakceptowane, uruchomi się aplikacja ATV. Możesz dostosować to zachowanie w zależności od tego, czy Twoja aplikacja obsługuje wysyłanie żądań wczytywania, gdy użytkownik nie jest zalogowany w aplikacji ATV lub gdy występuje niezgodność użytkownika. To zachowanie można w pełni dostosować w LaunchRequestChecker
.
Utwórz klasę, która implementuje interfejs CastReceiverOptions.LaunchRequestChecker
:
class MyLaunchRequestChecker : LaunchRequestChecker { override fun checkLaunchRequestSupported(launchRequest: CastLaunchRequest): Task{ return Tasks.call { myCheckLaunchRequest( launchRequest ) } } } private fun myCheckLaunchRequest(launchRequest: CastLaunchRequest): Boolean { val credentialsData = launchRequest.getCredentialsData() ?: return false // or true if you allow anonymous users to join. // The request comes from a mobile device, e.g. checking user match. return if (credentialsData.credentialsType == CredentialsData.CREDENTIALS_TYPE_ANDROID) { myCheckMobileCredentialsAllowed(credentialsData.getCredentials()) } else false // Unrecognized credentials type. }
public class MyLaunchRequestChecker implements CastReceiverOptions.LaunchRequestChecker { @Override public TaskcheckLaunchRequestSupported(CastLaunchRequest launchRequest) { return Tasks.call(() -> myCheckLaunchRequest(launchRequest)); } } private boolean myCheckLaunchRequest(CastLaunchRequest launchRequest) { CredentialsData credentialsData = launchRequest.getCredentialsData(); if (credentialsData == null) { return false; // or true if you allow anonymous users to join. } // The request comes from a mobile device, e.g. checking user match. if (credentialsData.getCredentialsType().equals(CredentialsData.CREDENTIALS_TYPE_ANDROID)) { return myCheckMobileCredentialsAllowed(credentialsData.getCredentials()); } // Unrecognized credentials type. return false; }
Następnie ustaw je w ReceiverOptionsProvider
:
class MyReceiverOptionsProvider : ReceiverOptionsProvider { override fun getOptions(context: Context?): CastReceiverOptions { return CastReceiverOptions.Builder(context) ... .setLaunchRequestChecker(MyLaunchRequestChecker()) .build() } }
public class MyReceiverOptionsProvider implements ReceiverOptionsProvider { @Override public CastReceiverOptions getOptions(Context context) { return new CastReceiverOptions.Builder(context) ... .setLaunchRequestChecker(new MyLaunchRequestChecker()) .build(); } }
Rozwiązanie problemu true
w LaunchRequestChecker
uruchamia aplikację ATV, a false
uruchamia aplikację Web Receiver.
Wysyłanie i odbieranie wiadomości niestandardowych
Protokół Cast umożliwia wysyłanie niestandardowych wiadomości tekstowych między nadawcami a Twoją aplikacją odbiorczą. Przed zainicjowaniem CastReceiverContext
musisz zarejestrować przestrzeń nazw (kanał), aby wysyłać wiadomości.
Android TV – określ niestandardową przestrzeń nazw
Podczas konfiguracji musisz podać obsługiwane przestrzenie nazw w CastReceiverOptions
:
class MyReceiverOptionsProvider : ReceiverOptionsProvider { override fun getOptions(context: Context?): CastReceiverOptions { return CastReceiverOptions.Builder(context) .setCustomNamespaces( Arrays.asList("urn:x-cast:com.example.cast.mynamespace") ) .build() } }
public class MyReceiverOptionsProvider implements ReceiverOptionsProvider { @Override public CastReceiverOptions getOptions(Context context) { return new CastReceiverOptions.Builder(context) .setCustomNamespaces( Arrays.asList("urn:x-cast:com.example.cast.mynamespace")) .build(); } }
Android TV – wysyłanie wiadomości
// If senderId is null, then the message is broadcasted to all senders. CastReceiverContext.getInstance().sendMessage( "urn:x-cast:com.example.cast.mynamespace", senderId, customString)
// If senderId is null, then the message is broadcasted to all senders. CastReceiverContext.getInstance().sendMessage( "urn:x-cast:com.example.cast.mynamespace", senderId, customString);
Android TV – odbiór wiadomości w niestandardowej domenie
class MyCustomMessageListener : MessageReceivedListener { override fun onMessageReceived( namespace: String, senderId: String?, message: String ) { ... } } CastReceiverContext.getInstance().setMessageReceivedListener( "urn:x-cast:com.example.cast.mynamespace", new MyCustomMessageListener());
class MyCustomMessageListener implements CastReceiverContext.MessageReceivedListener { @Override public void onMessageReceived( String namespace, String senderId, String message) { ... } } CastReceiverContext.getInstance().setMessageReceivedListener( "urn:x-cast:com.example.cast.mynamespace", new MyCustomMessageListener());