キュー

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

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

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

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

val queueItem: MediaQueueItem = MediaQueueItem.Builder(mediaInfo)
    .setAutoplay(true)
    .setPreloadTime(20.0)
    .build()

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

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

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

• MediaQueueRecyclerViewAdapter、RecyclerView のデータをバックアップするため
• MediaQueueListAdapter: ListAdapter のデータをバックアップします。

たとえば、MediaQueueRecyclerViewAdapter を使用して RecyclerView を作成するには:

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
}

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 アルゴリズムを変更するなど）、キューからアイテムを削除したり、キュー内のアイテムの順序を変更したりできます。