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:
 キャスト オプション オブジェクトを指定して、共有インスタンスを設定します。その他...
 
(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) で提供されます。