キャスト ウィジェットをカスタマイズするには、色の設定、ボタン、テキスト、サムネイルの外観のスタイル設定、表示するボタンの種類の選択を行います。
アプリのテーマをカスタマイズする
この例では、カスタムテーマ スタイル 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
には、アルバムアートと 2 つのボタンを表示できる 3 つのスロットがあり、アルバムアートが入力されていない場合は 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 にはないカスタム コントロール ボタンの追加をサポートします。ステップは次のとおりです。
MiniControllerFragment
のcastControlButtons
属性で@id/cast_button_type_custom
を使用して、カスタムボタンを格納するスロットを指定します。UIController
のサブクラスを実装します。UIController
には、キャスト セッションまたはメディア セッションの状態が変更されたときに SDK によって呼び出されるメソッドが含まれます。UIController
のサブクラスは、ImageView
をパラメータとして受け取り、必要に応じてその状態を更新する必要があります。MiniControllerFragment
をサブクラス化してから、onCreateView
をオーバーライドし、getButtonImageViewAt(int)
を呼び出して、そのカスタムボタンのImageView
を取得します。次に、bindViewToUIController(View, UIController)
を呼び出して、ビューをカスタムUIController
に関連付けます。カスタムボタンからアクションを処理する方法については、カスタム アクションの追加の
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>
// 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) ... } }
// 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>
ボタンを選択する
拡張したコントローラの Activity には、コントロール ボタンを表示するスロットが 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 に用意されていないカスタム コントロール ボタン(「親指アップ」ボタンなど)を追加できます。ステップは次のとおりです。
ExpandedControllerActivity
のcastControlButtons
属性で@id/cast_button_type_custom
を使用して、カスタムボタンを格納するスロットを指定します。その後、getButtonImageViewAt(int)
を使用して、そのカスタムボタンのImageView
を取得できます。UIController
のサブクラスを実装します。UIController
には、キャスト セッションまたはメディア セッションの状態が変更されたときに SDK によって呼び出されるメソッドが含まれます。UIController
のサブクラスは、パラメータとしてImageView
を受け取り、必要に応じてその状態を更新する必要があります。サブクラスの ExpandedControllerActivity。次に、
onCreate
をオーバーライドし、getButtonImageViewAt(int)
を呼び出してボタンのビュー オブジェクトを取得します。次に、bindViewToUIController(View, UIController)
を呼び出して、ビューをカスタムUIController
に関連付けます。カスタムボタンからアクションを処理する方法については、カスタム アクションの追加の
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>
// 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) ... } }
// 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); ... } }