將投放功能整合至 Android 應用程式

本開發人員指南說明如何使用 Android Sender SDK,為 Android 傳送端應用程式新增 Google Cast 支援。

行動裝置或筆記型電腦是控製播放內容的「傳送者」,Google Cast 裝置則是顯示在電視上內容的「接收器」

傳送者架構是指傳送端執行階段中呈現的 Cast 類別程式庫二進位檔和相關資源。傳送者應用程式投放應用程式是指也在傳送端上執行的應用程式。網路接收器應用程式是指在支援 Cast 裝置上執行的 HTML 應用程式。

傳送者架構使用非同步回呼設計,向傳送方應用程式告知事件,並在 Cast 應用程式生命週期的不同狀態之間進行轉換。

應用程式流程

下列步驟說明傳送方 Android 應用程式的一般高階執行流程:

  • Cast 架構會根據 Activity 生命週期自動啟動 MediaRouter 裝置探索作業。
  • 當使用者點選「投放」按鈕後,架構會顯示「投放」對話方塊,當中列出偵測到的投放裝置。
  • 當使用者選取投放裝置時,架構會嘗試在投放裝置上啟動網路接收器應用程式。
  • 架構會在傳送端應用程式中叫用回呼,確認 Web 接收器應用程式是否已啟動。
  • 這個架構會在傳送者和網路接收器應用程式之間建立通訊管道。
  • 該架構會使用通訊管道,在網路接收器上載入及控制媒體播放。
  • 這個架構會同步處理傳送者和網路接收器之間的媒體播放狀態:當使用者執行傳送者 UI 動作時,架構會將這些媒體控制要求傳遞至網路接收器,而網路接收器傳送媒體狀態更新時,架構會更新傳送者 UI 的狀態。
  • 當使用者按一下「投放」按鈕,中斷與投放裝置的連線時,架構將會中斷傳送者應用程式與網路接收器的連線。

如需 Google Cast Android SDK 中所有類別、方法和事件的完整清單,請參閱 Android 適用的 Google Cast Sender API 參考資料。以下各節說明將 Cast 新增至 Android 應用程式的相關步驟。

設定 Android 資訊清單

應用程式的 AndroidManifest.xml 檔案會要求您為 Cast SDK 設定下列元素:

uses-sdk

設定 Cast SDK 支援的最低和目標 Android API 級別。目前的最低需求為 API 級別 21,而目標為 API 級別 28。

<uses-sdk
        android:minSdkVersion="21"
        android:targetSdkVersion="28" />

android:theme

根據最低 Android SDK 版本設定應用程式的主題。舉例來說,如果您未實作自己的主題,則指定 Android SDK 版本低於 Lollipop 的最低版本時,應使用 Theme.AppCompat 變化版本。

<application
        android:icon="@drawable/ic_launcher"
        android:label="@string/app_name"
        android:theme="@style/Theme.AppCompat" >
       ...
</application>

初始化 Cast 內容

架構有一個全域單例模式物件 CastContext,可協調架構的所有互動。

應用程式必須實作 OptionsProvider 介面,以提供初始化 CastContext 單例模式所需的選項。OptionsProvider 提供 CastOptions 的執行個體,其中包含會影響架構行為的選項。其中最重要的是網路接收器應用程式 ID,用來篩選探索結果,以及在啟動投放工作階段時啟動 Web Receiver 應用程式。

Kotlin
class CastOptionsProvider : OptionsProvider {
    override fun getCastOptions(context: Context): CastOptions {
        return Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .build()
    }

    override fun getAdditionalSessionProviders(context: Context): List<SessionProvider>? {
        return null
    }
}
Java
public class CastOptionsProvider implements OptionsProvider {
    @Override
    public CastOptions getCastOptions(Context context) {
        CastOptions castOptions = new CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .build();
        return castOptions;
    }
    @Override
    public List<SessionProvider> getAdditionalSessionProviders(Context context) {
        return null;
    }
}

您必須在傳送者應用程式的 AndroidManifest.xml 檔案中,將已實作的 OptionsProvider 完整名稱宣告為中繼資料欄位:

<application>
    ...
    <meta-data
        android:name=
            "com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
        android:value="com.foo.CastOptionsProvider" />
</application>

