ミッドロール挿入点
Android Sender SDK は、特定のメディア ストリーム内のミッドロール挿入点とコンパニオン広告をサポートしています。
ミッドロール挿入点の仕組みについて詳しくは、Web Receiver のミッドロール挿入点の概要をご覧ください。
挿入点はセンダーとレシーバーの両方で指定できますが、プラットフォーム間で動作の一貫性を維持するため、Web Receiver と Android TV Receiver で指定することをおすすめします。
Android では、AdBreakClipInfo
と AdBreakInfo
を使用して、読み込みコマンドでミッドロール挿入点を指定します。
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)
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);
カスタム アクションを追加する
送信側アプリは、MediaIntentReceiver
を拡張してカスタム操作を処理したり、その動作をオーバーライドしたりできます。独自の MediaIntentReceiver
を実装している場合は、マニフェストに追加し、その名前を CastMediaOptions
に設定する必要があります。この例では、リモート メディア再生の切り替え、メディアボタンの押下などのアクションをオーバーライドするカスタム アクションを提供しています。
// In AndroidManifest.xml
<receiver android:name="com.example.MyMediaIntentReceiver" />
// 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) { } }
// 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) { } }
カスタム チャネルを追加
送信側アプリが受信側アプリと通信するには、カスタム チャネルを作成する必要があります。センダーはカスタム チャネルを使用して、レシーバに文字列メッセージを送信できます。各カスタム チャネルは一意の名前空間で定義され、接頭辞 urn:x-cast:
で始まる必要があります(例: urn:x-cast:com.example.custom
)。一意の名前空間を持つ複数のカスタム チャネルを作成できます。レシーバー アプリは、同じ名前空間を使用してメッセージを送受信することもできます。
カスタム チャネルは Cast.MessageReceivedCallback
インターフェースを使用して実装されます。
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") } }
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); } }
送信側アプリが受信側アプリに接続されると、setMessageReceivedCallbacks
メソッドを使用してカスタム チャネルを作成できます。
try { mCastSession.setMessageReceivedCallbacks( mHelloWorldChannel.namespace, mHelloWorldChannel) } catch (e: IOException) { Log.e(TAG, "Exception while creating channel", e) }
try { mCastSession.setMessageReceivedCallbacks( mHelloWorldChannel.getNamespace(), mHelloWorldChannel); } catch (IOException e) { Log.e(TAG, "Exception while creating channel", e); }
カスタム チャネルが作成されると、センダーは sendMessage
メソッドを使用して、そのチャネル経由でレシーバに文字列メッセージを送信できます。
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) } } }
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); } } }
自動再生のサポート
自動再生 API とキューイング API のセクションをご覧ください。
UX ウィジェットの画像選択をオーバーライドする
フレームワークのさまざまなコンポーネント(キャスト ダイアログ、ミニ コントローラ、UIMediaController(設定されている場合)など)が、現在キャストしているメディアのアートワークを表示します。画像アートワークへの URL は通常、メディアの MediaMetadata
に含まれますが、送信側アプリが URL の代替ソースを持っている場合もあります。
ImagePicker
クラスは、通知のサムネイルや全画面の背景など、画像の使用に基づいて、MediaMetadata
内の画像のリストから適切な画像を選択する手段を定義します。デフォルトの ImagePicker
実装は常に最初の画像を選択します。MediaMetadata
に使用可能な画像がない場合は null を返します。アプリは ImagePicker
をサブクラス化して onPickImage(MediaMetadata, ImageHints)
メソッドをオーバーライドし、代替の実装を提供し、CastMediaOptions.Builder
の setImagePicker
メソッドを使用してそのサブクラスを選択できます。ImageHints
は、UI に表示するために選択される画像のタイプとサイズに関するヒントを ImagePicker
に提供します。
キャスト ダイアログのカスタマイズ
SessionManager
は、セッションのライフサイクルを管理する場所です。SessionManager
は、Android MediaRouter
ルート選択状態の変化をリッスンして、セッションの開始、再開、終了を行います。ルートが選択されると、SessionManager
は Session
オブジェクトを作成し、その開始または再開を試みます。ルートを選択解除すると、SessionManager
は現在のセッションを終了します。
したがって、SessionManager
でセッション ライフサイクルを適切に管理するには、次のことを確認する必要があります。
- ルートセレクタ ダイアログで、ユーザーがデバイスを選択したときに
MediaRouter.selectRoute(MediaRouter.RouteInfo)
を呼び出します。 - ルート コントローラ ダイアログ(接続状態またはキャスト状態)で、ユーザーがキャストを停止したときに
MediaRouter.unselect(int)
を呼び出します。
キャスト ダイアログの作成方法によっては、追加の操作が必要になることがあります。
MediaRouteChooserDialog
とMediaRouteControllerDialog
を使用してキャスト ダイアログを作成すると、これらのダイアログによりMediaRouter
のルート選択が自動的に更新されるため、何もする必要はありません。CastButtonFactory.setUpMediaRouteButton(Context, Menu, int)
またはCastButtonFactory.setUpMediaRouteButton(Context, MediaRouteButton)
を使用してキャストボタンをセットアップした場合、ダイアログは実際にMediaRouteChooserDialog
とMediaRouteControllerDialog
を使用して作成されるため、何もする必要はありません。- それ以外の場合はカスタム キャスト ダイアログを作成するため、上記の手順に沿って
MediaRouter
のルート選択状態を更新する必要があります。
次のステップ
これで、Android Sender アプリに追加できる機能は終了です。これで、別のプラットフォーム(iOS または ウェブ)用の送信側アプリか、Web Receiver アプリを作成できるようになります。