支援 Android 應用程式投放功能

1. 總覽

本程式碼研究室會說明如何修改現有的 Android 影片應用程式，以便在支援 Google Cast 的裝置上投放內容。

什麼是 Google Cast？

Google Cast 可讓使用者將內容從行動裝置投放到電視上。之後，使用者就能利用行動裝置做為電視媒體播放的遙控器。

Google Cast SDK 可讓你擴充應用程式，以控制電視或音響系統。Cast SDK 可讓您根據 Google Cast 設計檢查清單新增必要的 UI 元件。

我們提供了 Google Cast 設計檢查清單，讓您在所有支援平台上都能享有簡單且可預測的投放體驗。

我們要建構的是什麼？

完成本程式碼研究室後，您將有一個 Android 影片應用程式，可以將影片投放到支援 Google Cast 的裝置。

課程內容

• 如何將 Google Cast SDK 新增至影片樣本應用程式。
• 如何新增 Google Cast 裝置的投放按鈕。
• 如何連線至 Cast 裝置及啟動媒體接收器。
• 如何投放影片。
• 如何將 Cast 迷你控制器加入應用程式。
• 如何支援媒體通知和螢幕鎖定控制項。
• 如何新增展開的控制器。
• 如何提供簡介重疊廣告。
• 如何自訂 Cast 小工具。
• 如何與 Cast Connect 整合

軟硬體需求

• 最新的 Android SDK。
• Android Studio 3.2 以上版本
• 一部搭載 Android 4.1 以上版本 Jelly Bean (API 級別 16) 的行動裝置。
• 連接行動裝置與開發電腦的 USB 資料傳輸線。
• Google Cast 裝置，例如已設定網際網路連線的 Chromecast 或 Android TV。
• 具備 HDMI 輸入端的電視或螢幕。
• 你必須使用 Chromecast (支援 Google TV) 才能測試 Cast Connect 整合功能，但在程式碼研究室的其他部分則為選用功能。如果您還沒有 Chromecast 支援，請略過本教學課程結尾的「新增 Cast Connect 支援」步驟。

功能

• 您必須先具備之前的 Kotlin 和 Android 開發知識。
• 您也需要具備先前觀看電視節目的知識 :)

2. 取得程式碼範例

您可以將所有程式碼範例下載至電腦上...

file_download 下載原始碼

將下載的 ZIP 檔案解壓縮

3. 執行範例應用程式

首先，讓我們來看看已完成的範例應用程式。這款應用程式是基本的影片播放器。使用者可以選取清單中的影片，然後透過該裝置在本機播放影片，或是將影片投放到 Google Cast 裝置。

下載程式碼之後，請參閱下列操作說明，瞭解如何在 Android Studio 中開啟並執行完成的範例應用程式：

在歡迎畫面中選取「Import Project」(匯入專案)，或依序選取「File」(檔案) >「New」(新增) >「Import Project...」(匯入專案...) 選單選項。

從程式碼範例資料夾中選取 app-done 目錄，然後按一下 [OK]。

依序點選 [File] (檔案) > [Sync Project with Gradle Files] (使用 Gradle 檔案同步處理專案)。

在 Android 裝置上啟用 USB 偵錯功能：在 Android 4.2 及以上版本中，預設的開發人員選項畫面為隱藏。如要取消顯示，請依序前往「設定」>「關於手機」，然後輕觸「版本號碼」 七次。返回上一個畫面，依序前往 [系統] > [進階]，然後依序輕觸靠近底部的 [開發人員選項]，接著再輕觸 [USB 偵錯] 將其開啟。

插入您的 Android 裝置，然後按一下 Android Studio 中的 「Run」(執行) 按鈕。這時畫面上應該會出現名為「投放影片」的影片應用程式。

按一下影片應用程式中的「投放」按鈕，然後選取您的 Google Cast 裝置。

選取影片並點選播放按鈕。

影片就會在您的 Google Cast 裝置上開始播放。

系統會顯示已展開的控制器。您可以使用播放/暫停按鈕控製播放。

返回影片清單。

現在，畫面底部會顯示迷你控制器。