系統會在呼叫 CastContext.getSharedInstance() 時延後初始化 CastContext

Kotlin
class MyActivity : FragmentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        val castContext = CastContext.getSharedInstance(this)
    }
}
Java
public class MyActivity extends FragmentActivity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        CastContext castContext = CastContext.getSharedInstance(this);
    }
}

Cast 使用者體驗小工具

Cast 架構提供符合 Cast 設計檢查清單的小工具:

  • 簡介重疊:此架構提供自訂檢視區塊 IntroductoryOverlay,可在使用者首次可用時,向使用者顯示「投放」按鈕的注意力。寄件者應用程式可以自訂標題文字的文字和位置

  • 投放按鈕: 無論投放裝置是否可用,「投放」按鈕都會顯示。 使用者首次點選「投放」按鈕時,畫面會顯示「投放」對話方塊,當中列出探索的裝置。如果使用者在裝置連線時按一下「投放」按鈕,畫面會顯示目前的媒體中繼資料 (例如標題、錄音室名稱和縮圖圖片),或允許使用者與投放裝置中斷連線。「投放」按鈕有時也稱為「投放圖示」。

  • Mini Controller:當使用者投放內容,並離開目前內容頁面,或將控制器展開至傳送端應用程式中的另一個畫面時,畫面底部會顯示迷你控制器,讓使用者可以查看目前的投放媒體中繼資料並控製播放。

  • 展開控制器:當使用者點擊媒體通知或迷你控制器時,展開的控制器會啟動,並顯示目前正在播放的媒體中繼資料,並提供多個按鈕控制媒體播放。

  • 通知:僅限 Android。當使用者在投放內容並離開傳送器應用程式時,系統會顯示媒體通知,顯示目前投放的媒體中繼資料和播放控制項。

  • 螢幕鎖定:僅限 Android。當使用者投放內容並瀏覽 (或裝置逾時) 至螢幕鎖定畫面時,系統會顯示媒體螢幕鎖定畫面控制項,顯示目前投放的媒體中繼資料和播放控制項。

以下指南提供如何在應用程式中加入這些小工具的說明。

新增投放按鈕

Android MediaRouter API 的設計可在次要裝置上啟用媒體顯示和播放功能。使用 MediaRouter API 的 Android 應用程式應在使用者介面中納入「投放」按鈕,讓使用者選取媒體路徑,以便在投放裝置等次要裝置上播放媒體。

這個架構可讓您輕鬆將 MediaRouteButton 新增為 Cast button。您應該先在定義選單的 XML 檔案中新增選單項目或 MediaRouteButton,然後使用 CastButtonFactory 與架構連結。

// To add a Cast button, add the following snippet.
// menu.xml
<item
    android:id="@+id/media_route_menu_item"
    android:title="@string/media_route_menu_title"
    app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"
    app:showAsAction="always" />
Kotlin
// Then override the onCreateOptionMenu() for each of your activities.
// MyActivity.kt
override fun onCreateOptionsMenu(menu: Menu): Boolean {
    super.onCreateOptionsMenu(menu)
    menuInflater.inflate(R.menu.main, menu)
    CastButtonFactory.setUpMediaRouteButton(
        applicationContext,
        menu,
        R.id.media_route_menu_item
    )
    return true
}
Java
// Then override the onCreateOptionMenu() for each of your activities.
// MyActivity.java
@Override public boolean onCreateOptionsMenu(Menu menu) {
    super.onCreateOptionsMenu(menu);
    getMenuInflater().inflate(R.menu.main, menu);
    CastButtonFactory.setUpMediaRouteButton(getApplicationContext(),
                                            menu,
                                            R.id.media_route_menu_item);
    return true;
}

這樣一來,如果您的 Activity 沿用自 FragmentActivity,就可以在版面配置中加入 MediaRouteButton

// activity_layout.xml
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
   android:layout_width="match_parent"
   android:layout_height="wrap_content"
   android:gravity="center_vertical"
   android:orientation="horizontal" >

   <androidx.mediarouter.app.MediaRouteButton
       android:id="@+id/media_route_button"
       android:layout_width="wrap_content"
       android:layout_height="wrap_content"
       android:layout_weight="1"
       android:mediaRouteTypes="user"
       android:visibility="gone" />

