Android の送信者 UI をカスタマイズする

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

キャスト ウィジェットは、色の設定、ボタン、テキスト、サムネイルの外観、表示するボタンの種類を選択してカスタマイズできます。

アプリのテーマをカスタマイズする

この例では、カスタムカラー スタイル Theme.CastVideosTheme を作成します。これにより、カスタムカラー、導入オーバーレイ スタイル、ミニ コントローラ スタイル、拡張コントローラ スタイルを定義できます。

<style name="Theme.CastVideosTheme" parent="Theme.AppCompat.Light.NoActionBar">
    <!-- Set AppCompat's color theming attrs -->
    <item name="colorPrimary">@color/primary</item>
    <item name="colorPrimaryDark">@color/primary_dark</item>
    <item name="colorAccent">@color/accent</item>
    <item name="android:textColorPrimary">@color/primary_text</item>
    <item name="android:textColorSecondary">@color/secondary_text</item>
    <item name="castIntroOverlayStyle">@style/CustomCastIntroOverlay</item>
    <item name="castMiniControllerStyle">@style/CustomCastMiniController</item>
    <item name="castExpandedControllerStyle">@style/CustomCastExpandedController</item>
</style>

上記の最後の 3 行を使用すると、このテーマの一部として、紹介オーバーレイ、ミニ コントローラ、拡張コントローラに固有のスタイルを定義できます。以降のセクションで例を示します。

キャスト アイコンのカスタマイズ

カスタムの mediaRouteTheme をアプリのテーマに追加するには:

<style name="Theme.CastVideosTheme" parent="Theme.AppCompat.Light.NoActionBar">
  <!-- ... -->
  <item name="mediaRouteTheme">@style/CustomMediaRouterTheme</item>
</style>

カスタムの Media Router のテーマを宣言し、カスタムの mediaRouteButtonStyle を宣言します。

<style name="CustomMediaRouterTheme" parent="Theme.MediaRouter">
  <item name="mediaRouteButtonStyle">@style/CustomMediaRouteButtonStyle</item>
</style>

<style name="CustomMediaRouteButtonStyle" parent="Widget.MediaRouter.Light.MediaRouteButton">
  <item name="mediaRouteButtonTint">#EEFF41</item>
</style>

サポート ライブラリのバージョンが 26.0.0 より新しい場合は、setTint を使用する必要があります。古いサポート ライブラリ バージョンの場合は、代わりに buttonTint を使用してください。

紹介オーバーレイのテーマをカスタマイズする

IntroductoryOverlay クラスは、アプリがカスタムテーマでオーバーライドできるさまざまなスタイル属性をサポートしています。次の例は、オーバーレイ ウィジェット上でボタンとタイトルの両方のテキストの外観をオーバーライドする方法を示しています。

<style name="CustomCastIntroOverlay" parent="CastIntroOverlay">
    <item name="castButtonTextAppearance">@style/TextAppearance.CustomCastIntroOverlay.Button</item>
    <item name="castTitleTextAppearance">@style/TextAppearance.CustomCastIntroOverlay.Title</item>
</style>
<style name="TextAppearance.CustomCastIntroOverlay.Button" parent="android:style/TextAppearance">
    <item name="android:textColor">#FFFFFF</item>
</style>
<style name="TextAppearance.CustomCastIntroOverlay.Title"parent="android:style/TextAppearance.Large">
    <item name="android:textColor">#FFFFFF</item>
</style>

ミニ コントローラのカスタマイズ

テーマのカスタマイズ

MiniControllerFragment クラスは、アプリがカスタムテーマでオーバーライドできるさまざまなスタイル属性をサポートしています。この例では、サムネイル画像の表示を有効にして、小見出しと字幕の両方のテキストの外観をオーバーライドし、色を設定して、ボタンをカスタマイズしています。