按一下迷你控制器上的暫停按鈕，即可暫停接收器的視訊。按一下迷你控制器中的播放按鈕，即可繼續播放影片。

按一下行動裝置主畫面按鈕。將通知向下拉，接著應該會出現投放工作階段的通知。

鎖定手機後，手機會在鎖定畫面上顯示通知，控制媒體播放或停止投放。

返回影片應用程式並按一下「投放」按鈕，即可停止在 Google Cast 裝置上投放內容。

常見問題

• 如何安裝 Android Studio？
• 如何啟用 USB 偵錯功能？
• 為什麼 Android Studio 看不到我的裝置？
• Android 錯誤：無法在裝置上安裝 *.apk *：逾時？

4. 準備起始專案

我們需要針對支援下載的應用程式提供 Google Cast 的支援。在本程式碼研究室中，我們會採用以下 Google Cast 術語：

• 寄件者應用程式會在行動裝置或筆記型電腦上執行，
• 接收器應用程式會在 Google Cast 裝置上執行。

您現在可以使用 Android Studio 來建構入門專案：

1. 從程式碼範例下載中，選取 app-start 目錄 (在歡迎畫面中選取 [Import Project] 或 [File] > [New] > [Import Project...] 選單選項。
2. 按一下 [Sync Project with Gradle Files] 按鈕。
3. 按一下 [執行] 按鈕來執行應用程式並探索 UI。

應用程式設計

應用程式會從遠端網路伺服器擷取影片清單，並提供使用者清單以供瀏覽。使用者可以選取影片以查看詳細資訊，或在行動裝置上在本機播放影片。

這個應用程式包含兩個主要活動：VideoBrowserActivity 和 LocalPlayerActivity。為了整合 Google Cast 的功能，活動必須沿用 AppCompatActivity 或其父項 FragmentActivity。這項限制的原因是，我們必須將 MediaRouteButton (在 MediaRouter 支援資料庫中提供) 新增為 MediaRouteActionProvider，且該活動必須沿用上述類別才能使用。MediaRouter 支援資料庫依附於提供必要類別的 AppCompat 支援資料庫。

影片瀏覽器活動

這項活動含有「Fragment」(VideoBrowserFragment)。這份清單是由 ArrayAdapter (VideoListAdapter) 提供支援。影片清單及其相關中繼資料是由遠端伺服器代管為 JSON 檔案。AsyncTaskLoader (VideoItemLoader) 會擷取這個 JSON 並進行處理，以便建立 MediaItem 物件清單。

MediaItem 物件會模擬影片及其相關中繼資料，例如標題、說明、串流網址、支援圖片的網址，以及相關的文字軌 (適用於隱藏式輔助字幕)。在活動之間傳遞 MediaItem 物件，因此 MediaItem 具備公用程式方法，可將其轉換為 Bundle，反之亦然。

載入器建構 MediaItems 清單時，會將其清單傳送至 VideoListAdapter，然後在 VideoBrowserFragment 中顯示 MediaItems 清單。使用者會看到影片縮圖清單，其中包含每部影片的簡短說明。選取項目之後，對應的 MediaItem 就會轉換為 Bundle，並傳遞至 LocalPlayerActivity。

本地玩家活動

此活動顯示特定影片的中繼資料，讓使用者可在行動裝置上在本機播放影片。

這個活動會代管VideoView、部分媒體控制項和文字區域，以顯示所選影片的說明。播放器會覆蓋畫面的上半部，為下方影片提供詳細說明。使用者可以播放/暫停影片，或搜尋當地影片播放。

依附關係

由於我們使用的是 AppCompatActivity，因此需要 AppCompat 支援資料庫。為管理影片清單，並以非同步方式取得清單圖片，因此我們使用 Volley 程式庫。

常見問題

• 什麼是 Google Cast？
• 如何成為 Google Cast 開發人員？

5. 新增投放按鈕

支援 Cast 的應用程式會在其各項活動中顯示「投放」按鈕。按一下「投放」按鈕即可顯示可供使用者選取的 Cast 裝置清單。如果使用者在本機裝置上播放內容，選取投放裝置，或是在該投放裝置上繼續播放內容。在投放工作階段期間，使用者隨時可以按一下 [投放] 按鈕，停止將應用程式投放到 Cast 裝置。在 Google Cast 設計檢查清單中，使用者必須能在應用程式的任何活動中，與 Cast 裝置建立連線或中斷連線。

依附關係

更新 app build.gradle 檔案，加入必要的程式庫依附元件：

dependencies {
    implementation 'androidx.appcompat:appcompat:1.5.0'
    implementation 'androidx.mediarouter:mediarouter:1.3.1'
    implementation 'androidx.recyclerview:recyclerview:1.2.1'
    implementation 'com.google.android.gms:play-services-cast-framework:21.1.0'
    implementation 'com.android.volley:volley:1.2.1'
    implementation "androidx.core:core-ktx:1.8.0"
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
}

請同步處理專案，確認專案版本沒有錯誤。

初始化

Cast 架構具備全域單例模式物件 CastContext，可協調所有 Cast 互動行為。

您必須實作 OptionsProvider 介面，以提供初始化 CastContext 單例模式所需的 CastOptions。最重要的選項是接收器應用程式 ID，可用來篩選 Cast 裝置探索結果，並在投放工作階段啟動時啟動接收器應用程式。

自行開發支援 Cast 的應用程式時，您必須註冊為 Cast 開發人員，然後為您的應用程式取得應用程式 ID。在本程式碼研究室中，我們將使用範例應用程式 ID。

將下列新的 CastOptionsProvider.kt 檔案新增至專案的 com.google.sample.cast.refplayer 套件：

package com.google.sample.cast.refplayer

import android.content.Context
import com.google.android.gms.cast.framework.OptionsProvider
import com.google.android.gms.cast.framework.CastOptions
import com.google.android.gms.cast.framework.SessionProvider

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

    override fun getAdditionalSessionProviders(context: Context): List<SessionProvider>? {
        return null
    }
}

