Ajouter des fonctionnalités avancées à votre application Android

Coupures publicitaires

Le SDK Sender Android est compatible avec les breaks publicitaires et les annonces associées dans un flux multimédia donné.

Pour en savoir plus sur le fonctionnement des pauses publicitaires, consultez la présentation des pauses publicitaires Web Receiver.

Bien que les pauses puissent être spécifiées à la fois sur l'émetteur et le récepteur, il est recommandé de les spécifier sur le Web Receiver et le récepteur Android TV pour maintenir un comportement cohérent sur toutes les plates-formes.

Sur Android, spécifiez les pauses publicitaires dans une commande de chargement à l'aide de AdBreakClipInfo et AdBreakInfo :

Kotlin
val breakClip1: AdBreakClipInfo =
    AdBreakClipInfo.Builder("bc0")
        .setTitle("Clip title")
        .setPosterUrl("https://www.some.url")
        .setDuration(60000)
        .setWhenSkippableInMs(5000)  // Set this field so that the ad is skippable
        .build()

val breakClip2: AdBreakClipInfo = …
val breakClip3: AdBreakClipInfo = …

val break1: AdBreakClipInfo =
    AdBreakInfo.Builder(/* playbackPositionInMs= */ 10000)
        .setId("b0")
        .setBreakClipIds({"bc0","bc1","bc2"})
        …
        .build()

val mediaInfo: MediaInfo = MediaInfo.Builder()
    …
    .setAdBreaks({break1})
    .setAdBreakClips({breakClip1, breakClip2, breakClip3})
    .build()

val mediaLoadRequestData: MediaLoadRequestData = MediaInfo.Builder()
    …
    .setMediaInfo(mediaInfo)
    .build()

remoteMediaClient.load(mediaLoadRequestData)
Java
AdBreakClipInfo breakClip1 =
    new AdBreakClipInfo.Builder("bc0")
        .setTitle("Clip title")
        .setPosterUrl("https://www.some.url")
        .setDuration(60000)
        .setWhenSkippableInMs(5000)  // Set this field so that the ad is skippable
        .build();

AdBreakClipInfo breakClip2 = …
AdBreakClipInfo breakClip3 = …

AdBreakInfo break1 =
    new AdBreakInfo.Builder(/* playbackPositionInMs= */ 10000)
        .setId("b0")
        .setBreakClipIds({"bc0","bc1","bc2"})
        …
        .build();

MediaInfo mediaInfo = new MediaInfo.Builder()
    …
    .setAdBreaks({break1})
    .setAdBreakClips({breakClip1, breakClip2, breakClip3})
    .build();

MediaLoadRequestData mediaLoadRequestData = new MediaInfo.Builder()
    …
    .setMediaInfo(mediaInfo)
    .build();

remoteMediaClient.load(mediaLoadRequestData);

Ajouter des actions personnalisées

Une application émettrice peut étendre MediaIntentReceiver pour gérer des actions personnalisées ou remplacer son comportement. Si vous avez implémenté votre propre MediaIntentReceiver, vous devez l'ajouter au fichier manifeste et définir son nom dans CastMediaOptions. Cet exemple fournit des actions personnalisées qui remplacent l'activation/la désactivation de la lecture de contenus multimédias à distance, l'appui sur le bouton multimédia et d'autres types d'actions.

// In AndroidManifest.xml
<receiver android:name="com.example.MyMediaIntentReceiver" />
Kotlin
// In your OptionsProvider
var mediaOptions = CastMediaOptions.Builder()
    .setMediaIntentReceiverClassName(MyMediaIntentReceiver::class.java.name)
    .build()

// Implementation of MyMediaIntentReceiver
internal class MyMediaIntentReceiver : MediaIntentReceiver() {
    override fun onReceiveActionTogglePlayback(currentSession: Session) {
    }

    override fun onReceiveActionMediaButton(currentSession: Session, intent: Intent) {
    }

    override fun onReceiveOtherAction(context: Context?, action: String, intent: Intent) {
    }
}
Java
// In your OptionsProvider
CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
        .setMediaIntentReceiverClassName(MyMediaIntentReceiver.class.getName())
        .build();

// Implementation of MyMediaIntentReceiver
class MyMediaIntentReceiver extends MediaIntentReceiver {
    @Override
    protected void onReceiveActionTogglePlayback(Session currentSession) {
    }

    @Override
    protected void onReceiveActionMediaButton(Session currentSession, Intent intent) {
    }

    @Override
    protected void onReceiveOtherAction(Context context, String action, Intent intent) {
    }
}

Ajouter une chaîne personnalisée

Pour que l'application émettrice communique avec l'application réceptrice, votre application doit créer un canal personnalisé. L'expéditeur peut utiliser le canal personnalisé pour envoyer des messages de chaîne au destinataire. Chaque canal personnalisé est défini par un espace de noms unique et doit commencer par le préfixe urn:x-cast:, par exemple urn:x-cast:com.example.custom. Il est possible d'avoir plusieurs canaux personnalisés, chacun avec un espace de noms unique. L'application réceptrice peut également envoyer et recevoir des messages à l'aide du même espace de noms.

Le canal personnalisé est implémenté avec l'interface Cast.MessageReceivedCallback :