<style name="CustomCastMiniController" parent="CastMiniController">
    <item name="castShowImageThumbnail">true</item>
    <item name="castTitleTextAppearance">@style/TextAppearance.AppCompat.Subhead</item>
    <item name="castSubtitleTextAppearance">@style/TextAppearance.AppCompat.Caption</item>
    <item name="castBackground">#FFFFFF</item>
    <item name="castProgressBarColor">#FFFFFF</item>
    <item name="castPlayButtonDrawable">@drawable/cast_ic_mini_controller_play</item>
    <item name="castPauseButtonDrawable">@drawable/cast_ic_mini_controller_pause</item>
    <item name="castStopButtonDrawable">@drawable/cast_ic_mini_controller_stop</item>
    <item name="castLargePlayButtonDrawable">@drawable/cast_ic_mini_controller_play_large</item>
    <item name="castLargePauseButtonDrawable">@drawable/cast_ic_mini_controller_pause_large</item>
    <item name="castLargeStopButtonDrawable">@drawable/cast_ic_mini_controller_stop_large</item>
    <item name="castSkipPreviousButtonDrawable">@drawable/cast_ic_mini_controller_skip_prev</item>
    <item name="castSkipNextButtonDrawable">@drawable/cast_ic_mini_controller_skip_next</item>
    <item name="castRewind30ButtonDrawable">@drawable/cast_ic_mini_controller_rewind30</item>
    <item name="castForward30ButtonDrawable">@drawable/cast_ic_mini_controller_forward30</item>
    <item name="castMuteToggleButtonDrawable">@drawable/cast_ic_mini_controller_mute</item>
    <item name="castClosedCaptionsButtonDrawable">@drawable/cast_ic_mini_controller_closed_caption</item
</style>

ボタンを選択

MiniControllerFragment には、アルバムアートを表示するための 3 つのスロットと、アルバムアートが入力されていない場合は 2 つのボタン、または 3 つのコントロール ボタンがあります。

SLOT  SLOT  SLOT
  1     2     3

デフォルトでは、フラグメントには再生/一時停止の切り替えボタンが表示されます。デベロッパーは、属性 castControlButtons を使用して、表示するボタンをオーバーライドできます。サポートされているコントロール ボタンは、ID リソースとして定義されています。

ボタンのタイプ 説明
@id/cast_button_type_empty このスロットにボタンを配置しないでください
@id/cast_button_type_custom カスタムボタン
@id/cast_button_type_play_pause_toggle 再生と一時停止を切り替えます
@id/cast_button_type_skip_previous キュー内の前のアイテムにスキップ
@id/cast_button_type_skip_next キュー内の次の項目にスキップします
@id/cast_button_type_rewind_30_seconds 再生を 30 秒巻き戻します
@id/cast_button_type_forward_30_seconds 再生を 30 秒早送りします
@id/cast_button_type_mute_toggle レシーバーのミュートとミュート解除
@id/cast_button_type_closed_caption テキスト トラックと音声トラックを選択するダイアログを開きます

以下に、アルバムアート、再生/一時停止切り替えボタン、スキップ進むボタンを左から右の順に並べた例を示します。

<array name="cast_mini_controller_control_buttons">
    <item>@id/cast_button_type_empty</item>
    <item>@id/cast_button_type_play_pause_toggle</item>
    <item>@id/cast_button_type_forward_30_seconds</item>
</array>
...
<fragment
    android:id="@+id/cast_mini_controller"
    ...
    app:castControlButtons="@array/cast_mini_controller_control_buttons"
    class="com.google.android.gms.cast.framework.media.widget.MiniControllerFragment">

警告: この配列にはアイテムを 3 つだけ含める必要があります。そうしないと、ランタイム例外がスローされます。スロットにボタンを表示しない場合は、@id/cast_button_type_empty を使用します。

カスタムボタンを追加する

MiniControllerFragment は、SDK で提供されていないカスタム操作ボタン(「高評価」ボタンなど)の追加をサポートしています。ステップは次のとおりです。

  1. MiniControllerFragmentcastControlButtons 属性で、@id/cast_button_type_custom を使用してカスタムボタンを格納するスロットを指定します。

  2. UIController のサブクラスを実装します。UIController には、キャスト セッションまたはメディア セッションの状態が変化したときに SDK によって呼び出されるメソッドが含まれています。UIController のサブクラスは、パラメータの 1 つとして ImageView を受け取り、必要に応じてその状態を更新する必要があります。

  3. MiniControllerFragment をサブクラス化し、onCreateView をオーバーライドして getButtonImageViewAt(int) を呼び出して、そのカスタムボタンの ImageView を取得します。次に、bindViewToUIController(View, UIController) を呼び出して、ビューをカスタム UIController に関連付けます。

  4. カスタムボタンからアクションを処理する方法については、カスタム アクションの追加MediaIntentReceiver をご覧ください。

    スロット 2 のボタンを MyCustomUIController という UIController に関連付ける例を次に示します。