現在，請在應用程式 AndroidManifest.xml 檔案的「application」標記中宣告 OptionsProvider：

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

延遲在 VideoBrowserActivity onCreate 方法中初始化 CastContext：

import com.google.android.gms.cast.framework.CastContext

private var mCastContext: CastContext? = null

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.video_browser)
    setupActionBar()

    mCastContext = CastContext.getSharedInstance(this)
}

將相同的初始化邏輯新增至 LocalPlayerActivity。

投放按鈕

CastContext 已初始化，請新增 [投放] 按鈕，讓使用者選取投放裝置。投放按鈕是由 MediaRouteButton 從 MediaRouter 支援資料庫實作。就像任何可新增至活動的動作圖示 (使用 ActionBar 或 Toolbar)，您必須先在選單中新增對應的選單項目。

編輯 res/menu/browse.xml 檔案，並在設定項目之前的選單中新增 MediaRouteActionProvider 項目：

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

使用 CastButtonFactory 將 MediaRouteButton 連結至 Cast 架構，藉此覆寫 VideoBrowserActivity 的 onCreateOptionsMenu() 方法：

import com.google.android.gms.cast.framework.CastButtonFactory

private var mediaRouteMenuItem: MenuItem? = null

override fun onCreateOptionsMenu(menu: Menu): Boolean {
     super.onCreateOptionsMenu(menu)
     menuInflater.inflate(R.menu.browse, menu)
     mediaRouteMenuItem = CastButtonFactory.setUpMediaRouteButton(getApplicationContext(), menu,
                R.id.media_route_menu_item)
     return true
}

以類似的方式覆寫 LocalPlayerActivity 中的 onCreateOptionsMenu。

按一下 [Run] (執行) 按鈕，以在行動裝置上執行應用程式。應用程式的動作列上會顯示「投放」按鈕，當您點選按鈕時，畫面上就會列出區域網路上的 Cast 裝置。裝置探索是由「CastContext」自動管理。選擇您的投放裝置，接收器應用程式隨即會載入至投放裝置上。您可在瀏覽活動與本機播放器活動之間進行切換，而且「投放」按鈕的狀態會保持同步。