</LinearLayout>
Kotlin
// MyActivity.kt
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_layout)

    mMediaRouteButton = findViewById<View>(R.id.media_route_button) as MediaRouteButton
    CastButtonFactory.setUpMediaRouteButton(applicationContext, mMediaRouteButton)

    mCastContext = CastContext.getSharedInstance(this)
}
Java
// MyActivity.java
@Override
protected void onCreate(Bundle savedInstanceState) {
   super.onCreate(savedInstanceState);
   setContentView(R.layout.activity_layout);

   mMediaRouteButton = (MediaRouteButton) findViewById(R.id.media_route_button);
   CastButtonFactory.setUpMediaRouteButton(getApplicationContext(), mMediaRouteButton);

   mCastContext = CastContext.getSharedInstance(this);
}

如要透過主題設定「投放」按鈕的外觀,請參閱「自訂投放按鈕」。

設定裝置探索功能

裝置探索完全由 CastContext 管理。初始化 CastContext 時,傳送者應用程式會指定 Web 接收器應用程式 ID,並可選擇性地在 CastOptions 中設定 supportedNamespaces 要求命名空間篩選條件。CastContext 會在內部保留 MediaRouter 的參照,並在下列情況下啟動探索程序:

  • 根據用來平衡裝置探索延遲時間和電池用量的演算法,系統會在傳送者應用程式進入前景時,偶爾自動啟動探索功能。
  • 「投放」對話方塊已開啟。
  • Cast SDK 正嘗試復原投放工作階段。

當「投放」對話方塊關閉,或是傳送者應用程式進入背景時,探索程序就會停止。

Kotlin
class CastOptionsProvider : OptionsProvider {
    companion object {
        const val CUSTOM_NAMESPACE = "urn:x-cast:custom_namespace"
    }

    override fun getCastOptions(appContext: Context): CastOptions {
        val supportedNamespaces: MutableList<String> = ArrayList()
        supportedNamespaces.add(CUSTOM_NAMESPACE)

        return CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .setSupportedNamespaces(supportedNamespaces)
            .build()
    }

    override fun getAdditionalSessionProviders(context: Context): List<SessionProvider>? {
        return null
    }
}
Java
class CastOptionsProvider implements OptionsProvider {
    public static final String CUSTOM_NAMESPACE = "urn:x-cast:custom_namespace";

    @Override
    public CastOptions getCastOptions(Context appContext) {
        List<String> supportedNamespaces = new ArrayList<>();
        supportedNamespaces.add(CUSTOM_NAMESPACE);

        CastOptions castOptions = new CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .setSupportedNamespaces(supportedNamespaces)
            .build();
        return castOptions;
    }

    @Override
    public List<SessionProvider> getAdditionalSessionProviders(Context context) {
        return null;
    }
}

工作階段管理的運作方式

Cast SDK 介紹投放工作階段的概念,並結合了連接裝置、啟動 (或加入) Web 接收器應用程式、連線至該應用程式,以及初始化媒體控制管道的步驟。如要進一步瞭解投放工作階段和 Web Receiver 生命週期,請參閱 Web Receiver 應用程式生命週期指南

工作階段由 SessionManager 類別管理,應用程式可透過 CastContext.getSessionManager() 存取。個別工作階段會以 Session 類別的子類別表示。舉例來說,CastSession 代表使用投放裝置的工作階段。應用程式可透過 SessionManager.getCurrentCastSession() 存取目前進行中的投放工作階段。

應用程式可以使用 SessionManagerListener 類別監控工作階段事件,例如建立、暫停、繼續和終止等。在工作階段期間,架構會自動嘗試恢復異常/突然終止。

系統會根據 MediaRouter 對話方塊的使用者手勢,自動建立和卸除工作階段。

如要進一步瞭解 Cast 啟動錯誤,應用程式可以使用 CastContext#getCastReasonCodeForCastStatusCode(int),將工作階段開始錯誤轉換為 CastReasonCodes。請注意,某些工作階段啟動錯誤 (例如 CastReasonCodes#CAST_CANCELLED) 是正常的行為,不應記錄為錯誤。

如果您需要瞭解工作階段的狀態變更,可以實作 SessionManagerListener。這個範例會監聽 ActivityCastSession 的可用性。

