GCKCastContext 類別

GCKCastContext 類別參考資料

總覽

這個類別包含架構的全域物件和狀態。

結構定義必須透過呼叫 setSharedInstanceWithOptions: (GCKCastContext) 在應用程式生命週期中提早初始化。

開始時間
3.0

沿用 NSObject。

執行個體方法摘要

(void) - registerDeviceProvider:
 註冊裝置供應商,開始支援新的類型 (非投放) 裝置。更多...
 
(void) - unregisterDeviceProviderForCategory:
 取消註冊特定裝置類別的裝置供應商。更多...
 
(void) - setLaunchCredentialsData:
 設定目前使用者的憑證資料。更多...
 
(void) - presentCastDialog
 顯示「投放」對話方塊。更多...
 
(GCKUICastContainerViewController *) - createCastContainerControllerForViewController:
 建構會嵌入指定檢視控制器的 GCKUICastContainerViewController更多...
 
(GCKUIMiniMediaControlsViewController *) - createMiniMediaControlsViewController
 建構 GCKUIMiniMediaControlsViewController更多...
 
(BOOL) - presentCastInstructionsViewControllerOnce
 如果之前未曾顯示過,系統會提供全螢幕的強制回應檢視控制器,用於呼叫「投放」按鈕,並顯示關於用途的簡短指示文字。更多...
 
(BOOL) - presentCastInstructionsViewControllerOnceWithCastButton:
 如果之前未曾顯示過,系統會提供全螢幕的強制回應檢視畫面,用於呼叫「投放」按鈕 (此畫面傳入檢視畫面),並顯示關於用途的簡短指示文字。更多...
 
(void) - clearCastInstructionsShownFlag
 清除持續旗標,追蹤是否要顯示 Cast 操作說明強制回應控制器。更多...
 
(void) - presentDefaultExpandedMediaControls
 顯示預設的 Cast 展開媒體控制項。更多...
 

類別方法摘要

(void) + setSharedInstanceWithOptions:
 設定共用執行個體,提供 Cast 選項物件。更多...
 
(BOOL) + setSharedInstanceWithOptions:error:
 設定共用執行個體,提供 Cast 選項物件。更多...
 
(instancetype) + sharedInstance
 傳回單例模式執行個體。更多...
 
(BOOL) + isSharedInstanceInitialized
 測試單例執行個體是否已初始化。更多...
 

公開屬性

NSString *const kGCKNotificationKeyCastState
 投放狀態變更通知中的新投放狀態 userInfo 金鑰。更多...
 
NSString *const kGCKCastStateDidChangeNotification
 當投放狀態變更時,要發布的通知名稱。更多...
 
NSString *const kGCKExpandedMediaControlsTriggeredNotification
 向使用者顯示的媒體控制選項時,要發布的通知名稱。更多...
 
NSString *const kGCKUICastDialogWillShowNotification
 顯示「投放」對話方塊時將發布的通知名稱。更多...
 
NSString *const kGCKUICastDialogDidHideNotification
 「投放」對話方塊關閉後將發布的通知名稱。更多...
 

資源摘要

GCKCastState castState
 應用程式目前的投放狀態。更多...
 
GCKDiscoveryManagerdiscoveryManager
 探索管理員。更多...
 
GCKSessionManagersessionManager
 工作階段管理員。更多...
 
id< GCKUIImageCacheimageCache
 架構會用於實作圖片快取,用於擷取媒體中繼資料中的參照圖片。更多...
 
id< GCKUIImagePickerimagePicker
 用於執行特定用途的圖片選取工具。更多...
 
BOOL useDefaultExpandedMediaControls
 設定在發生使用者動作時,系統應顯示擴展控制項的架構行為。更多...
 
GCKUIExpandedMediaControlsViewControllerdefaultExpandedMediaControlsViewController
 預設 Cast 展開媒體控制檢視控制器的執行個體。更多...
 

方法詳細資料

+ (void) setSharedInstanceWithOptions: (GCKCastOptions *)  options

設定共用執行個體,提供 Cast 選項物件。

如果共用執行個體已初始化,系統會擲回例外狀況。

Parameters
optionsThe Cast options.
+ (BOOL) setSharedInstanceWithOptions: (GCKCastOptions *)  options
error: (GCKError *_Nullable *_Nullable)  error 

設定共用執行個體,提供 Cast 選項物件。

如果已初始化結構定義,呼叫就會失敗。這個方法必須在主執行緒上呼叫。

Parameters
optionsThe Cast options.
errorA pointer at which to store the error in case of a failure.
傳回
YES 成功,NO 失敗。
開始時間
4.0
+ (instancetype) sharedInstance

傳回單例模式執行個體。

如果共用執行個體尚未初始化,系統會擲回例外狀況。

+ (BOOL) isSharedInstanceInitialized

測試單例執行個體是否已初始化。

開始時間
3.5.4
- (void) registerDeviceProvider: (GCKDeviceProvider *)  deviceProvider

註冊裝置供應商,開始支援新的類型 (非投放) 裝置。

Parameters
deviceProviderAn instance of a GCKDeviceProvider subclass for managing the devices.
- (void) unregisterDeviceProviderForCategory: (NSString *)  category

取消註冊特定裝置類別的裝置供應商。

