GCKRemoteMediaClient クラス リファレンス
概要
キャスト レシーバーでのメディア再生を制御するためのクラス。
このクラスは、サポートが終了する GCKMediaControlChannel と同じ機能を提供しますが、より便利な API を使用します。主な違いは次のとおりです。
- 各リクエストは、専用のデリゲートで追跡できる GCKRequest オブジェクトで表されます。
- GCKRemoteMediaClient は、1 つのデリゲートではなく、複数のリスナーをサポートします。
- シンセ
- 3.0
NSObject を継承します。
プロパティの概要 | |
| BOOL | connected |
| このオブジェクトがセッションに接続されているかどうかを示すフラグ。その他... | |
| GCKMediaStatus * | mediaStatus |
| メディア コントロール チャネルによって報告された現在のメディアのステータス。その他... | |
| NSTimeInterval | timeSinceLastMediaStatusUpdate |
| 前回のメディア ステータスの更新を受信してから経過した時間です。その他... | |
| id< GCKRemoteMediaClientAdInfoParserDelegate > | adInfoParserDelegate |
| GCKMediaStatus オブジェクトのカスタムデータから広告ブレーク情報を抽出できるデリゲート。その他... | |
メソッドの詳細
| - (void) addListener: | (id< GCKRemoteMediaClientListener >) | listener |
このオブジェクトのリスナーリストにリスナーを追加します。
- Parameters
-
listener The listener to add.
| - (void) removeListener: | (id< GCKRemoteMediaClientListener >) | listener |
このオブジェクトのリスナーリストから、リスナーを削除します。
- Parameters
-
listener The listener to remove.
| - (GCKRequest *) loadMedia: | (GCKMediaInformation *) | mediaInfo |
新しいメディア アイテムの読み込みと開始を行います。
- Parameters
-
mediaInfo An object describing the media item to load.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) loadMedia: | (GCKMediaInformation *) | mediaInfo | |
| autoplay: | (BOOL) | autoplay | |
新しいメディア アイテムの読み込みを開始し、必要に応じて再生を開始します。
- Parameters
-
mediaInfo An object describing the media item to load. autoplay Whether playback should start immediately.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) loadMedia: | (GCKMediaInformation *) | mediaInfo | |
| autoplay: | (BOOL) | autoplay | |
| playPosition: | (NSTimeInterval) | playPosition | |
新しいメディア アイテムの読み込みを開始し、必要に応じて再生を開始します。
- Parameters
-
mediaInfo An object describing the media item to load. autoplay Whether playback should start immediately. playPosition The initial playback position.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) loadMedia: | (GCKMediaInformation *) | mediaInfo | |
| autoplay: | (BOOL) | autoplay | |
| playPosition: | (NSTimeInterval) | playPosition | |
| customData: | (id __nullable) | customData | |
新しいメディア アイテムの読み込みを開始し、必要に応じて再生を開始します。
- Parameters
-
mediaInfo An object describing the media item to load. autoplay Whether playback should start immediately. playPosition The initial playback position. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) loadMedia: | (GCKMediaInformation *) | mediaInfo | |
| autoplay: | (BOOL) | autoplay | |
| playPosition: | (NSTimeInterval) | playPosition | |
| activeTrackIDs: | (NSArray< NSNumber * > *__nullable) | activeTrackIDs | |
新しいメディア アイテムの読み込みを開始し、必要に応じて再生を開始します。
- Parameters
-
mediaInfo An object describing the media item to load. autoplay Whether playback should start immediately. playPosition The initial playback position. activeTrackIDs An array of integers specifying the active tracks. May be nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) loadMedia: | (GCKMediaInformation *) | mediaInfo | |
| autoplay: | (BOOL) | autoplay | |
| playPosition: | (NSTimeInterval) | playPosition | |
| activeTrackIDs: | (NSArray< NSNumber * > *__nullable) | activeTrackIDs | |
| customData: | (id __nullable) | customData | |
新しいメディア アイテムの読み込みを開始し、必要に応じて再生を開始します。
- Parameters
-
mediaInfo An object describing the media item to load. autoplay Whether playback should start immediately. playPosition The initial playback position. activeTrackIDs An array of integers specifying the active tracks. May be nil.customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) setActiveTrackIDs: | (NSArray< NSNumber * > *__nullable) | activeTrackIDs |
アクティブなトラックを設定します。
現在のメディア ステータスがない場合、リクエストは失敗します。
- Parameters
-
activeTrackIDs An array of integers specifying the active tracks. May be empty or nilto disable any currently active tracks.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) setTextTrackStyle: | (GCKMediaTextTrackStyle *__nullable) | textTrackStyle |
テキスト トラックのスタイルを設定します。
現在のメディア ステータスがない場合、リクエストは失敗します。
- Parameters
-
textTrackStyle The text track style. The style will not be changed if this is nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) pause |
| - (GCKRequest *) pauseWithCustomData: | (id __nullable) | customData |
現在のメディア アイテムの再生を一時停止します。
現在のメディア ステータスがない場合、リクエストは失敗します。
- Parameters
-
customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) stop |
現在のメディア アイテムの再生を停止します。
読み込み済みのキューは削除されます。現在のメディア ステータスがない場合、リクエストは失敗します。
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) stopWithCustomData: | (id __nullable) | customData |
現在のメディア アイテムの再生を停止します。
読み込み済みのキューは削除されます。現在のメディア ステータスがない場合、リクエストは失敗します。
- Parameters
-
customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) play |
現在のメディア アイテムの再生を開始（または再開）します。
再生は常にストリームの最初に行われます。現在のメディア ステータスがない場合、リクエストは失敗します。
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) playWithCustomData: | (id __nullable) | customData |
現在のメディア アイテムの再生を開始（または再開）します。
再生は常にストリームの最初に行われます。現在のメディア ステータスがない場合、リクエストは失敗します。
- Parameters
-
customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) seekToTimeInterval: | (NSTimeInterval) | position |
現在のメディア アイテム内の新しい位置をシークします。
現在のメディア ステータスがない場合、リクエストは失敗します。
- Parameters
-
position The new position from the beginning of the stream.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) seekToTimeInterval: | (NSTimeInterval) | position | |
| resumeState: | (GCKMediaResumeState) | resumeState | |
現在のメディア アイテム内の新しい位置をシークします。
現在のメディア ステータスがない場合、リクエストは失敗します。
- Parameters
-
position The new position interval from the beginning of the stream. resumeState The action to take after the seek operation has finished.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) seekToTimeInterval: | (NSTimeInterval) | position | |
| resumeState: | (GCKMediaResumeState) | resumeState | |
| customData: | (id __nullable) | customData | |
現在のメディア アイテム内の新しい位置をシークします。
現在のメディア ステータスがない場合、リクエストは失敗します。
- Parameters
-
position The new position from the beginning of the stream. resumeState The action to take after the seek operation has finished. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueLoadItems: | (NSArray< GCKMediaQueueItem * > *) | queueItems | |
| startIndex: | (NSUInteger) | startIndex | |
| repeatMode: | (GCKMediaRepeatMode) | repeatMode | |
メディア アイテムの新しいキューを読み込み、必要に応じて再生を開始します。
- Parameters
-
queueItems An array of GCKMediaQueueItem instances to load. Must not be nilor empty.startIndex The index of the item in the items array that should be played first. repeatMode The repeat mode for playing the queue.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueLoadItems: | (NSArray< GCKMediaQueueItem * > *) | queueItems | |
| startIndex: | (NSUInteger) | startIndex | |
| repeatMode: | (GCKMediaRepeatMode) | repeatMode | |
| customData: | (id __nullable) | customData | |
メディア アイテムの新しいキューを読み込み、必要に応じて再生を開始します。
- Parameters
-
queueItems An array of GCKMediaQueueItem instances to load. Must not be nilor empty.startIndex The index of the item in the items array that should be played first. repeatMode The repeat mode for playing the queue. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueLoadItems: | (NSArray< GCKMediaQueueItem * > *) | queueItems | |
| startIndex: | (NSUInteger) | startIndex | |
| playPosition: | (NSTimeInterval) | playPosition | |
| repeatMode: | (GCKMediaRepeatMode) | repeatMode | |
| customData: | (id __nullable) | customData | |
メディア アイテムの新しいキューを読み込み、必要に応じて再生を開始します。
- Parameters
-
queueItems An array of GCKMediaQueueItem instances to load. Must not be nilor empty.startIndex The index of the item in the items array that should be played first. playPosition The initial playback position for the item when it is first played, relative to the beginning of the stream. This value is ignored when the same item is played again, for example when the queue repeats, or the item is later jumped to. In those cases the item's startTime is used. repeatMode The repeat mode for playing the queue. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueInsertItems: | (NSArray< GCKMediaQueueItem * > *) | queueItems | |
| beforeItemWithID: | (NSUInteger) | beforeItemID | |
新しいメディア アイテムのリストをキューに追加します。
- Parameters
-
queueItems An array of GCKMediaQueueItem instances to insert. Must not be nilor empty.beforeItemID The ID of the item that will be located immediately after the inserted list. If the value is kGCKMediaQueueInvalidItemID, the inserted list will be appended to the end of the queue.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueInsertItems: | (NSArray< GCKMediaQueueItem * > *) | queueItems | |
| beforeItemWithID: | (NSUInteger) | beforeItemID | |
| customData: | (id __nullable) | customData | |
新しいメディア アイテムのリストをキューに追加します。
- Parameters
-
queueItems An array of GCKMediaQueueItem instances to insert. Must not be nilor empty.beforeItemID ID of the item that will be located immediately after the inserted list. If the value is kGCKMediaQueueInvalidItemID, the inserted list will be appended to the end of the queue. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueInsertItem: | (GCKMediaQueueItem *) | item | |
| beforeItemWithID: | (NSUInteger) | beforeItemID | |
単一のアイテムをキューに挿入する便利なメソッド。
- Parameters
-
item The item to insert. beforeItemID The ID of the item that will be located immediately after the inserted item. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the inserted item will be appended to the end of the queue.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueInsertAndPlayItem: | (GCKMediaQueueItem *) | item | |
| beforeItemWithID: | (NSUInteger) | beforeItemID | |
単一のアイテムをキューに挿入して現在のアイテムにする便利なメソッド。
- Parameters
-
item The item to insert. beforeItemID The ID of the item that will be located immediately after the inserted item. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the inserted item will be appended to the end of the queue.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueInsertAndPlayItem: | (GCKMediaQueueItem *) | item | |
| beforeItemWithID: | (NSUInteger) | beforeItemID | |
| playPosition: | (NSTimeInterval) | playPosition | |
| customData: | (id __nullable) | customData | |
単一のアイテムをキューに挿入して現在のアイテムにする便利なメソッド。
- Parameters
-
item The item to insert. beforeItemID The ID of the item that will be located immediately after the inserted item. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the inserted item will be appended to the end of the queue. playPosition The initial playback position for the item when it is first played, relative to the beginning of the stream. This value is ignored when the same item is played again, for example when the queue repeats, or the item is later jumped to. In those cases the item's startTime is used. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueUpdateItems: | (NSArray< GCKMediaQueueItem * > *) | queueItems |
キューを更新します。
- Parameters
-
queueItems The list of updated items.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueUpdateItems: | (NSArray< GCKMediaQueueItem * > *) | queueItems | |
| customData: | (id __nullable) | customData | |
キューを更新します。
- Parameters
-
queueItems The list of updated items. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueRemoveItemsWithIDs: | (NSArray< NSNumber * > *) | itemIDs |
メディア アイテムのリストをキューから削除します。
その結果、キューが空になると、現在のメディア セッションは終了します。
- Parameters
-
itemIDs An array of media item IDs identifying the items to remove. Must not be nilor empty.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueRemoveItemsWithIDs: | (NSArray< NSNumber * > *) | itemIDs | |
| customData: | (id __nullable) | customData | |
メディア アイテムのリストをキューから削除します。
その結果、キューが空になると、現在のメディア セッションは終了します。
- Parameters
-
itemIDs An array of media item IDs identifying the items to remove. Must not be nilor empty.customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueRemoveItemWithID: | (NSUInteger) | itemID |
1 つのアイテムをキューから削除する便利なメソッド。
- Parameters
-
itemID The ID of the item to remove.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueReorderItemsWithIDs: | (NSArray< NSNumber * > *) | queueItemIDs | |
| insertBeforeItemWithID: | (NSUInteger) | beforeItemID | |
キュー内のメディア アイテムのリストを並べ替える。
- Parameters
-
queueItemIDs An array of media item IDs identifying the items to reorder. Must not be nilor empty.beforeItemID ID of the item that will be located immediately after the reordered list. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the reordered list will be appended at the end of the queue.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueReorderItemsWithIDs: | (NSArray< NSNumber * > *) | queueItemIDs | |
| insertBeforeItemWithID: | (NSUInteger) | beforeItemID | |
| customData: | (id __nullable) | customData | |
キュー内のメディア アイテムのリストを並べ替える。
- Parameters
-
queueItemIDs An array of media item IDs identifying the items to reorder. Must not be nilor empty.beforeItemID The ID of the item that will be located immediately after the reordered list. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the reordered list will be moved to the end of the queue. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueMoveItemWithID: | (NSUInteger) | itemID | |
| beforeItemWithID: | (NSUInteger) | beforeItemID | |
キュー内のアイテムを 1 つだけ移動する便利なメソッド。
- Parameters
-
itemID The ID of the item to move. beforeItemID The ID of the item that will be located immediately after the reordered list. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the item will be moved to the end of the queue.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueJumpToItemWithID: | (NSUInteger) | itemID |
キュー内で指定した ID のアイテムにジャンプします。
- Parameters
-
itemID The ID of the item to jump to.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueJumpToItemWithID: | (NSUInteger) | itemID | |
| customData: | (id __nullable) | customData | |
キュー内で指定した ID のアイテムにジャンプします。
- Parameters
-
itemID The ID of the item to jump to. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueJumpToItemWithID: | (NSUInteger) | itemID | |
| playPosition: | (NSTimeInterval) | playPosition | |
| customData: | (id __nullable) | customData | |
キュー内で指定した ID のアイテムにジャンプします。
- Parameters
-
itemID The ID of the item to jump to. playPosition The initial playback position for the item when it is first played, relative to the beginning of the stream. This value is ignored when the same item is played again, for example when the queue repeats, or the item is later jumped to. In those cases the item's startTime is used. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueNextItem |
キュー内の次の項目に移動します。
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queuePreviousItem |
キュー内の前のアイテムに移動します。
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) queueSetRepeatMode: | (GCKMediaRepeatMode) | repeatMode |
キューの繰り返しモードを設定します。
- Parameters
-
repeatMode The new repeat mode.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) setStreamVolume: | (float) | volume |
ストリームの音量を設定します。
現在のメディア セッションがない場合、リクエストは失敗します。
- Parameters
-
volume The new volume, in the range [0.0 - 1.0].
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) setStreamVolume: | (float) | volume | |
| customData: | (id __nullable) | customData | |
ストリームの音量を設定します。
現在のメディア セッションがない場合、リクエストは失敗します。
- Parameters
-
volume The new volume, in the range [0.0 - 1.0]. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) setStreamMuted: | (BOOL) | muted |
ストリームがミュートされるかどうかを設定します。
現在のメディア セッションがない場合、リクエストは失敗します。
- Parameters
-
muted Whether the stream should be muted or unmuted.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) setStreamMuted: | (BOOL) | muted | |
| customData: | (id __nullable) | customData | |
ストリームがミュートされるかどうかを設定します。
現在のメディア セッションがない場合、リクエストは失敗します。
- Parameters
-
muted Whether the stream should be muted or unmuted. customData Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (GCKRequest *) requestStatus |
受信者に更新されたメディア ステータス情報をリクエストします。
- 戻り値
- このリクエストをトラッキングするための GCKRequest オブジェクト。
| - (NSTimeInterval) approximateStreamPosition |
最後に受信したストリーム情報と、その更新後の経過時間から算出したおおよそのストリーム位置を返します。
チャネルが接続されていない場合、またはメディアが現在読み込まれていない場合は、0 を返します。
| - (void) notifyDidStartMediaSession |
サブクラスがメディア セッションを開始するたびに、つまりリモート プレーヤーに新しいメディアが正常に読み込まれた直後に呼び出されます。
カテゴリ GCKRemoteMediaClient(Protected) によって提供されます。
| - (void) notifyDidUpdateMediaStatus |
クライアントの mediaStatus オブジェクトが変化すると、サブクラスによって呼び出されます。
カテゴリ GCKRemoteMediaClient(Protected) によって提供されます。
| - (void) notifyDidUpdateQueue |
クライアントによって管理されるメディアキューが変更されたときにサブクラスによって呼び出されます。
カテゴリ GCKRemoteMediaClient(Protected) によって提供されます。
| - (void) notifyDidUpdatePreloadStatus |
クライアントの mediaStatus が GCKMediaStatus::preloadedItemID に変更されるたびに、サブクラスによって呼び出されます。
カテゴリ GCKRemoteMediaClient(Protected) によって提供されます。
| - (void) notifyDidUpdateMetadata |
メタデータが変更されるたびに、サブクラスによって呼び出されます。
カテゴリ GCKRemoteMediaClient(Protected) によって提供されます。
プロパティの詳細
|
readnonatomicassign |
このオブジェクトがセッションに接続されているかどうかを示すフラグ。
|
readnonatomicstrong |
メディア コントロール チャネルによって報告された現在のメディアのステータス。
|
readnonatomicassign |
前回のメディア ステータスの更新を受信してから経過した時間です。
ステータス リクエストが進行中の場合、0 です。
|
readwritenonatomicweak |
GCKMediaStatus オブジェクトのカスタムデータから広告ブレーク情報を抽出できるデリゲート。
- Deprecated:
- 代わりに GCKAdBreakStatus を使用してください。