Kotlin
class MyActivity : Activity() {
    private var mCastSession: CastSession? = null
    private lateinit var mCastContext: CastContext
    private lateinit var mSessionManager: SessionManager
    private val mSessionManagerListener: SessionManagerListener<CastSession> =
        SessionManagerListenerImpl()

    private inner class SessionManagerListenerImpl : SessionManagerListener<CastSession?> {
        override fun onSessionStarting(session: CastSession?) {}

        override fun onSessionStarted(session: CastSession?, sessionId: String) {
            invalidateOptionsMenu()
        }

        override fun onSessionStartFailed(session: CastSession?, error: Int) {
            val castReasonCode = mCastContext.getCastReasonCodeForCastStatusCode(error)
            // Handle error
        }

        override fun onSessionSuspended(session: CastSession?, reason Int) {}

        override fun onSessionResuming(session: CastSession?, sessionId: String) {}

        override fun onSessionResumed(session: CastSession?, wasSuspended: Boolean) {
            invalidateOptionsMenu()
        }

        override fun onSessionResumeFailed(session: CastSession?, error: Int) {}

        override fun onSessionEnding(session: CastSession?) {}

        override fun onSessionEnded(session: CastSession?, error: Int) {
            finish()
        }
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        mCastContext = CastContext.getSharedInstance(this)
        mSessionManager = mCastContext.sessionManager
    }

    override fun onResume() {
        super.onResume()
        mCastSession = mSessionManager.currentCastSession
        mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession::class.java)
    }

    override fun onPause() {
        super.onPause()
        mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession::class.java)
        mCastSession = null
    }
}
Java
public class MyActivity extends Activity {
    private CastContext mCastContext;
    private CastSession mCastSession;
    private SessionManager mSessionManager;
    private SessionManagerListener<CastSession> mSessionManagerListener =
            new SessionManagerListenerImpl();

    private class SessionManagerListenerImpl implements SessionManagerListener<CastSession> {
        @Override
        public void onSessionStarting(CastSession session) {}
        @Override
        public void onSessionStarted(CastSession session, String sessionId) {
            invalidateOptionsMenu();
        }
        @Override
        public void onSessionStartFailed(CastSession session, int error) {
            int castReasonCode = mCastContext.getCastReasonCodeForCastStatusCode(error);
            // Handle error
        }
        @Override
        public void onSessionSuspended(CastSession session, int reason) {}
        @Override
        public void onSessionResuming(CastSession session, String sessionId) {}
        @Override
        public void onSessionResumed(CastSession session, boolean wasSuspended) {
            invalidateOptionsMenu();
        }
        @Override
        public void onSessionResumeFailed(CastSession session, int error) {}
        @Override
        public void onSessionEnding(CastSession session) {}
        @Override
        public void onSessionEnded(CastSession session, int error) {
            finish();
        }
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mCastContext = CastContext.getSharedInstance(this);
        mSessionManager = mCastContext.getSessionManager();
    }
    @Override
    protected void onResume() {
        super.onResume();
        mCastSession = mSessionManager.getCurrentCastSession();
        mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession.class);
    }
    @Override
    protected void onPause() {
        super.onPause();
        mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession.class);
        mCastSession = null;
    }
}

變更串流裝置

保留工作階段狀態是串流傳輸的基礎,可讓使用者透過語音指令、Google Home 應用程式或智慧螢幕,在不同裝置上移動現有的音訊和影片串流。媒體會在某部裝置 (來源) 上停止播放,然後在另一部 (目的地) 上繼續播放。任何安裝最新韌體的 Cast 裝置都可以做為串流傳輸的來源或目的地。

如要在串流轉移或擴充期間取得新的目標裝置,請使用 CastSession#addCastListener 註冊 Cast.Listener。然後在 onDeviceNameChanged 回呼期間呼叫 CastSession#getCastDevice()

詳情請參閱「Web Receiver 上的串流傳輸」。

自動重新連線

此架構提供 ReconnectionService,可由傳送者應用程式啟用,在許多細微情況中處理重新連線,例如:

  • 從 Wi-Fi 服務暫時中斷時還原
  • 從裝置睡眠狀態復原
  • 從背景執行應用程式復原
  • 在應用程式當機時復原檔案

這項服務預設為開啟,但可以在 CastOptions.Builder 中關閉。

