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:
 キャスト オプション オブジェクトを指定して共有インスタンスを設定します。その他
 
(BOOL) + setSharedInstanceWithOptions:error:
 キャスト オプション オブジェクトを指定して共有インスタンスを設定します。その他
 
(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
 デフォルトのキャスト エキスパンド メディア コントロール ビュー コントローラのインスタンス。その他
 

メソッドの詳細

+ (void) setSharedInstanceWithOptions: (GCKCastOptions *)  options

キャスト オプション オブジェクトを指定して共有インスタンスを設定します。

共有インスタンスがすでに初期化されている場合、例外がスローされます。

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

キャスト オプション オブジェクトを指定して共有インスタンスを設定します。

コンテキストがすでに初期化されている場合、呼び出しは失敗します。このメソッドは、メインスレッドで呼び出す必要があります。

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:
presentCastInstructionsViewControllerOnceWithCastButton:

カテゴリ 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

デフォルトのキャスト エキスパンド メディア コントロール ビュー コントローラのインスタンス。

カテゴリ GCKCastContext(UI) から提供されます。