Parameters
categoryA string that uniquely identifies the type of device.
- (void) setLaunchCredentialsData: (GCKCredentialsData *_Nullable)  credentialsData

設定目前使用者的憑證資料。

開始投放工作階段前,以及使用者帳戶變更時,都應使用目前的使用者資訊呼叫這個 API。

憑證資料會嵌入啟動要求中。如果是啟動 Android TV 應用程式,應用程式可以使用憑證資料來判斷應用程式是否支援特定使用者。如果不是,系統會啟動投放應用程式。

一旦啟動 Android TV 應用程式,系統會將憑證資料傳送到啟動意圖中的應用程式。應用程式可根據這類資料提供個人化的使用者體驗。

Parameters
credentialsDataAn instance of GCKCredentialsData. May be nil.
- (void) presentCastDialog

顯示「投放」對話方塊。

由「GCKCastContext(UI)」類別提供。

- (GCKUICastContainerViewController *) createCastContainerControllerForViewController: (UIViewController *)  viewController

建構會嵌入指定檢視控制器的 GCKUICastContainerViewController

由「GCKCastContext(UI)」類別提供。

- (GCKUIMiniMediaControlsViewController *) createMiniMediaControlsViewController

建構 GCKUIMiniMediaControlsViewController

由「GCKCastContext(UI)」類別提供。

- (BOOL) presentCastInstructionsViewControllerOnce

如果之前未曾顯示過,系統會提供全螢幕的強制回應檢視控制器,用於呼叫「投放」按鈕,並顯示關於用途的簡短指示文字。

傳回
YES (如果顯示檢視控制器時,它則為 NO;如果找不到「投放」按鈕,4.1 版本也會傳回 NO
Deprecated:
使用 showCastinstructionsViewControllerOnceWithCastButton:

由「GCKCastContext(UI)」類別提供。

- (BOOL) presentCastInstructionsViewControllerOnceWithCastButton: (GCKUICastButton *)  castButton

如果之前未曾顯示過,系統會提供全螢幕的強制回應檢視畫面,用於呼叫「投放」按鈕 (此畫面傳入檢視畫面),並顯示關於用途的簡短指示文字。

傳回
YES (如果顯示檢視控制器時,它則為 NO;如果找不到「投放」按鈕,也會傳回 NO
開始時間
4.1

由「GCKCastContext(UI)」類別提供。

- (void) clearCastInstructionsShownFlag

清除持續旗標,追蹤是否要顯示 Cast 操作說明強制回應控制器。

由「GCKCastContext(UI)」類別提供。

- (void) presentDefaultExpandedMediaControls

顯示預設的 Cast 展開媒體控制項。

由「GCKCastContext(UI)」類別提供。

成員資料說明文件

- (NSString* const) kGCKNotificationKeyCastState

投放狀態變更通知中的新投放狀態 userInfo 金鑰。

- (NSString* const) kGCKCastStateDidChangeNotification

當投放狀態變更時,要發布的通知名稱。

- (NSString* const) kGCKExpandedMediaControlsTriggeredNotification

向使用者顯示的媒體控制選項時,要發布的通知名稱。

- (NSString* const) kGCKUICastDialogWillShowNotification

顯示「投放」對話方塊時將發布的通知名稱。

開始時間
3.4
- (NSString* const) kGCKUICastDialogDidHideNotification

「投放」對話方塊關閉後將發布的通知名稱。

開始時間
3.4

資源詳細資料

- (GCKCastState) castState
readnonatomicassign

應用程式目前的投放狀態。

這項資源可以透過 KVO 或監聽 kGCKCastStateDidChangeNotification 通知來監控。

- (GCKDiscoveryManager*) discoveryManager
readnonatomicstrong

探索管理員。

這個物件會處理接收器裝置的探索作業。

- (GCKSessionManager*) sessionManager
readnonatomicstrong

工作階段管理員。

這個物件會管理與接收器裝置的互動。

- (id<GCKUIImageCache>) imageCache
readwritenonatomicstrong

架構會用於實作圖片快取,用於擷取媒體中繼資料中的參照圖片。

如果應用程式未提供預設實作,系統將採用預設的實作方式。可能設為 nil,即可恢復預設圖片快取。

由「GCKCastContext(UI)」類別提供。

- (id<GCKUIImagePicker>) imagePicker
readwritenonatomicstrong

用於執行特定用途的圖片選取工具。

如果應用程式未提供預設實作,系統將採用預設的實作方式。系統可能會設為 nil,以恢復預設圖片選擇器。

由「GCKCastContext(UI)」類別提供。

- (BOOL) useDefaultExpandedMediaControls
readwritenonatomicassign

設定在發生使用者動作時,系統應顯示擴展控制項的架構行為。

如果設為 YES,則架構會顯示預設的展開控制項檢視畫面。如果設為 NO,則架構只會觸發 GCKCastContext::kGCKExpandedMediaControlsTriggeredNotification

由「GCKCastContext(UI)」類別提供。

- (GCKUIExpandedMediaControlsViewController*) defaultExpandedMediaControlsViewController
readnonatomicstrong

預設 Cast 展開媒體控制檢視控制器的執行個體。

由「GCKCastContext(UI)」類別提供。