Mise en file d'attente

Le framework Cast fournit des classes de mise en file d'attente qui permettent de créer des listes d'instances MediaQueueItem, qui peuvent être créées à partir d'instances MediaInfo telles que des flux vidéo ou audio, pour être diffusées de manière séquentielle sur le récepteur. Cette file d'attente d'éléments de contenu peut être modifiée, réorganisée, mise à jour, etc.

Le SDK du récepteur gère la file d'attente et répond aux opérations sur la file d'attente tant qu'elle contient au moins un élément actuellement actif (en cours de lecture ou mis en pause). Les expéditeurs peuvent rejoindre la session et ajouter des éléments à la file d'attente. Le récepteur maintient une session pour les éléments de la file d'attente jusqu'à ce que la lecture du dernier élément soit terminée, ou jusqu'à ce que l'émetteur arrête la lecture et mette fin à la session, ou jusqu'à ce qu'un émetteur charge une nouvelle file d'attente sur le récepteur. Par défaut, le récepteur ne conserve aucune information sur les files d'attente arrêtées. Une fois le dernier élément de la file d'attente terminé, la session multimédia se termine et la file d'attente disparaît.

Créer et charger des éléments de file d'attente multimédia

Un élément de la file d'attente multimédia est représenté dans le framework Cast sous la forme d'une instance MediaQueueItem. Lorsque vous créez un élément de file d'attente multimédia, si vous utilisez la bibliothèque du lecteur multimédia avec du contenu adaptatif, vous pouvez définir le temps de préchargement afin que le lecteur puisse commencer à mettre en mémoire tampon l'élément de la file d'attente multimédia avant que l'élément précédent de la file d'attente ne soit terminé. Si vous définissez l'attribut de lecture automatique de l'élément sur "true", le destinataire peut le lire automatiquement. Par exemple, vous pouvez utiliser un modèle de constructeur pour créer votre élément de file d'attente multimédia comme suit:

Kotlin
val queueItem: MediaQueueItem = MediaQueueItem.Builder(mediaInfo)
    .setAutoplay(true)
    .setPreloadTime(20.0)
    .build()
Java
MediaQueueItem queueItem = new MediaQueueItem.Builder(mediaInfo)
  .setAutoplay(true)
  .setPreloadTime(20)
  .build();

Chargez un tableau d'éléments de file d'attente multimédia dans la file d'attente à l'aide de la méthode queueLoad appropriée de RemoteMediaClient.

Recevoir des informations sur l'état de la file d'attente multimédia

Lorsque le récepteur charge un élément de file d'attente multimédia, il lui attribue un ID unique qui persiste pendant toute la durée de la session (et la durée de vie de la file d'attente). Votre application peut connaître l'état de la file d'attente en termes d'élément actuellement chargé (il peut ne pas être en cours de lecture), en cours de chargement ou préchargé. La classe MediaStatus fournit les informations d'état suivantes:

  • Méthode getPreloadedItemId() : si l'élément suivant a été préchargé, renvoie l'ID de l'élément préchargé.
  • Méthode getLoadingItemId() : renvoie l'ID de l'élément actuellement en cours de chargement (mais qui n'est pas actif dans la file d'attente) sur le récepteur.
  • Méthode getCurrentItemId() : renvoie l'ID de l'élément qui était actif dans la file d'attente (il n'est peut-être pas en cours de lecture) au moment du changement d'état du contenu multimédia.
  • Méthode getQueueItems() (obsolète, utilisez plutôt MediaQueue) : renvoie la liste des instances MediaQueueItem sous forme de liste non modifiable.

Votre application peut également obtenir la liste des éléments à l'aide de la classe MediaQueue. La classe est un modèle de données clairsemé de la file d'attente multimédia. Il conserve la liste des ID d'éléments dans la file d'attente, qui est automatiquement synchronisée avec le récepteur. MediaQueue ne conserve pas tous les MediaQueueItem, car cela utiliserait trop de mémoire lorsque la file d'attente est très longue. Au lieu de cela, il récupère les éléments à la demande et conserve une LruCache des éléments récemment consultés. Vous pouvez utiliser les méthodes suivantes pour accéder à la file d'attente multimédia:

  • Méthode getItemIds() : renvoie la liste de tous les ID d'éléments dans l'ordre.
  • Méthode getItemAtIndex() : renvoie l'élément mis en cache à un indice donné. Si l'élément n'est pas mis en cache, MediaQueue renvoie null et planifie la récupération de l'élément. Lorsque l'élément est extrait, MediaQueue.Callback#itemsUpdatedAtIndexes() est appelé, et l'appel de getItemAtIndex() avec le même ID renvoie l'élément.
  • fetchMoteItemsRelativeToIndex() est utilisé lorsque l'utilisateur fait défiler l'UI de la file d'attente vers le haut ou vers le bas, et que votre application souhaite extraire d'autres éléments du cloud.

Utilisez ces méthodes avec les autres méthodes d'état des contenus multimédias pour informer votre application de l'état de la file d'attente et des éléments de la file d'attente. En plus des mises à jour de l'état des médias du récepteur, votre application peut écouter les modifications apportées à la file d'attente en implémentant RemoteMediaClient.Callback et MediaQueue.Callback.

Le SDK Cast fournit également deux classes utilitaires pour créer une UI de mise en file d'attente.

Par exemple, pour créer un RecyclerView à l'aide de MediaQueueRecyclerViewAdapter:

Kotlin
class MyRecyclerViewAdapter(mediaQueue: MediaQueue?) :
    MediaQueueRecyclerViewAdapter<MyViewHolder?>(mediaQueue) {
    override fun onBindViewHolder(holder: MyViewHolder, position: Int) {
        val item = getItem(position)

        // Update the view using `item`.
        ...
    }
}

class MyViewHolder : RecyclerView.ViewHolder {
    // Implement your own ViewHolder.
    ...
}

fun someMethod() {
    val adapter = MyRecyclerViewAdapter(
        mCastSession.remoteMediaClient.getMediaQueue())
    val recyclerView =
        activity.findViewById(R.id.my_recycler_view_id) as RecyclerView
    recyclerView.adapter = adapter
}
Java
public class MyRecyclerViewAdapter extends MediaQueueRecyclerViewAdapter<MyViewHolder> {
    public MyRecyclerViewAdapter(MediaQueue mediaQueue) {
        super(mediaQueue);
    }

    @Override
    public void onBindViewHolder(MyViewHolder holder, int position) {
      MediaQueueItem item = getItem(position);

      // Update the view using `item`.
      ...
    }
}

public class MyViewHolder implements RecyclerView.ViewHolder {
  // Implement your own ViewHolder.
  ...
}

public void someMethod() {
    RecyclerView.Adapter adapter = new MyRecyclerViewAdapter(
        mCastSession.getRemoteMediaClient().getMediaQueue());
    RecyclerView recyclerView =
        (RecyclerView) getActivity().findViewById(R.id.my_recycler_view_id);
    recyclerView.setAdapter(adapter);
}

Modifier la file d'attente

Pour effectuer des opérations sur les éléments de la file d'attente, utilisez les méthodes de file d'attente de la classe RemoteMediaClient. Ils vous permettent de charger un tableau d'éléments dans une nouvelle file d'attente, d'insérer des éléments dans une file d'attente existante, de mettre à jour les propriétés des éléments de la file d'attente, de faire sauter un élément vers l'avant ou vers l'arrière dans la file d'attente, de définir les propriétés de la file d'attente elle-même (par exemple, modifier l'algorithme repeatMode qui sélectionne l'élément suivant), de supprimer des éléments de la file d'attente et de réorganiser les éléments de la file d'attente.