我們尚未支援任何媒體播放功能，因此你目前還無法透過投放裝置播放影片。按一下「投放」按鈕即可中斷連線。

6. 投放影片內容

我們也會將範例應用程式延伸到遠端投放的影片。因此，我們必須監聽 Cast 架構產生的各種事件。

正在投放媒體

整體而言，如要在投放裝置上播放媒體，必須完成以下動作：

1. 建立 MediaInfo 物件，建立媒體項目模型。
2. 連線至 Cast 裝置，然後啟動接收器應用程式。
3. 將 MediaInfo 物件載入至接收器並播放內容。
4. 追蹤媒體狀態。
5. 根據使用者互動將播放指令傳送至接收端。

我們已經按照上一節的說明步驟 2 完成。步驟 3 可讓您輕鬆使用 Cast 架構。步驟 1 負責對應另一個物件；MediaInfo 是 Cast 架構能夠理解的內容，MediaItem 則是應用程式封裝的媒體項目封裝工具；我們很容易就能將 MediaItem 對應至 MediaInfo。

範例應用程式 LocalPlayerActivity 已使用這個列舉，區分本機與遠端播放：

private var mLocation: PlaybackLocation? = null

enum class PlaybackLocation {
    LOCAL, REMOTE
}

enum class PlaybackState {
    PLAYING, PAUSED, BUFFERING, IDLE
}

在本程式碼研究室中，您不需要瞭解所有範例播放器邏輯的運作方式。請務必瞭解，您的應用程式媒體播放器必須採用類似的方式修改兩個播放位置。

由於本機播放器目前還不知道投放狀態，因此該玩家永遠都處於本機播放狀態。我們必須根據 Cast 架構中發生的狀態轉換，更新使用者介面。舉例來說，如果我們開始投放內容，就必須停止本機播放並停用部分控制項。同樣地，如果我們在這個活動中停止投放，就必須改用本機播放。為解決這個問題，我們必須監聽 Cast 架構產生的各種事件。

投放工作階段管理

Cast 架構結合了連接裝置、啟動 (或加入)、連線至接收器應用程式，以及在適當情況下初始化媒體控制頻道的步驟。媒體控制頻道是 Cast 架構從接收器播放器接收及接收訊息的方式。

使用者從「投放」按鈕選取裝置後，系統就會自動開始投放工作階段，並在使用者中斷連線時自動停止投放工作階段。Cast SDK 也會自動處理因網路問題而重新連線到接收器工作階段。

讓我們將 SessionManagerListener 新增至 LocalPlayerActivity：

import com.google.android.gms.cast.framework.CastSession
import com.google.android.gms.cast.framework.SessionManagerListener
...

private var mSessionManagerListener: SessionManagerListener<CastSession>? = null
private var mCastSession: CastSession? = null
...

private fun setupCastListener() {
    mSessionManagerListener = object : SessionManagerListener<CastSession> {
        override fun onSessionEnded(session: CastSession, error: Int) {
            onApplicationDisconnected()
        }

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

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

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

        override fun onSessionStartFailed(session: CastSession, error: Int) {
            onApplicationDisconnected()
        }

        override fun onSessionStarting(session: CastSession) {}
        override fun onSessionEnding(session: CastSession) {}
        override fun onSessionResuming(session: CastSession, sessionId: String) {}
        override fun onSessionSuspended(session: CastSession, reason: Int) {}
        private fun onApplicationConnected(castSession: CastSession) {
            mCastSession = castSession
            if (null != mSelectedMedia) {
                if (mPlaybackState == PlaybackState.PLAYING) {
                    mVideoView!!.pause()
                    loadRemoteMedia(mSeekbar!!.progress, true)
                    return
                } else {
                    mPlaybackState = PlaybackState.IDLE
                    updatePlaybackLocation(PlaybackLocation.REMOTE)
                }
            }
            updatePlayButton(mPlaybackState)
            invalidateOptionsMenu()
        }

        private fun onApplicationDisconnected() {
            updatePlaybackLocation(PlaybackLocation.LOCAL)
            mPlaybackState = PlaybackState.IDLE
            mLocation = PlaybackLocation.LOCAL
            updatePlayButton(mPlaybackState)
            invalidateOptionsMenu()
       }
   }
}