如果您在 Gradle 檔案中啟用自動合併功能,這項服務便可自動合併至應用程式的資訊清單。

架構會在有媒體工作階段時啟動服務,並在媒體工作階段結束時停止服務。

媒體控制的運作方式

Cast 架構淘汰了 Cast 2.x 的 RemoteMediaPlayer 類別,改用新的類別 RemoteMediaClient,這樣就能在一組更便利的 API 中提供相同功能,並避免必須傳入 GoogleApiClient。

當應用程式使用支援媒體命名空間的 Web Receiver 應用程式建立 CastSession 時,架構會自動建立 RemoteMediaClient 的執行個體;您的應用程式只要呼叫 CastSession 執行個體的 getRemoteMediaClient() 方法即可存取。

向網路接收器發出要求的所有 RemoteMediaClient 方法,皆會傳回可用於追蹤該要求的 PendingResult 物件。

RemoteMediaClient 的例項可能會由應用程式的多個部分共用,而且確實是架構的一些內部元件,例如永久迷你控制器通知服務。因此,這個執行個體支援註冊多個 RemoteMediaClient.Listener 的執行個體。

設定媒體中繼資料

MediaMetadata 類別代表您要投放的媒體項目相關資訊。下例會建立電影的新 MediaMetadata 執行個體,並設定標題、副標題和兩張圖片。

Kotlin
val movieMetadata = MediaMetadata(MediaMetadata.MEDIA_TYPE_MOVIE)

movieMetadata.putString(MediaMetadata.KEY_TITLE, mSelectedMedia.getTitle())
movieMetadata.putString(MediaMetadata.KEY_SUBTITLE, mSelectedMedia.getStudio())
movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia.getImage(0))))
movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia.getImage(1))))
Java
MediaMetadata movieMetadata = new MediaMetadata(MediaMetadata.MEDIA_TYPE_MOVIE);

movieMetadata.putString(MediaMetadata.KEY_TITLE, mSelectedMedia.getTitle());
movieMetadata.putString(MediaMetadata.KEY_SUBTITLE, mSelectedMedia.getStudio());
movieMetadata.addImage(new WebImage(Uri.parse(mSelectedMedia.getImage(0))));
movieMetadata.addImage(new WebImage(Uri.parse(mSelectedMedia.getImage(1))));

請參閱選取圖片,瞭解如何使用含有媒體中繼資料的圖片。

載入媒體

應用程式可以載入媒體項目,如以下程式碼所示。首先,搭配使用 MediaInfo.Builder 與媒體的中繼資料,建構 MediaInfo 執行個體。從目前的 CastSession 取得 RemoteMediaClient,然後將 MediaInfo 載入該 RemoteMediaClient。使用 RemoteMediaClient 來播放、暫停,或控制在網路接收器上執行的媒體播放器應用程式。

Kotlin
val mediaInfo = MediaInfo.Builder(mSelectedMedia.getUrl())
    .setStreamType(MediaInfo.STREAM_TYPE_BUFFERED)
    .setContentType("videos/mp4")
    .setMetadata(movieMetadata)
    .setStreamDuration(mSelectedMedia.getDuration() * 1000)
    .build()
val remoteMediaClient = mCastSession.getRemoteMediaClient()
remoteMediaClient.load(MediaLoadRequestData.Builder().setMediaInfo(mediaInfo).build())
Java
MediaInfo mediaInfo = new MediaInfo.Builder(mSelectedMedia.getUrl())
        .setStreamType(MediaInfo.STREAM_TYPE_BUFFERED)
        .setContentType("videos/mp4")
        .setMetadata(movieMetadata)
        .setStreamDuration(mSelectedMedia.getDuration() * 1000)
        .build();
RemoteMediaClient remoteMediaClient = mCastSession.getRemoteMediaClient();
remoteMediaClient.load(new MediaLoadRequestData.Builder().setMediaInfo(mediaInfo).build());

另請參閱「使用媒體追蹤」一節。

4K 影片格式

如要確認媒體採用的影片格式,請使用 MediaStatus 中的 getVideoInfo() 取得 VideoInfo 目前的例項。這個執行個體包含 HDR TV 格式的類型和螢幕高度和寬度 (以像素為單位)。4K 格式的變體會以常數 HDR_TYPE_* 表示。

