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

Activity にはデフォルトで、字幕ボタン、前のアイテムボタンへのスキップ、次のアイテムボタンへのスキップ、この 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);
        ...
    }
}