在 LocalPlayerActivity 活動中，我們想瞭解在與 Cast 裝置連線或中斷連線時，可切換使用本機播放器或與本機播放器連線。請注意，除了在行動裝置上執行的應用程式執行個體之外，連線的中斷也會中斷，而另一個 (或其他) 應用程式的執行個體也可能同時在其他行動裝置上執行。

目前的工作階段可使用 SessionManager.getCurrentSession() 存取。系統會自動建立工作階段，並根據使用者與 Cast 對話方塊的互動來自動移除工作階段。

我們必須註冊工作階段監聽器，並初始化要在活動中使用的部分變數。將 LocalPlayerActivity onCreate 方法變更為：

import com.google.android.gms.cast.framework.CastContext
...

private var mCastContext: CastContext? = null
...

override fun onCreate(savedInstanceState: Bundle?) {
    ...
    mCastContext = CastContext.getSharedInstance(this)
    mCastSession = mCastContext!!.sessionManager.currentCastSession
    setupCastListener()
    ...
    loadViews()
    ...
    val bundle = intent.extras
    if (bundle != null) {
        ....
        if (shouldStartPlayback) {
              ....

        } else {
            if (mCastSession != null && mCastSession!!.isConnected()) {
                updatePlaybackLocation(PlaybackLocation.REMOTE)
            } else {
                updatePlaybackLocation(PlaybackLocation.LOCAL)
            }
            mPlaybackState = PlaybackState.IDLE
            updatePlayButton(mPlaybackState)
        }
    }
    ...
}

正在載入媒體

在 Cast SDK 中，RemoteMediaClient 提供一組便利的 API，可用來管理接收器上的遠端媒體播放。對於支援媒體播放的 CastSession，SDK 會自動建立 RemoteMediaClient 的例項。呼叫 CastSession 例項上的 getRemoteMediaClient() 方法即可存取。將下列方法新增至 LocalPlayerActivity，以在接收器上載入目前選取的影片：

import com.google.android.gms.cast.framework.media.RemoteMediaClient
import com.google.android.gms.cast.MediaInfo
import com.google.android.gms.cast.MediaLoadOptions
import com.google.android.gms.cast.MediaMetadata
import com.google.android.gms.common.images.WebImage
import com.google.android.gms.cast.MediaLoadRequestData

private fun loadRemoteMedia(position: Int, autoPlay: Boolean) {
    if (mCastSession == null) {
        return
    }
    val remoteMediaClient = mCastSession!!.remoteMediaClient ?: return
    remoteMediaClient.load( MediaLoadRequestData.Builder()
                .setMediaInfo(buildMediaInfo())
                .setAutoplay(autoPlay)
                .setCurrentTime(position.toLong()).build())
}

private fun buildMediaInfo(): MediaInfo? {
    val movieMetadata = MediaMetadata(MediaMetadata.MEDIA_TYPE_MOVIE)
    mSelectedMedia?.studio?.let { movieMetadata.putString(MediaMetadata.KEY_SUBTITLE, it) }
    mSelectedMedia?.title?.let { movieMetadata.putString(MediaMetadata.KEY_TITLE, it) }
    movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia!!.getImage(0))))
    movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia!!.getImage(1))))
    return mSelectedMedia!!.url?.let {
        MediaInfo.Builder(it)
            .setStreamType(MediaInfo.STREAM_TYPE_BUFFERED)
            .setContentType("videos/mp4")
            .setMetadata(movieMetadata)
            .setStreamDuration((mSelectedMedia!!.duration * 1000).toLong())
            .build()
    }
}

現在，請更新各種現有的方法，以使用投放工作階段邏輯以支援遠端播放：

