以下程序能根據 CastContext 單例模式,將 Android 傳送端應用程式從 Cast SDK v2 轉換為 CAF Sender。
Cast CAF 傳送端 SDK 會使用 CastContext 代您管理 GoogleAPIClient。CastContext 可為您管理生命週期、錯誤和回呼,大幅簡化 Cast 應用程式的開發作業。
簡介
- CAF 傳送工具仍透過 Android SDK Manager 包含在 Google Play 服務中發布
- 已新增套件,負責遵守 Google Cast 設計檢查清單 (
com.google.android.gms.cast.framework.*
) - CAF 傳送者提供的小工具符合 Cast 使用者體驗規定;第 2 版不提供任何 UI 元件,而且需要您實作這些小工具。
- 使用 Cast API 時,不再需要使用 GoogleApiClient。
- CAF 寄件者的隱藏式輔助字幕與第 2 版類似,
依附元件
如同支援資料庫功能指南所述,V2 和 CAF 在支援資料庫和 Google Play 服務 (9.2.0 以上版本) 中擁有相同的依附元件。
CAF 支援的最低 Android SDK 版本為 9 (Gingerbread)。
初始化
在 CAF 中,Cast 架構需要明確的初始化步驟。這包括使用適當的 OptionsProvider
指定網路接收器應用程式 ID 和其他任何全域選項,初始化 CastContext
單例模式。
public class CastOptionsProvider implements OptionsProvider {
@Override
public CastOptions getCastOptions(Context context) {
return new CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.build();
}
@Override
public List<SessionProvider> getAdditionalSessionProviders(Context context) {
return null;
}
}
在應用程式 AndroidManifest.xml
檔案的「application」標記中宣告 OptionsProvider
:
<application>
...
<meta-data
android:name=
"com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
android:value="com.google.sample.cast.refplayer.CastOptionsProvider" />
</application>
延後初始化每個活動的 onCreate
方法中的 CastContext
:
private CastContext mCastContext;
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.video_browser);
setupActionBar();
mCastContext = CastContext.getSharedInstance(this);
}
這些步驟在第 2 版中不需要。
探索裝置
在 CAF 中,當應用程式移至前景並分別前往背景時,架構會自動啟動及停止探索程序。不應使用 MediaRouteSelector
和 MediaRouter.Callback
。
投放按鈕和投放對話方塊
與第 2 版相同,這些元件是由 MediaRouter 支援資料庫提供。
「投放」按鈕仍會由 MediaRouteButton
實作,且可使用 ActionBar
或 Toolbar
新增至活動,做為選單的選單項目。
<item
android:id="@+id/media_route_menu_item"
android:title="@string/media_route_menu_title"
app:actionProviderClass="android.support.v7.app.MediaRouteActionProvider"
app:showAsAction="always"/>
使用 CastButtonFactory
將 MediaRouteButton
連線至 Cast 架構,藉此覆寫每個活動的 onCreateOptionMenu()
方法:
private MenuItem mediaRouteMenuItem;
public boolean onCreateOptionsMenu(Menu menu) {
super.onCreateOptionsMenu(menu);
getMenuInflater().inflate(R.menu.browse, menu);
mediaRouteMenuItem =
CastButtonFactory.setUpMediaRouteButton(getApplicationContext(),
menu,
R.id.media_route_menu_item);
return true;
}
有人輕觸按鈕時,「投放」對話方塊就會自動出現。
裝置控制
在 CAF 中,裝置控制項大部分是由架構處理。傳送端應用程式不需處理 (且不應嘗試處理) 連線至裝置,並使用 GoogleApiClient
啟動 Web Receiver 應用程式。傳送端與網路接收器之間的互動,現在以「工作階段」表示。SessionManager
類別會處理工作階段生命週期,並根據使用者手勢自動啟動及停止工作階段:當使用者在投放對話方塊中選取投放裝置時,工作階段就會啟動,當使用者輕觸「投放」對話方塊中的「停止投放」按鈕,或傳送端應用程式自行終止時,工作階段就會結束。透過 SessionManager
註冊 SessionManagerListener
,傳送端應用程式就可收到工作階段生命週期事件的通知。SessionManagerListener
回呼會定義所有工作階段生命週期事件的回呼方法。
CastSession
類別代表與投放裝置的工作階段。這個類別具有控制裝置音量和靜音狀態的方法。先前在 v2 中,您可以使用 Cast.CastApi
的方法控制裝置音量和靜音狀態。
在第 2 版中,Cast.Listener
回呼會提供裝置狀態變更的通知,包括音量、靜音狀態、待機狀態等。
在 CAF 中,系統仍會透過 Cast.Listener
中的回呼方法傳送音量/靜音狀態變更通知,這些事件監聽器皆是透過 CastSession
註冊。所有其他裝置狀態通知都會透過 CastStateListener
回呼傳送;這些事件監聽器皆是透過 CastSession
註冊。當相關聯的片段、活動或應用程式進入背景時,請務必取消註冊事件監聽器。
重新連線邏輯
與第 2 版一樣,CAF 會嘗試重新建立因 Wi-Fi 訊號暫時中斷或其他網路錯誤而中斷的網路連線。目前是在工作階段層級完成;工作階段可能會在連線中斷時進入「已暫停」狀態,並在恢復連線時切換回「已連線」狀態。在這個過程中,架構會負責重新連線至 Web Receiver 應用程式,並重新連結任何 Cast 頻道。
此外,CAF 也會新增預設啟用的自動恢復工作階段功能 (可透過 CastOptions
停用)。如果在投放工作階段執行期間,傳送端應用程式傳送至背景或終止 (藉由滑動操作或因當機而終止),架構會在傳送者應用程式返回前景或重新啟動時,嘗試繼續執行該工作階段;由 SessionManager
自動處理,由 SessionManager
自動處理,該程序會在任何已註冊的 SessionManagerListener
例項上發出適當的回呼。
自訂管道註冊
在 v2 中,自訂管道 (使用 Cast.MessageReceivedCallback
實作) 是以 Cast.CastApi
註冊。在 CAF 中,自訂管道改為使用 CastSession
執行個體註冊。註冊可透過 SessionManagerListener.onSessionStarted
回呼方法完成。就媒體應用程式而言,您不再需要透過 Cast.CastApi.setMessageReceivedCallbacks
明確註冊媒體控制管道,詳情請參閱下一節。
媒體管理
v2 類別 RemoteMediaPlayer
已淘汰,不建議使用。在 CAF 中,由新的 RemoteMediaClient
類別取代,後者在更便利的 API 中提供同等功能。不需要明確初始化或註冊此物件;如果連結的 Web Receiver 應用程式支援媒體命名空間,則架構會在工作階段開始時間時自動將物件例項化,並註冊基礎媒體管道。
您可以用 CastSession
物件的 getRemoteMediaClient
方法存取 RemoteMediaClient
。
在 v2 中,向 RemoteMediaPlayer
發出的所有媒體要求都會透過 PendingResult
回呼傳回 RemoteMediaPlayer.MediaChannelResult
。
在 CAF 中,所有透過 RemoteMediaClient
發出的媒體要求都會透過 PendingResult
回呼傳回 RemoteMediaClient.MediaChannelResult
,這可用於追蹤要求的進度和最終結果。
第 2 版 RemoteMediaPlayer
會透過 RemoteMediaPlayer.OnStatusUpdatedListener
傳送媒體播放器狀態變更的通知。
在 CAF 中,RemoteMediaClient
會透過其 RemoteMediaClient.Listener
介面提供對等的回呼。任意數量的事件監聽器都能註冊 RemoteMediaClient
,讓多個傳送端元件可以共用與工作階段相關聯的單一 RemoteMediaClient
例項。
在第 2 版中,傳送方應用程式必須承擔讓使用者介面與網路接收器中媒體播放器狀態保持同步的負擔。
在 CAF 中,UIMediaController
類別是大部分的責任。
簡介重疊
第 2 版不提供簡介重疊使用者介面。
CAF 提供自訂檢視畫面 IntroductoryOverlay
,可在使用者首次看到「投放」按鈕時醒目顯示該按鈕。
迷你控制器
在 v2 中,您需要在傳送者應用程式中,從頭開始實作迷你控制器。
在 CAF 中,SDK 提供自訂檢視區塊 MiniControllerFragment
,您可以將檢視區塊新增至要顯示迷你控制器的活動應用程式版面配置檔案。
通知和螢幕鎖定
在第 2 版中,SDK 不提供通知和螢幕鎖定功能的控制器。針對該 SDK,您需要使用 Android 架構 API,在傳送端應用程式中建構這些功能。
在 CAF 中,SDK 提供 NotificationsOptions.Builder
,協助您為傳送者應用程式建構通知和螢幕鎖定畫面的媒體控制項。在初始化 CastContext
時,您可以使用 CastOptions
啟用通知和螢幕鎖定控制項。
public CastOptions getCastOptions(Context context) {
NotificationOptions notificationOptions = new NotificationOptions.Builder()
.setTargetActivityClassName(VideoBrowserActivity.class.getName())
.build();
CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
.setNotificationOptions(notificationOptions)
.build();
return new CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.setCastMediaOptions(mediaOptions)
.build();
}
展開的控制器
在 v2 中,您必須在傳送端應用程式中,從頭開始實作展開控制器。
CAF 提供 UIMediaController
輔助類別,讓您輕鬆建構自己的展開控制器。
CAF 新增了預先建構的展開控制器小工具 ExpandedControllerActivity
,您只需將其新增至應用程式即可。您不需要使用 UIMediaController
實作自訂展開控制器。
音訊焦點
在第 2 版中,您必須使用 MediaSessionCompat
管理音訊焦點。
在 CAF 中,系統會自動管理音訊焦點。
偵錯記錄功能
CAF 不提供記錄選項。
範例應用程式
我們提供了使用 CAF 的程式碼研究室教學課程和範例應用程式。