キュー

Cast フレームワークには、MediaQueueItem インスタンスのリストの作成をサポートするキューイング クラスが用意されています。このリストは、動画や音声ストリームなどの MediaInfo インスタンスから作成でき、レシーバーで順番に再生できます。このコンテンツ アイテムのキューは、編集、並べ替え、更新などを行えます。

Receiver SDK はキューを維持し、キューに現在アクティブなアイテム(再生中または一時停止中)が 1 つ以上ある限り、キューに対するオペレーションに応答します。送信者はセッションに参加してキューにアイテムを追加できます。レシーバは、最後のアイテムの再生が完了するか、送信者が再生を停止してセッションを終了するか、送信者がレシーバに新しいキューを読み込むまで、キューアイテムのセッションを維持します。レシーバは、デフォルトでは終了したキューに関する情報を保持しません。キュー内の最後のアイテムが完了すると、メディア セッションが終了し、キューは消えます。

メディア キュー アイテムを作成して読み込む

メディア キュー アイテムは、Cast フレームワークで MediaQueueItem インスタンスとして表されます。メディア キュー アイテムを作成するときに、適応型コンテンツで Media Player Library を使用している場合は、プリロード時間を設定して、キュー内の先行アイテムの再生が終了する前に、プレーヤーがメディア キュー アイテムのバッファリングを開始できるようにします。アイテムの自動再生属性を true に設定すると、レシーバーで自動的に再生されます。たとえば、Builder パターンを使用して、次のようにメディア キュー アイテムを作成できます。

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();

RemoteMediaClient の適切な queueLoad メソッドを使用して、キュー内のメディア キューアイテムの配列を読み込みます。

メディア キューのステータスの最新情報を受け取る

レシーバーがメディア キュー アイテムを読み込むと、アイテムに一意の ID が割り当てられます。この ID はセッション中(およびキューの存続期間中)保持されます。アプリは、現在読み込まれているアイテム(再生されていない場合もあります)、読み込み中、プリロード済みのアイテムの観点からキューのステータスを把握できます。MediaStatus クラスは、次のステータス情報を提供します。

  • getPreloadedItemId() メソッド - 次のアイテムがプリロードされている場合は、プリロードされたアイテム ID を返します。
  • getLoadingItemId() メソッド - レシーバーで現在読み込み中(ただしキュー内でアクティブではない)アイテムのアイテム ID を返します。
  • getCurrentItemId() メソッド - メディアのステータスが変更された時点でキューでアクティブだったアイテムのアイテム ID を返します(再生中ではない可能性があります)。
  • getQueueItems()非推奨、代わりに MediaQueue を使用してください)メソッド - MediaQueueItem インスタンスのリストを変更不可のリストとして返します。

アプリでは、MediaQueue クラスを使用してアイテムのリストを取得することもできます。このクラスは、メディアキューのスパース データモデルです。アイテム ID のリストはキューに保持され、レシーバーと自動的に同期されます。キューが非常に長い場合、メモリを使いすぎるため、MediaQueue はすべての MediaQueueItem を保持しません。代わりに、アイテムはオンデマンドでフェッチされ、最近アクセスされたアイテムの LruCache が保持されます。メディアキューにアクセスするには、次の方法を使用します。

  • getItemIds()メソッド - すべてのアイテム ID のリストを順番に返します。
  • getItemAtIndex() メソッド - 指定されたインデックスのキャッシュに保存されているアイテムを返します。アイテムがキャッシュに保存されていない場合、MediaQueuenull を返して、アイテムの取得をスケジュールします。アイテムがフェッチされると、MediaQueue.Callback#itemsUpdatedAtIndexes() が呼び出され、同じ ID で getItemAtIndex() を再度呼び出すとアイテムが返されます。
  • fetchMoteItemsRelativeToIndex() は、ユーザーがキューの UI を上または下にスクロールし、アプリがクラウドからさらにアイテムを取得する場合に使用します。

これらのメソッドを他のメディア ステータス メソッドと組み合わせて使用することで、キューのステータスとキュー内のアイテムをアプリに通知できます。レシーバからのメディア ステータスの更新に加えて、アプリは RemoteMediaClient.CallbackMediaQueue.Callback を実装することで、キューの変更をリッスンできます。

また、Cast SDK には、キュー用の UI を作成する 2 つのユーティリティ クラスが用意されています。

たとえば、MediaQueueRecyclerViewAdapter を使用して RecyclerView を作成するには、次のようにします。

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);
}

キューを編集する

キュー内のアイテムを操作するには、RemoteMediaClient クラスのキュー メソッドを使用します。これにより、アイテムの配列を新しいキューに読み込む、既存のキューにアイテムを挿入する、キュー内のアイテムのプロパティを更新する、キュー内でアイテムを前後に移動する、キュー自体のプロパティを設定する(次のアイテムを選択する repeatMode アルゴリズムを変更するなど)、キューからアイテムを削除する、キュー内のアイテムを並べ替えることができます。