private fun play(position: Int) {
    startControllersTimer()
    when (mLocation) {
        PlaybackLocation.LOCAL -> {
            mVideoView!!.seekTo(position)
            mVideoView!!.start()
        }
        PlaybackLocation.REMOTE -> {
            mPlaybackState = PlaybackState.BUFFERING
            updatePlayButton(mPlaybackState)
            //seek to a new position within the current media item's new position 
            //which is in milliseconds from the beginning of the stream
            mCastSession!!.remoteMediaClient?.seek(position.toLong())
        }
        else -> {}
    }
    restartTrickplayTimer()
}

private fun togglePlayback() {
    ...
    PlaybackState.IDLE -> when (mLocation) {
        ...
        PlaybackLocation.REMOTE -> {
            if (mCastSession != null && mCastSession!!.isConnected) {
                loadRemoteMedia(mSeekbar!!.progress, true)
            }
        }
        else -> {}
    }
    ...
}

override fun onPause() {
    ...
    mCastContext!!.sessionManager.removeSessionManagerListener(
                mSessionManagerListener!!, CastSession::class.java)
}

override fun onResume() {
    Log.d(TAG, "onResume() was called")
    mCastContext!!.sessionManager.addSessionManagerListener(
            mSessionManagerListener!!, CastSession::class.java)
    if (mCastSession != null && mCastSession!!.isConnected) {
        updatePlaybackLocation(PlaybackLocation.REMOTE)
    } else {
        updatePlaybackLocation(PlaybackLocation.LOCAL)
    }
    super.onResume()
}

針對 updatePlayButton 方法，變更 isConnected 變數的值：

private fun updatePlayButton(state: PlaybackState?) {
    ...
    val isConnected = (mCastSession != null
                && (mCastSession!!.isConnected || mCastSession!!.isConnecting))
    ...
}

現在，請按一下 [執行] 按鈕，在您的行動裝置上執行應用程式。連線至您的投放裝置，然後開始播放影片。您應該會在接收器中看見播放影片。

7. 迷你控制器

「投放設計檢查清單」要求所有 Cast 應用程式都必須提供迷你控制器，當使用者離開目前的內容頁面時，系統就會顯示這個控制器。這個迷你控制器提供目前投放工作階段的即時存取權限和可見提醒。

Cast SDK 提供自訂檢視 MiniControllerFragment，您可以將它新增到要顯示迷你控制器的活動的應用程式檔案中。

在 res/layout/player_activity.xml 和 res/layout/video_browser.xml 的底部新增下列片段定義：

<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"/>

按一下 [執行] 按鈕，執行應用程式並投放影片。在接收器上開始播放時，每個活動底部都會顯示迷你控制器。您可以使用迷你控制器控制遠端播放。如果你在瀏覽活動與本機播放器活動之間進行瀏覽，迷你控制器的狀態應會與接收器媒體播放狀態保持同步。

8. 通知和螢幕鎖定

Google Cast 設計檢查清單要求寄件者應用程式必須在通知和鎖定畫面中導入媒體控制項。

Cast SDK 提供 MediaNotificationService，可協助寄件者應用程式製作通知及螢幕鎖定畫面的媒體控制項。Gradle 會自動合併這項服務至應用程式的資訊清單。

傳送投放者時，MediaNotificationService 會在背景執行，並會顯示通知，包括目前投放項目的圖片縮圖及中繼資料、播放/暫停按鈕和停止按鈕。

初始化 CastContext 時，可以使用 CastOptions 啟用通知和螢幕鎖定控制項。通知和螢幕鎖定媒體的媒體控制項預設為開啟。只要螢幕鎖定功能開啟，系統就會開啟螢幕鎖定功能。

編輯 CastOptionsProvider 並變更 getCastOptions 實作以符合此程式碼：

import com.google.android.gms.cast.framework.media.CastMediaOptions
import com.google.android.gms.cast.framework.media.NotificationOptions

override fun getCastOptions(context: Context): CastOptions {
   val notificationOptions = NotificationOptions.Builder()
            .setTargetActivityClassName(VideoBrowserActivity::class.java.name)
            .build()
    val mediaOptions = CastMediaOptions.Builder()
            .setNotificationOptions(notificationOptions)
            .build()
   return CastOptions.Builder()
                .setReceiverApplicationId(context.getString(R.string.app_id))
                .setCastMediaOptions(mediaOptions)
                .build()
}