// arrays.xml
<array name="cast_expanded_controller_control_buttons">
    <item>@id/cast_button_type_empty</item>
    <item>@id/cast_button_type_rewind_30_seconds</item>
    <item>@id/cast_button_type_custom</item>
    <item>@id/cast_button_type_empty</item>
</array>
Kotlin
// MyCustomUIController.kt
class MyCustomUIController(private val mView: View) : UIController() {
    override fun onMediaStatusUpdated() {
        // Update the state of mView based on the latest the media status.
        ...
        mView.visibility = View.INVISIBLE
        ...
    }
}

// MyMiniControllerFragment.kt
class MyMiniControllerFragment : MiniControllerFragment() {
    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        super.onCreateView(inflater, container, savedInstanceState)
        val customButtonView = getButtonImageViewAt(2)
        val myCustomUiController = MyCustomUIController(customButtonView)
        uiMediaController.bindViewToUIController(customButtonView, myCustomUiController)
        ...
    }
}
Java
// MyCustomUIController.java
class MyCustomUIController extends UIController {
    private final View mView;

    public MyCustomUIController(View view) {
            mView = view;
    }

    @Override
    public onMediaStatusUpdated() {
        // Update the state of mView based on the latest the media status.
        ...
        mView.setVisibility(View.INVISIBLE);
        ...
    }
}

// MyMiniControllerFragment.java
class MyMiniControllerFragment extends MiniControllerFragment {
    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
            Bundle savedInstanceState) {
        super.onCreateView(inflater, container, savedInstanceState);
        ImageView customButtonView = getButtonImageViewAt(2);
        MyCustomUIController myCustomUiController = new MyCustomUIController(customButtonView);
        getUIMediaController().bindViewToUIController(customButtonView, myCustomUiController);
        ...
    }
}

拡張コントローラをカスタマイズ

テーマのカスタマイズ

拡張コントローラのアクティビティでダークモードのツールバーを使用する場合は、ツールバーでテーマを設定して、ライトテキストとライトアイコンの色を使用できます。

<style name="Theme.CastVideosTheme" parent="Theme.AppCompat.Light.NoActionBar">
    <item name="castExpandedControllerToolbarStyle">
        @style/ThemeOverlay.AppCompat.Dark.ActionBar
    </item>
</style>

拡張コントローラ上のボタンの描画に使用する独自の画像を指定できます。

<style name="CustomCastExpandedController" parent="CastExpandedController">
    <item name="castButtonColor">@null</item>
    <item name="castPlayButtonDrawable">@drawable/cast_ic_expanded_controller_play</item>
    <item name="castPauseButtonDrawable">@drawable/cast_ic_expanded_controller_pause</item>
    <item name="castStopButtonDrawable">@drawable/cast_ic_expanded_controller_stop</item>
    <item name="castSkipPreviousButtonDrawable">@drawable/cast_ic_expanded_controller_skip_previous</item>
    <item name="castSkipNextButtonDrawable">@drawable/cast_ic_expanded_controller_skip_next</item>
    <item name="castRewind30ButtonDrawable">@drawable/cast_ic_expanded_controller_rewind30</item>
    <item name="castForward30ButtonDrawable">@drawable/cast_ic_expanded_controller_forward30</item>
</style>

ボタンを選択

コントローラを展開するアクティビティには、コントロール ボタンを表示するスロットが 5 つあります。中央のスロットには再生と一時停止の切り替えボタンが常に表示され、構成できません。他の 4 つのスロットは、送信者アプリによって、左から右に構成できます。

SLOT  SLOT  PLAY/PAUSE  SLOT  SLOT
  1     2     BUTTON      3     4

デフォルトでは、アクティビティにはクローズド キャプション ボタン、前のアイテムボタンへのスキップ、次のアイテムボタンへのスキップ、これらの 4 つのスロットのミュート切り替えボタンが左から右に表示されます。デベロッパーは、属性 castControlButtons を使用して、どのスロットに表示するボタンをオーバーライドするかを選択できます。サポートされているコントロール ボタンのリストは、ミニ コントローラ ボタンのボタンタイプと同じ ID リソースとして定義されます。

