GCKCastContext 类

GCKCastContext 类参考文档

概览

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

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

辛塞
3.0

此类继承 NSObject。

实例方法摘要

(void) - registerDeviceProvider:
 注册设备提供程序,以添加对新型(非 Cast)设备的支持。更多...
 
(void) - unregisterDeviceProviderForCategory:
 为指定设备类别取消注册设备提供程序。更多...
 
(void) - presentCastDialog
 显示“投放”对话框。更多...
 
(GCKUICastContainerViewController *) - createCastContainerControllerForViewController:
 构建一个嵌入指定视图控制器的 GCKUICastContainerViewController更多...
 
(GCKUIMiniMediaControlsViewController *) - createMiniMediaControlsViewController
 构造一个 GCKUIMiniMediaControlsViewController更多...
 
(BOOL) - presentCastInstructionsViewControllerOnce
 如果之前没有显示过,则显示一个全屏模态视图控制器,用于调用“投放”按钮,并显示一些关于其用法的简要说明文本。更多...
 
(void) - clearCastInstructionsShownFlag
 清除指示 Cast 指令模态视图控制器是否已显示永久标志。更多...
 
(void) - presentDefaultExpandedMediaControls
 显示默认的 Cast 展开媒体控件。更多...
 

类方法摘要

(void) + setSharedInstanceWithOptions:
 设置共享实例,提供 Cast 选项对象。更多...
 
(instancetype) + sharedInstance
 返回单例实例。更多...
 
(BOOL) + isSharedInstanceInitialized
 用于测试单例实例是否已初始化。更多...
 

公共属性

NSString *const kGCKNotificationKeyCastState
 Cast 状态更改通知中新 Cast 状态的 userInfo 键。更多...
 
NSString *const kGCKCastStateDidChangeNotification
 要在投放状态发生变化时发布的通知的名称。更多...
 
NSString *const kGCKUICastDialogWillShowNotification
 要在“投射”对话框显示时显示的通知名称。更多...
 
NSString *const kGCKUICastDialogDidHideNotification
 “投射”对话框关闭后将发布的通知的名称。更多...
 

属性摘要

GCKCastState castState
 应用的当前投放状态。更多...
 
GCKDiscoveryManagerdiscoveryManager
 发现管理器。更多...
 
GCKSessionManagersessionManager
 会话管理器。更多...
 
id< GCKUIImageCacheimageCache
 图片缓存实现,框架将用它来提取媒体元数据中引用的图片。更多...
 
id< GCKUIImagePickerimagePicker
 将用于选择特定用途的图片的图片选择器实现。更多...
 
BOOL useDefaultExpandedMediaControls
 配置当存在用户操作时应使展开后控件呈现的框架的行为。更多...
 
GCKUIExpandedMediaControlsViewControllerdefaultExpandedMediaControlsViewController
 默认 Cast 展开后的媒体控件视图控制器的实例。更多...
 

方法详细信息

+ (void) setSharedInstanceWithOptions: (GCKCastOptions *)  options

设置共享实例,提供 Cast 选项对象。

如果共享实例已初始化,则会抛出异常。此方法必须在主线程上调用。

+ (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) presentCastDialog

显示“投放”对话框。

由类别“GCKCastContext(UI)”提供。

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

构建一个嵌入指定视图控制器的 GCKUICastContainerViewController

由类别“GCKCastContext(UI)”提供。

- (GCKUIMiniMediaControlsViewController *) createMiniMediaControlsViewController

构造一个 GCKUIMiniMediaControlsViewController

由类别“GCKCastContext(UI)”提供。

- (BOOL) presentCastInstructionsViewControllerOnce

如果之前没有显示过,则显示一个全屏模态视图控制器,用于调用“投放”按钮,并显示一些关于其用法的简要说明文本。

返回
如果视图控制器已显示,则为
YES;如果未显示该控制器,则为 NO,因为之前已显示过。

由类别“GCKCastContext(UI)”提供。

- (void) clearCastInstructionsShownFlag

清除指示 Cast 指令模态视图控制器是否已显示永久标志。

由类别“GCKCastContext(UI)”提供。

- (void) presentDefaultExpandedMediaControls

显示默认的 Cast 展开媒体控件。

由类别“GCKCastContext(UI)”提供。

成员数据文档

- (NSString* const) kGCKNotificationKeyCastState

Cast 状态更改通知中新 Cast 状态的 userInfo 键。

- (NSString* const) kGCKCastStateDidChangeNotification

要在投放状态发生变化时发布的通知的名称。

- (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,框架将仅触发 GCKUICastContainerViewController::kGCKExpandedMediaControlsTriggeredNotification

由类别“GCKCastContext(UI)”提供。

- (GCKUIExpandedMediaControlsViewController*) defaultExpandedMediaControlsViewController
readnonatomicstrong

默认 Cast 展开后的媒体控件视图控制器的实例。

由类别“GCKCastContext(UI)”提供。