按一下 [Run] (執行) 按鈕，以在行動裝置上執行應用程式。投放影片並離開範例應用程式，應該會顯示接收器目前播放影片的通知。鎖定您的行動裝置後，鎖定畫面應會顯示投放媒體控制選項。

9. 簡介重疊廣告

Google Cast 設計檢查清單要求傳送者應用程式可讓現有使用者導入「投放」按鈕，以便告知傳送者應用程式現已支援投放功能，也能協助剛接觸 Google Cast 的使用者。

Cast SDK 提供自訂檢視 IntroductoryOverlay，可在使用者首次看到「投放」按鈕時用來醒目顯示。將下列程式碼加進 VideoBrowserActivity：

import com.google.android.gms.cast.framework.IntroductoryOverlay
import android.os.Looper

private var mIntroductoryOverlay: IntroductoryOverlay? = null

private fun showIntroductoryOverlay() {
    mIntroductoryOverlay?.remove()
    if (mediaRouteMenuItem?.isVisible == true) {
       Looper.myLooper().run {
           mIntroductoryOverlay = com.google.android.gms.cast.framework.IntroductoryOverlay.Builder(
                    this@VideoBrowserActivity, mediaRouteMenuItem!!)
                   .setTitleText("Introducing Cast")
                   .setSingleTime()
                   .setOnOverlayDismissedListener(
                           object : IntroductoryOverlay.OnOverlayDismissedListener {
                               override fun onOverlayDismissed() {
                                   mIntroductoryOverlay = null
                               }
                          })
                   .build()
          mIntroductoryOverlay!!.show()
        }
    }
}

現在，請在

import com.google.android.gms.cast.framework.CastState
import com.google.android.gms.cast.framework.CastStateListener

private var mCastStateListener: CastStateListener? = null

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.video_browser)
    setupActionBar()
    mCastStateListener = object : CastStateListener {
            override fun onCastStateChanged(newState: Int) {
                if (newState != CastState.NO_DEVICES_AVAILABLE) {
                    showIntroductoryOverlay()
                }
            }
        }
    mCastContext = CastContext.getSharedInstance(this)
}

override fun onResume() {
    super.onResume()
    mCastContext?.addCastStateListener(mCastStateListener!!)
}

override fun onPause() {
    super.onPause()
    mCastContext?.removeCastStateListener(mCastStateListener!!)
}

11. 新增 Cast Connect 支援功能

Cast Connect 程式庫可讓現有的傳送端應用程式透過 Cast 通訊協定與 Android TV 應用程式進行通訊。Cast Connect 是以 Cast 基礎架構為基礎，而您的 Android TV 應用程式可做為接收器使用。

依附關係

注意：如要導入 Cast Connect，play-services-cast-framework 必須為 19.0.0 以上版本。

推出選項

為了啟動 Android TV 應用程式 (也稱為 Android 接收器)，您必須在 LaunchOptions 物件中將 setAndroidReceiverCompatible 標記設為 true。此 LaunchOptions 物件會指定接收器的啟動方式，並傳送至 CastOptionsProvider 類別傳回的 CastOptions。將上述旗標設為 false 後，就會在 Cast Developer Console 中針對已定義的應用程式 ID 啟動網站接收器。

在 CastOptionsProvider.kt 檔案中，將以下內容新增至 getCastOptions 方法：

import com.google.android.gms.cast.LaunchOptions
...
val launchOptions = LaunchOptions.Builder()
            .setAndroidReceiverCompatible(true)
            .build()
return new CastOptions.Builder()
        .setLaunchOptions(launchOptions)
        ...
        .build()

設定啟動憑證

在傳送端，您可以指定 CredentialsData，代表參與工作階段的人員。credentials 是一個可讓使用者定義的字串，前提是您的 ATV 應用程式能夠理解。只有在啟動或加入時，系統才會將 CredentialsData 傳送到您的 Android TV 應用程式。如果您在連線時再次設定裝置，系統就不會將卡片傳送到您的 Android TV 應用程式。