從遠端控制多部裝置的通知

當使用者投放內容時,相同網路的其他 Android 裝置都會收到通知,允許這些裝置控製播放。凡是裝置收到這類通知的人,都可以在「Google 設定」應用程式 > Google Cast >「顯示遠端控制通知」中,為該裝置關閉通知功能。(通知中包含了「設定」應用程式的捷徑)。詳情請參閱「投放遙控通知」。

新增迷你控制器

根據投放設計檢查清單,傳送者應用程式應提供名為「迷你控制器」的永久控制項,當使用者從目前內容頁面前往傳送端應用程式的其他部分時,應會顯示此控制項。迷你控制器會提醒使用者目前投放工作階段的使用者。輕觸迷你控制器,使用者就能返回 Cast 全螢幕展開控制器檢視畫面。

架構提供自訂 View (miniControllerFragment),您可將其新增至要顯示迷你控制器的每項活動的版面配置檔案底部。

<fragment
    android:id="@+id/castMiniController"
    android:layout_width="fill_parent"
    android:layout_height="wrap_content"
    android:layout_alignParentBottom="true"
    android:visibility="gone"
    class="com.google.android.gms.cast.framework.media.widget.MiniControllerFragment" />

當傳送端應用程式播放影片或音訊直播時,SDK 會自動在迷你控制器中顯示播放/暫停按鈕,取代播放/暫停按鈕。

如要設定這個自訂檢視區塊的標題和副標題文字外觀,以及如何選擇按鈕,請參閱「自訂迷你控制器」。

新增展開的控制器

Google Cast 設計檢查清單規定,傳送方應用程式必須為投放的媒體提供展開的控制器。展開的控制器是迷你控制器的全螢幕版本。

Cast SDK 為展開的控制器提供名為 ExpandedControllerActivity 的小工具。這是一個抽象類別,您必須設定子類別,才能新增「投放」按鈕。

首先,為展開的控制器建立新的選單資源檔案,以提供「投放」按鈕:

<menu xmlns:android="http://schemas.android.com/apk/res/android"
      xmlns:app="http://schemas.android.com/apk/res-auto">

    <item
            android:id="@+id/media_route_menu_item"
            android:title="@string/media_route_menu_title"
            app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"
            app:showAsAction="always"/>

</menu>

建立可擴充 ExpandedControllerActivity 的新類別。

Kotlin
class ExpandedControlsActivity : ExpandedControllerActivity() {
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
        super.onCreateOptionsMenu(menu)
        menuInflater.inflate(R.menu.expanded_controller, menu)
        CastButtonFactory.setUpMediaRouteButton(this, menu, R.id.media_route_menu_item)
        return true
    }
}
Java
public class ExpandedControlsActivity extends ExpandedControllerActivity {
    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        super.onCreateOptionsMenu(menu);
        getMenuInflater().inflate(R.menu.expanded_controller, menu);
        CastButtonFactory.setUpMediaRouteButton(this, menu, R.id.media_route_menu_item);
        return true;
    }
}

現在,請在 application 標記的應用程式資訊清單中宣告新活動:

<application>
...
<activity
        android:name=".expandedcontrols.ExpandedControlsActivity"
        android:label="@string/app_name"
        android:launchMode="singleTask"
        android:theme="@style/Theme.CastVideosDark"
        android:screenOrientation="portrait"
        android:parentActivityName="com.google.sample.cast.refplayer.VideoBrowserActivity">
    <intent-filter>
        <action android:name="android.intent.action.MAIN"/>
    </intent-filter>
</activity>
...
</application>

編輯 CastOptionsProvider 並變更 NotificationOptionsCastMediaOptions,將目標活動設為新活動:

Kotlin
override fun getCastOptions(context: Context): CastOptions? {
    val notificationOptions = NotificationOptions.Builder()
        .setTargetActivityClassName(ExpandedControlsActivity::class.java.name)
        .build()
    val mediaOptions = CastMediaOptions.Builder()
        .setNotificationOptions(notificationOptions)
        .setExpandedControllerActivityClassName(ExpandedControlsActivity::class.java.name)
        .build()

    return CastOptions.Builder()
        .setReceiverApplicationId(context.getString(R.string.app_id))
        .setCastMediaOptions(mediaOptions)
        .build()
}
Java
public CastOptions getCastOptions(Context context) {
    NotificationOptions notificationOptions = new NotificationOptions.Builder()
            .setTargetActivityClassName(ExpandedControlsActivity.class.getName())
            .build();
    CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
            .setNotificationOptions(notificationOptions)
            .setExpandedControllerActivityClassName(ExpandedControlsActivity.class.getName())
            .build();

    return new CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .setCastMediaOptions(mediaOptions)
            .build();
}

