GCKCastContext 类

GCKCastContext 类参考

概览

包含框架的全局对象和状态的类。

必须在应用生命周期的早期通过调用 setSharedInstanceWithOptions: (GCKCastContext) 来初始化上下文。

开始时间
3.0

此类继承 NSObject。

实例方法摘要

(void) - registerDeviceProvider:
 注册设备提供程序,该提供程序添加了对新型(非 Cast)设备的支持。更多...
 
(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

注册设备提供程序,该提供程序添加了对新型(非 Cast)设备的支持。

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 应用,凭据数据将在启动 intent 中传递给该应用。应用可以使用这些数据提供个性化用户体验。

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:
使用 presentCastInstructionsViewControllerOnceWithCastButton:.

由“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)”类别提供。