次の例では、2 つ目のスロットに巻き戻しボタンを配置し、3 つ目のスロットに早送りボタンを配置し、最初と最後のスロットを空のままにしています。

// arrays.xml
<array name="cast_expanded_controller_control_buttons">
    <item>@id/cast_button_type_empty</item>
    <item>@id/cast_button_type_rewind_30_seconds</item>
    <item>@id/cast_button_type_forward_30_seconds</item>
    <item>@id/cast_button_type_empty</item>
</array>
...
// styles.xml
<style name="Theme.MyTheme">
    <item name="castExpandedControllerStyle">
        @style/CustomCastExpandedController
    </item>
</style>
...
<style name="CustomCastExpandedController" parent="CastExpandedController">
    <item name="castControlButtons">
        @array/cast_expanded_controller_control_buttons
    </item>
</style>

配列にはアイテムを 4 つだけ含める必要があります。そうしないと、ランタイム例外がスローされます。スロットにボタンを表示しない場合は、@id/cast_button_type_empty を使用します。CastContext は、このアクティビティのライフサイクルと表示を管理できます。

カスタムボタンを追加する

ExpandedControllerActivity では、SDK で提供されていないカスタム コントロール ボタン(「高評価」ボタンなど)の追加がサポートされています。ステップは次のとおりです。

  1. ExpandedControllerActivitycastControlButtons 属性で、@id/cast_button_type_custom を使用してカスタムボタンを格納するスロットを指定します。その後、getButtonImageViewAt(int) を使用してそのカスタムボタンの ImageView を取得できます。

  2. UIController のサブクラスを実装します。UIController には、キャスト セッションまたはメディア セッションの状態が変化したときに SDK によって呼び出されるメソッドが含まれます。UIController のサブクラスは、パラメータとして ImageView を受け取り、必要に応じてその状態を更新する必要があります。

  3. ExpandedControllerActivity をサブクラス化し、onCreate をオーバーライドして getButtonImageViewAt(int) を呼び出してボタンのビュー オブジェクトを取得します。次に、bindViewToUIController(View, UIController) を呼び出して、ビューをカスタム UIController に関連付けます。

  4. カスタムボタンからアクションを処理する方法については、カスタム アクションの追加MediaIntentReceiver をご覧ください。

スロット 2 のボタンを MyCustomUIController という UIController に関連付ける例を次に示します。

// arrays.xml
<array name="cast_expanded_controller_control_buttons">
    <item>@id/cast_button_type_empty</item>
    <item>@id/cast_button_type_rewind_30_seconds</item>
    <item>@id/cast_button_type_custom</item>
    <item>@id/cast_button_type_empty</item>
</array>
Kotlin
// MyCustomUIController.kt
class MyCustomUIController(private val mView: View) : UIController() {
    override fun onMediaStatusUpdated() {
        // Update the state of mView based on the latest the media status.
        ...
        mView.visibility = View.INVISIBLE
        ...
    }
}

// MyExpandedControllerActivity.kt
internal class MyExpandedControllerActivity : ExpandedControllerActivity() {
    public override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val customButtonView = getButtonImageViewAt(2)
        val myCustomUiController = MyCustomUIController(customButtonView)
        uiMediaController.bindViewToUIController(customButtonView, myCustomUiController)
        ...
    }
}
Java
// MyCustomUIController.java
class MyCustomUIController extends UIController {
    private final View mView;

    public MyCustomUIController(View view) {
        mView = view;
    }

    @Override
    public onMediaStatusUpdated() {
        // Update the state of mView based on the latest the media status.
        ...
        mView.setVisibility(View.INVISIBLE);
        ...
    }
}

// MyExpandedControllerActivity.java
class MyExpandedControllerActivity extends ExpandedControllerActivity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ImageView customButtonView = getButtonImageViewAt(2);
        MyCustomUIController myCustomUiController = new MyCustomUIController(customButtonView);
        getUIMediaController().bindViewToUIController(customButtonView, myCustomUiController);
        ...
    }
}