更新 LocalPlayerActivity loadRemoteMedia 方法,以便在載入遠端媒體時顯示新活動:

Kotlin
private fun loadRemoteMedia(position: Int, autoPlay: Boolean) {
    val remoteMediaClient = mCastSession?.remoteMediaClient ?: return

    remoteMediaClient.registerCallback(object : RemoteMediaClient.Callback() {
        override fun onStatusUpdated() {
            val intent = Intent(this@LocalPlayerActivity, ExpandedControlsActivity::class.java)
            startActivity(intent)
            remoteMediaClient.unregisterCallback(this)
        }
    })

    remoteMediaClient.load(
        MediaLoadRequestData.Builder()
            .setMediaInfo(mSelectedMedia)
            .setAutoplay(autoPlay)
            .setCurrentTime(position.toLong()).build()
    )
}
Java
private void loadRemoteMedia(int position, boolean autoPlay) {
    if (mCastSession == null) {
        return;
    }
    final RemoteMediaClient remoteMediaClient = mCastSession.getRemoteMediaClient();
    if (remoteMediaClient == null) {
        return;
    }
    remoteMediaClient.registerCallback(new RemoteMediaClient.Callback() {
        @Override
        public void onStatusUpdated() {
            Intent intent = new Intent(LocalPlayerActivity.this, ExpandedControlsActivity.class);
            startActivity(intent);
            remoteMediaClient.unregisterCallback(this);
        }
    });
    remoteMediaClient.load(new MediaLoadRequestData.Builder()
            .setMediaInfo(mSelectedMedia)
            .setAutoplay(autoPlay)
            .setCurrentTime(position).build());
}

當傳送端應用程式播放影片或音訊直播時,SDK 會自動在展開的控制器中顯示播放/暫停按鈕,取代播放/暫停按鈕。

如要使用主題設定外觀、選擇要顯示的按鈕及新增自訂按鈕,請參閱「自訂展開控制器」。

音量控制

架構會自動管理傳送者應用程式的磁碟區。該架構會自動同步處理傳送者和 Web Receiver 應用程式,讓傳送端 UI 一律回報網路接收器指定的磁碟區。

實體按鈕音量控制

根據預設,在 Android 裝置上,對於使用 Jelly Bean 以上版本的任何裝置,您可以使用傳送端裝置上的實體按鈕,變更網路接收器投放工作階段的音量。

Jelly Bean 之前的實體按鈕音量控制

如要使用實體音量鍵控制在 Jelly Bean 之前 Android 裝置上的網路接收器裝置音量,傳送端應用程式應覆寫自身活動中的 dispatchKeyEvent,並呼叫 CastContext.onDispatchVolumeKeyEventBeforeJellyBean()

Kotlin
class MyActivity : FragmentActivity() {
    override fun dispatchKeyEvent(event: KeyEvent): Boolean {
        return (CastContext.getSharedInstance(this)
            .onDispatchVolumeKeyEventBeforeJellyBean(event)
                || super.dispatchKeyEvent(event))
    }
}
Java
class MyActivity extends FragmentActivity {
    @Override
    public boolean dispatchKeyEvent(KeyEvent event) {
        return CastContext.getSharedInstance(this)
            .onDispatchVolumeKeyEventBeforeJellyBean(event)
            || super.dispatchKeyEvent(event);
    }
}

在通知和螢幕鎖定畫面上新增媒體控制項

Google Cast 設計檢查清單僅適用於 Android 裝置,規定傳送器應用程式必須在通知和螢幕鎖定畫面中實作媒體控制項,也就是傳送者正在投放內容,但傳送者應用程式未聚焦的情況。該架構提供 MediaNotificationServiceMediaIntentReceiver,協助傳送端應用程式在通知和螢幕鎖定畫面中建構媒體控制項。

