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
 清除常駐旗標,用於追蹤「投放操作說明」強制回應檢視控制器是否顯示。更多...
 
(void) - presentDefaultExpandedMediaControls
 顯示預設的投放展開媒體控制項。更多...
 

類別方法摘要

(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:
使用 deckCastinstructionsViewControllerOnceWithCastButton:

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

- (BOOL) presentCastInstructionsViewControllerOnceWithCastButton: (GCKUICastButton *)  castButton

如果先前尚未顯示,會顯示全螢幕強制回應檢視控制器,藉此將焦點告知「投放」按鈕、已接收其檢視畫面,並顯示關於使用方式的簡短說明。

傳回
YES 如果系統顯示了檢視控制器,如果系統先前並未顯示該控制項,則顯示 NO。如果找不到「投放」按鈕,也會傳回 NO
開始時間
4.1

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

- (void) clearCastInstructionsShownFlag

清除常駐旗標,用於追蹤「投放操作說明」強制回應檢視控制器是否顯示。

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

- (void) presentDefaultExpandedMediaControls

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

由「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)」類別提供。