如要設定啟動憑證，必須定義 CredentialsData 並將其傳遞至 LaunchOptions 物件。將下列程式碼新增到 CastOptionsProvider.kt 檔案的 getCastOptions 方法中：

import com.google.android.gms.cast.CredentialsData
...

val credentialsData = CredentialsData.Builder()
        .setCredentials("{\"userId\": \"abc\"}")
        .build()
val launchOptions = LaunchOptions.Builder()
       ...
       .setCredentialsData(credentialsData)
       .build()

在 LoadRequest 上設定憑證

如果 Web Receiver 應用程式和 Android TV 應用程式處理 credentials 的方式不同，您可能需要為每個 credentials 分別定義 credentials。為解決這個問題，請在 LocalPlayerActivity.kt 檔案的 loadRemoteMedia 函式下方新增下列程式碼：

remoteMediaClient.load(MediaLoadRequestData.Builder()
       ...
       .setCredentials("user-credentials")
       .setAtvCredentials("atv-user-credentials")
       .build())

SDK 會自動根據目前投放者的接收端應用程式，自動處理目前工作階段要使用的憑證。

正在測試 Cast Connect

在 Chromecast (支援 Google TV) 上安裝 Android TV APK 的步驟

1. 找出 Android TV 裝置的 IP 位址。通常可在 [設定] > [網路和網際網路] > (您的裝置已連線的網路名稱) 下存取。畫面右側會顯示網路的詳細資訊和裝置的 IP。
2. 使用裝置的 IP 位址，透過終端機透過 ADB 連線至裝置：

$ adb connect <device_ip_address>:5555

3. 從終端機視窗，前往您在本程式碼研究室開始時下載的程式碼研究室範例的頂層資料夾。例如：

$ cd Desktop/android_codelab_src

4. 執行下列指令，將這個資料夾中的 .apk 檔案安裝至您的 Android TV：

$ adb -s <device_ip_address>:5555 install android-tv-app.apk

5. 您現在應該能在 Android TV 裝置的 [您的應用程式] 選單中，看到以 [投放影片] 這個名稱顯示的應用程式。
6. 返回您的 Android Studio 專案，然後按一下 [Run] (執行) 按鈕，以在您的實體行動裝置上安裝並執行寄件者應用程式。按一下右上角的投放圖示，然後從可用選項中選取您的 Android TV 裝置。現在，你應該會看到 Android TV 裝置已啟動的 Android TV 應用程式。播放影片時，你應該可以使用 Android TV 遙控器來控制影片播放。

12. 自訂 Cast 小工具

您可以自訂 Cast 小工具，只要設定顏色、按鈕的樣式、文字和縮圖外觀，並且選擇要顯示的按鈕類型即可。

更新「res/values/styles_castvideo.xml」

<style name="Theme.CastVideosTheme" parent="Theme.AppCompat.Light.NoActionBar">
    ...
    <item name="mediaRouteTheme">@style/CustomMediaRouterTheme</item>
    <item name="castIntroOverlayStyle">@style/CustomCastIntroOverlay</item>
    <item name="castMiniControllerStyle">@style/CustomCastMiniController</item>
    <item name="castExpandedControllerStyle">@style/CustomCastExpandedController</item>
    <item name="castExpandedControllerToolbarStyle">
        @style/ThemeOverlay.AppCompat.ActionBar
    </item>
    ...
</style>

宣告下列自訂主題：

<!-- Customize Cast Button -->
<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>

<!-- Customize Introductory Overlay -->
<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>

<!-- Customize Mini Controller -->
<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">@color/accent</item>
    <item name="castProgressBarColor">@color/orange</item>
</style>

<!-- Customize Expanded Controller -->
<style name="CustomCastExpandedController" parent="CastExpandedController">
    <item name="castButtonColor">#FFFFFF</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>
</style>

13. 恭喜

您現已瞭解如何在 Android 上使用 Cast SDK 小工具，以支援 Google Cast 的影片應用程式。

詳情請參閱 Android 傳送者開發人員指南。