キュー

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

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

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

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

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

これらのメソッドを他のメディア ステータス メソッドと組み合わせて使用すると、キューのステータスとキュー内のアイテムに関する情報をアプリに通知できます。アプリは、レシーバーからのメディア ステータスの更新に加えて、RemoteMediaClient.Callback と MediaQueue.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 アルゴリズムを変更する)、キューからアイテムを削除する、キュー内のアイテムを並べ替えることができます。