Kotlin
class HelloWorldChannel : MessageReceivedCallback {
    val namespace: String
        get() = "urn:x-cast:com.example.custom"

    override fun onMessageReceived(castDevice: CastDevice, namespace: String, message: String) {
        Log.d(TAG, "onMessageReceived: $message")
    }
}
Java
class HelloWorldChannel implements Cast.MessageReceivedCallback {
    public String getNamespace() {
        return "urn:x-cast:com.example.custom";
    }
    @Override
    public void onMessageReceived(CastDevice castDevice, String namespace, String message) {
        Log.d(TAG, "onMessageReceived: " + message);
    }
}

Une fois l'application émettrice connectée à l'application réceptrice, le canal personnalisé peut être créé à l'aide de la méthode setMessageReceivedCallbacks :

Kotlin
try {
    mCastSession.setMessageReceivedCallbacks(
        mHelloWorldChannel.namespace,
        mHelloWorldChannel)
} catch (e: IOException) {
    Log.e(TAG, "Exception while creating channel", e)
}
Java
try {
    mCastSession.setMessageReceivedCallbacks(
            mHelloWorldChannel.getNamespace(),
            mHelloWorldChannel);
} catch (IOException e) {
    Log.e(TAG, "Exception while creating channel", e);
}

Une fois le canal personnalisé créé, l'expéditeur peut utiliser la méthode sendMessage pour envoyer des messages de chaîne au destinataire sur ce canal :

Kotlin
private fun sendMessage(message: String) {
    if (mHelloWorldChannel != null) {
        try {
            mCastSession.sendMessage(mHelloWorldChannel.namespace, message)
                .setResultCallback { status ->
                    if (!status.isSuccess) {
                        Log.e(TAG, "Sending message failed")
                    }
                }
        } catch (e: Exception) {
            Log.e(TAG, "Exception while sending message", e)
        }
    }
}
Java
private void sendMessage(String message) {
    if (mHelloWorldChannel != null) {
        try {
            mCastSession.sendMessage(mHelloWorldChannel.getNamespace(), message)
                .setResultCallback( status -> {
                    if (!status.isSuccess()) {
                        Log.e(TAG, "Sending message failed");
                    }
                });
        } catch (Exception e) {
            Log.e(TAG, "Exception while sending message", e);
        }
    }
}

Prise en charge de la lecture automatique

Consultez la section API de lecture automatique et de mise en file d'attente.

Remplacer la sélection d'images pour les widgets d'expérience utilisateur

Différents composants du framework (à savoir la boîte de dialogue Cast, le lecteur multimédia réduit et l'UIMediaController, le cas échéant) affichent les illustrations du contenu multimédia en cours de diffusion. Les URL des illustrations sont généralement incluses dans le MediaMetadata du contenu multimédia, mais l'application émettrice peut disposer d'une autre source pour les URL.

La classe ImagePicker définit un moyen de sélectionner une image appropriée dans la liste des images d'un MediaMetadata, en fonction de l'utilisation de l'image (par exemple, vignette de notification ou arrière-plan en plein écran). L'implémentation ImagePicker par défaut choisit toujours la première image ou renvoie la valeur "null" si aucune image n'est disponible dans MediaMetadata. Votre application peut créer une sous-classe de ImagePicker et remplacer la méthode onPickImage(MediaMetadata, ImageHints) pour fournir une autre implémentation, puis sélectionner cette sous-classe avec la méthode setImagePicker de CastMediaOptions.Builder. ImageHints fournit des indications à un ImagePicker sur le type et la taille d'une image à sélectionner pour l'affichage dans l'UI.

Personnaliser les boîtes de dialogue Cast

Gérer le cycle de vie des sessions

SessionManager est l'emplacement central pour gérer le cycle de vie des sessions. SessionManager écoute les changements d'état de la sélection d'itinéraire MediaRouter d'Android pour démarrer, reprendre et terminer les sessions. Lorsqu'un itinéraire est sélectionné, SessionManager crée un objet Session et tente de le démarrer ou de le reprendre. Lorsqu'un itinéraire est désélectionné, SessionManager met fin à la session en cours.

Par conséquent, pour vous assurer que SessionManager gère correctement les cycles de vie des sessions, vous devez vous assurer que :

Selon la façon dont vous créez les boîtes de dialogue Cast, des actions supplémentaires peuvent être nécessaires :

État sans appareils

Si vous créez des boîtes de dialogue Cast personnalisées, votre MediaRouteChooserDialog personnalisé doit gérer correctement le cas où aucun appareil n'est trouvé. La boîte de dialogue doit comporter des indicateurs permettant à vos utilisateurs de savoir clairement quand votre application tente toujours de trouver des appareils et quand la tentative de découverte n'est plus active.

Si vous utilisez le MediaRouteChooserDialog par défaut, l'état "aucun appareil" est déjà géré.

Étapes suivantes

Vous avez terminé d'ajouter des fonctionnalités à votre application émettrice Android. Vous pouvez maintenant créer une application émettrice pour une autre plate-forme (iOS ou Web), ou créer une application réceptrice Web.

Précédent
Sélecteur de sortie
Suivant
Intégration d'ExoPlayer