MediaNotificationService 會在傳送者投放時執行,並顯示通知,包含圖片縮圖、目前投放項目、播放/暫停按鈕和停止按鈕的相關資訊。

MediaIntentReceiver 是用於透過通知處理使用者動作的 BroadcastReceiver

應用程式可透過 NotificationOptions,在螢幕鎖定畫面上設定通知和媒體控制項。應用程式可以設定通知要顯示哪些控制按鈕,以及使用者輕觸通知時要開啟的 Activity。如未明確提供動作,系統會使用預設值 MediaIntentReceiver.ACTION_TOGGLE_PLAYBACKMediaIntentReceiver.ACTION_STOP_CASTING

Kotlin
// Example showing 4 buttons: "rewind", "play/pause", "forward" and "stop casting".
val buttonActions: MutableList<String> = ArrayList()
buttonActions.add(MediaIntentReceiver.ACTION_REWIND)
buttonActions.add(MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK)
buttonActions.add(MediaIntentReceiver.ACTION_FORWARD)
buttonActions.add(MediaIntentReceiver.ACTION_STOP_CASTING)

// Showing "play/pause" and "stop casting" in the compat view of the notification.
val compatButtonActionsIndices = intArrayOf(1, 3)

// Builds a notification with the above actions. Each tap on the "rewind" and "forward" buttons skips 30 seconds.
// Tapping on the notification opens an Activity with class VideoBrowserActivity.
val notificationOptions = NotificationOptions.Builder()
    .setActions(buttonActions, compatButtonActionsIndices)
    .setSkipStepMs(30 * DateUtils.SECOND_IN_MILLIS)
    .setTargetActivityClassName(VideoBrowserActivity::class.java.name)
    .build()
Java
// Example showing 4 buttons: "rewind", "play/pause", "forward" and "stop casting".
List<String> buttonActions = new ArrayList<>();
buttonActions.add(MediaIntentReceiver.ACTION_REWIND);
buttonActions.add(MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK);
buttonActions.add(MediaIntentReceiver.ACTION_FORWARD);
buttonActions.add(MediaIntentReceiver.ACTION_STOP_CASTING);

// Showing "play/pause" and "stop casting" in the compat view of the notification.
int[] compatButtonActionsIndices = new int[]{1, 3};

// Builds a notification with the above actions. Each tap on the "rewind" and "forward" buttons skips 30 seconds.
// Tapping on the notification opens an Activity with class VideoBrowserActivity.
NotificationOptions notificationOptions = new NotificationOptions.Builder()
    .setActions(buttonActions, compatButtonActionsIndices)
    .setSkipStepMs(30 * DateUtils.SECOND_IN_MILLIS)
    .setTargetActivityClassName(VideoBrowserActivity.class.getName())
    .build();

根據預設,顯示通知和螢幕鎖定畫面中的媒體控制項會開啟,如要停用,您可以呼叫 setNotificationOptions,並在 CastMediaOptions.Builder 中為空值。目前,只要通知功能開啟,螢幕鎖定功能就會開啟。

Kotlin
// ... continue with the NotificationOptions built above
val mediaOptions = CastMediaOptions.Builder()
    .setNotificationOptions(notificationOptions)
    .build()
val castOptions: CastOptions = Builder()
    .setReceiverApplicationId(context.getString(R.string.app_id))
    .setCastMediaOptions(mediaOptions)
    .build()
Java
// ... continue with the NotificationOptions built above
CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
        .setNotificationOptions(notificationOptions)
        .build();
CastOptions castOptions = new CastOptions.Builder()
        .setReceiverApplicationId(context.getString(R.string.app_id))
        .setCastMediaOptions(mediaOptions)
        .build();

當傳送端應用程式播放影片或音訊直播時,SDK 會自動在通知控制項上顯示播放/暫停按鈕,而不是螢幕鎖定畫面控制項。

注意:如要在 Lollipop 之前版本的裝置上顯示螢幕鎖定控制項,RemoteMediaClient 會自動代您要求音訊焦點。

處理錯誤

因此,傳送方應用程式必須處理所有錯誤回呼,並決定 Cast 生命週期各階段的最佳回應方式。應用程式可以向使用者顯示錯誤對話方塊,或決定是否卸除與網路接收器的連線。