GCKMediaControlChannel クラス

インスタンス メソッド | プロパティ

GCKMediaControlChannel クラス リファレンス

概要

メディア コントロール オペレーションの GCKCastChannel サブクラス。

現在アクティブなストリーム（再生、一時停止、シーク、停止など）に適用されるオペレーションには、有効な（つまり nil 以外の）メディア ステータスが必要です。そうでない場合、kGCKInvalidRequestID が返され、リクエストは送信されません。メディア ステータスは、チャンネルが接続されると自動的にリクエストされ、読み込みが完了して正常に処理されると、いつでも更新できます。また、メディアのステータスが nil になってしまう場合もあります。たとえば、チャンネルが一時的に接続解除された場合などです。このチャネルを使用する場合、メディア ステータスの変化を mediaControlChannelDidUpdateStatus: (GCKMediaControlChannelDelegate-p) コールバックで監視する必要があります。ストリームを処理するメソッドは、メディア ステータスが nil でない場合にのみ呼び出す必要があります。

リクエストが正常に開始されると、対応するメソッドは、そのリクエストに割り当てられたリクエスト ID を返します。リクエストを開始できない場合、メソッドは kGCKInvalidRequestID を返し、lastError プロパティを設定して失敗の理由を示します。リクエストが正常に開始されたものの、最終的に失敗した場合は、mediaControlChannel:requestDidFailWithID:error: (GCKMediaControlChannelDelegate-p) コールバックが呼び出され、失敗が示されます。

デリゲート プロトコルについては、GCKMediaControlChannelDelegate をご覧ください。

Deprecated:

メディアの再生を制御するには、GCKCastSession の GCKRemoteMediaClient プロパティを使用します。

GCKCastChannel を継承します。

インスタンス メソッドの概要
(instancetype)	- init
	指定されたイニシャライザ。その他...
(NSInteger)	- loadMedia:
	新しいメディア アイテムの読み込みと開始を行います。その他...
(NSInteger)	- loadMedia:autoplay:
	新しいメディア アイテムの読み込みを開始し、必要に応じて再生を開始します。その他...
(NSInteger)	- loadMedia:autoplay:playPosition:
	新しいメディア アイテムの読み込みを開始し、必要に応じて再生を開始します。その他...
(NSInteger)	- loadMedia:autoplay:playPosition:customData:
	新しいメディア アイテムの読み込みを開始し、必要に応じて再生を開始します。その他...
(NSInteger)	- loadMedia:autoplay:playPosition:activeTrackIDs:
	新しいメディア アイテムの読み込みを開始し、必要に応じて再生を開始します。その他...
(NSInteger)	- loadMedia:autoplay:playPosition:activeTrackIDs:customData:
	新しいメディア アイテムの読み込みを開始し、必要に応じて再生を開始します。その他...
(NSInteger)	- setActiveTrackIDs:
	アクティブなトラックを設定します。その他...
(NSInteger)	- setTextTrackStyle:
	テキスト トラックのスタイルを設定します。その他...
(NSInteger)	- pause
	現在のメディア アイテムの再生を一時停止します。その他...
(NSInteger)	- pauseWithCustomData:
	現在のメディア アイテムの再生を一時停止します。その他...
(NSInteger)	- stop
	現在のメディア アイテムの再生を停止します。その他...
(NSInteger)	- stopWithCustomData:
	現在のメディア アイテムの再生を停止します。その他...
(NSInteger)	- play
	現在のメディア アイテムの再生を開始（または再開）します。その他...
(NSInteger)	- playWithCustomData:
	現在のメディア アイテムの再生を開始（または再開）します。その他...
(NSInteger)	- seekToTimeInterval:
	現在のメディア アイテム内の新しい位置をシークします。その他...
(NSInteger)	- seekToTimeInterval:resumeState:
	現在のメディア アイテム内の新しい位置をシークします。その他...
(NSInteger)	- seekToTimeInterval:resumeState:customData:
	現在のメディア アイテム内の新しい位置をシークします。その他...
(NSInteger)	- queueLoadItems:startIndex:repeatMode:
	メディア アイテムの新しいキューを読み込み、必要に応じて再生を開始します。その他...
(NSInteger)	- queueLoadItems:startIndex:repeatMode:customData:
	メディア アイテムの新しいキューを読み込み、必要に応じて再生を開始します。その他...
(NSInteger)	- queueLoadItems:startIndex:playPosition:repeatMode:customData:
	メディア アイテムの新しいキューを読み込み、必要に応じて再生を開始します。その他...
(NSInteger)	- queueInsertItems:beforeItemWithID:
	新しいメディア アイテムのリストをキューに追加します。その他...
(NSInteger)	- queueInsertItems:beforeItemWithID:customData:
	新しいメディア アイテムのリストをキューに追加します。その他...
(NSInteger)	- queueInsertItem:beforeItemWithID:
	単一のアイテムをキューに挿入する便利なメソッド。その他...
(NSInteger)	- queueInsertAndPlayItem:beforeItemWithID:
	単一のアイテムをキューに挿入して現在のアイテムにする便利なメソッド。その他...
(NSInteger)	- queueInsertAndPlayItem:beforeItemWithID:playPosition:customData:
	単一のアイテムをキューに挿入して現在のアイテムにする便利なメソッド。その他...
(NSInteger)	- queueUpdateItems:
	キューを更新します。その他...
(NSInteger)	- queueUpdateItems:customData:
	キューを更新します。その他...
(NSInteger)	- queueRemoveItemsWithIDs:
	メディア アイテムのリストをキューから削除します。その他...
(NSInteger)	- queueRemoveItemsWithIDs:customData:
	メディア アイテムのリストをキューから削除します。その他...
(NSInteger)	- queueRemoveItemWithID:
	1 つのアイテムをキューから削除する便利なメソッド。その他...
(NSInteger)	- queueReorderItemsWithIDs:insertBeforeItemWithID:
	キュー内のメディア アイテムのリストを並べ替える。その他...
(NSInteger)	- queueReorderItemsWithIDs:insertBeforeItemWithID:customData:
	キュー内のメディア アイテムのリストを並べ替える。その他...
(NSInteger)	- queueMoveItemWithID:beforeItemWithID:
	キュー内のアイテムを 1 つだけ移動する便利なメソッド。その他...
(NSInteger)	- queueJumpToItemWithID:
	キュー内で指定した ID のアイテムにジャンプします。その他...
(NSInteger)	- queueJumpToItemWithID:customData:
	キュー内で指定した ID のアイテムにジャンプします。その他...
(NSInteger)	- queueJumpToItemWithID:playPosition:customData:
	キュー内で指定した ID のアイテムにジャンプします。その他...
(NSInteger)	- queueNextItem
	キュー内の次の項目に移動します。その他...
(NSInteger)	- queuePreviousItem
	キュー内の前のアイテムに移動します。その他...
(NSInteger)	- queueSetRepeatMode:
	キューの繰り返しモードを設定します。その他...
(NSInteger)	- setStreamVolume:
	ストリームの音量を設定します。その他...
(NSInteger)	- setStreamVolume:customData:
	ストリームの音量を設定します。その他...
(NSInteger)	- setStreamMuted:
	ストリームがミュートされるかどうかを設定します。その他...
(NSInteger)	- setStreamMuted:customData:
	ストリームがミュートされるかどうかを設定します。その他...
(NSInteger)	- requestStatus
	受信者に更新されたメディア ステータス情報をリクエストします。その他...
(NSTimeInterval)	- approximateStreamPosition
	最後に受信したストリーム情報と、その更新後の経過時間から算出したおおよそのストリーム位置を返します。その他...
(BOOL)	- cancelRequestWithID:
	進行中のリクエストをキャンセルします。その他...
(instancetype)	- initWithNamespace:
	指定されたイニシャライザ。その他...
(void)	- didReceiveTextMessage:
	このチャンネルでテキスト メッセージを受信すると呼び出されます。その他...
(BOOL)	- sendTextMessage:
	このチャンネルでテキスト メッセージを送信します。その他...
(BOOL)	- sendTextMessage:error:
	このチャンネルでテキスト メッセージを送信します。その他...
(NSInteger)	- generateRequestID
	新しいメッセージのリクエスト ID を生成します。その他...
(NSNumber *__nullable)	- generateRequestNumber
	generateRequestID の結果を NSNumber でラップする便利なメソッド。その他...
(void)	- didConnect
	このチャンネルが接続されたときに呼び出されます。このチャンネルでキャスト デバイスとメッセージを送受信できます。その他...
(void)	- didDisconnect
	このチャンネルの接続が解除されたときに呼び出されます。現在はこのチャンネルでキャスト デバイスとメッセージを交換できないことを示します。その他...

プロパティの概要
GCKMediaStatus *	mediaStatus
	現在読み込まれているメディアのメディア ステータス（存在する場合）。それ以外の場合は nil。その他...
NSTimeInterval	timeSinceLastMediaStatusUpdate
	前回のメディア ステータスの更新を受信してから経過した時間です。その他...
GCKError *	lastError
	最後のリクエストの場合はエラーの詳細（ある場合）、最後のリクエストが成功した場合は nil。その他...
id< GCKMediaControlChannelDelegate >	delegate
	チャンネルの状態の変化に関する通知を受信するためのデリゲート。その他...
NSString *	protocolNamespace
	チャンネルの名前空間。その他...
BOOL	isConnected
	このチャンネルが現在接続されているかどうかを示すフラグ。その他...
GCKDeviceManager *	deviceManager
	チャンネルが登録されているデバイス マネージャー（ある場合）。その他...

メソッドの詳細

- (instancetype) init

指定されたイニシャライザ。

GCKCastChannel を実装します。

- (NSInteger) loadMedia:

(GCKMediaInformation *)

mediaInfo

新しいメディア アイテムの読み込みと開始を行います。

Parameters

mediaInfo

An object describing the media item to load.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) loadMedia:		(GCKMediaInformation *)	mediaInfo
autoplay:		(BOOL)	autoplay

新しいメディア アイテムの読み込みを開始し、必要に応じて再生を開始します。

Parameters

mediaInfo	An object describing the media item to load.
autoplay	Whether playback should start immediately.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) setActiveTrackIDs:

(NSArray< NSNumber * > *__nullable)

activeTrackIDs

アクティブなトラックを設定します。

現在のメディア ステータスがない場合、リクエストは失敗します。

Parameters

activeTrackIDs

An array of integers specifying the active tracks.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。アクティブなトラックを空のリストに設定する場合は、nil または空の配列にします。

- (NSInteger) setTextTrackStyle:

(GCKMediaTextTrackStyle *__nullable)

textTrackStyle

テキスト トラックのスタイルを設定します。

現在のメディア ステータスがない場合、リクエストは失敗します。

Parameters

textTrackStyle

The text track style. The style will not be changed if this is nil.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) pause

現在のメディア アイテムの再生を一時停止します。

現在のメディア ステータスがない場合、リクエストは失敗します。

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) stop

現在のメディア アイテムの再生を停止します。

現在のメディア ステータスがない場合、リクエストは失敗します。読み込み済みのキューは削除されます。

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) play

現在のメディア アイテムの再生を開始（または再開）します。

再生は常にストリームの最初に行われます。現在のメディア ステータスがない場合、リクエストは失敗します。

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) seekToTimeInterval:

(NSTimeInterval)

position

現在のメディア アイテム内の新しい位置をシークします。

現在のメディア ステータスがない場合、リクエストは失敗します。

Parameters

position

The new position from the beginning of the stream.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) seekToTimeInterval:		(NSTimeInterval)	position
resumeState:		(GCKMediaControlChannelResumeState)	resumeState

現在のメディア アイテム内の新しい位置をシークします。

現在のメディア ステータスがない場合、リクエストは失敗します。

Parameters

position	The new position interval from the beginning of the stream.
resumeState	The action to take after the seek operation has finished.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) seekToTimeInterval:		(NSTimeInterval)	position
resumeState:		(GCKMediaControlChannelResumeState)	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.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) queueLoadItems:		(NSArray< GCKMediaQueueItem * > *)	queueItems
startIndex:		(NSUInteger)	startIndex
repeatMode:		(GCKMediaRepeatMode)	repeatMode

メディア アイテムの新しいキューを読み込み、必要に応じて再生を開始します。

Parameters

queueItems	An array of GCKMediaQueueItem instances to load. Must not be nil or empty.
startIndex	The index of the item in the items array that should be played first.
repeatMode	The repeat mode for playing the queue.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) 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 nil or 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) 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 nil or 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) queueInsertItems:		(NSArray< GCKMediaQueueItem * > *)	queueItems
beforeItemWithID:		(NSUInteger)	beforeItemID

新しいメディア アイテムのリストをキューに追加します。

Parameters

queueItems	An array of GCKMediaQueueItem instances to insert. Must not be nil or 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) queueInsertItems:		(NSArray< GCKMediaQueueItem * > *)	queueItems
beforeItemWithID:		(NSUInteger)	beforeItemID
customData:		(id __nullable)	customData

新しいメディア アイテムのリストをキューに追加します。

Parameters

queueItems	An array of GCKMediaQueueItem instances to insert. Must not be nil or 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) queueUpdateItems:

(NSArray< GCKMediaQueueItem * > *)

queueItems

キューを更新します。

Parameters

queueItems

The list of updated items.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) queueRemoveItemsWithIDs:

(NSArray< NSNumber * > *)

itemIDs

メディア アイテムのリストをキューから削除します。

その結果、キューが空になると、現在のメディア セッションは終了します。

Parameters

itemIDs

An array of media item IDs identifying the items to remove. Must not be nil or empty.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) queueRemoveItemsWithIDs:		(NSArray< NSNumber * > *)	itemIDs
customData:		(id __nullable)	customData

メディア アイテムのリストをキューから削除します。

その結果、キューが空になると、現在のメディア セッションは終了します。

Parameters

itemIDs	An array of media item IDs identifying the items to remove. Must not be nil or 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) queueRemoveItemWithID:

(NSUInteger)

itemID

1 つのアイテムをキューから削除する便利なメソッド。

Parameters

itemID

The ID of the item to remove.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) queueReorderItemsWithIDs:		(NSArray< NSNumber * > *)	queueItemIDs
insertBeforeItemWithID:		(NSUInteger)	beforeItemID

キュー内のメディア アイテムのリストを並べ替える。

Parameters

queueItemIDs	An array of media item IDs identifying the items to reorder. Must not be nil or 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) 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 nil or 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) queueJumpToItemWithID:

(NSUInteger)

itemID

キュー内で指定した ID のアイテムにジャンプします。

Parameters

itemID

The ID of the item to jump to.

戻り値

このリクエストのリクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

このリクエストのリクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) queueNextItem

キュー内の次の項目に移動します。

戻り値

このリクエストのリクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) queuePreviousItem

キュー内の前のアイテムに移動します。

戻り値

このリクエストのリクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) queueSetRepeatMode:

(GCKMediaRepeatMode)

repeatMode

キューの繰り返しモードを設定します。

Parameters

repeatMode

The new repeat mode.

戻り値

このリクエストのリクエスト ID。メッセージを送信できない場合や、パラメータのいずれかが無効な場合は kGCKInvalidRequestID。

- (NSInteger) setStreamVolume:

(float)

volume

ストリームの音量を設定します。

現在のメディア セッションがない場合、リクエストは失敗します。

Parameters

volume

The new volume, in the range [0.0 - 1.0].

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) setStreamMuted:

(BOOL)

muted

ストリームがミュートされるかどうかを設定します。

現在のメディア セッションがない場合、リクエストは失敗します。

Parameters

muted

Whether the stream should be muted or unmuted.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) 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.

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) requestStatus

受信者に更新されたメディア ステータス情報をリクエストします。

戻り値

リクエスト ID。メッセージを送信できなかった場合は kGCKInvalidRequestID。

- (NSTimeInterval) approximateStreamPosition

最後に受信したストリーム情報と、その更新後の経過時間から算出したおおよそのストリーム位置を返します。

チャネルが接続されていない場合、またはメディアが現在読み込まれていない場合は、0 を返します。

- (BOOL) cancelRequestWithID:

(NSInteger)

requestID

進行中のリクエストをキャンセルします。

リクエストをキャンセルしても、リクエストが実行されるのを防ぐことはできません。呼び出し側アプリケーションがリクエストの結果に興味がないことを示すため、リクエストのトラッキングに関連する状態はすべて消去されます。

Parameters

requestID

The ID of the request to cancel.

戻り値

YES（リクエストがキャンセルされた場合）、NO（指定された ID でトラッキングされているリクエストがない場合）。

- (instancetype) initWithNamespace:

(NSString *)

protocolNamespace

指定されたイニシャライザ。

指定された名前空間を使用して新しい GCKCastChannel を作成します。

Parameters

protocolNamespace

The namespace.

GCKGenericChannel で実装。

- (void) didReceiveTextMessage:

(NSString *)

message

このチャンネルでテキスト メッセージを受信すると呼び出されます。

デフォルトの実装は NoOps です。

Parameters

message

The message.

- (BOOL) sendTextMessage:

(NSString *)

message

このチャンネルでテキスト メッセージを送信します。

Parameters

message

The message.

戻り値

YES（成功の場合）、またはメッセージを送信できなかった場合は NO（チャンネルが接続されていないか、現在送信バッファがいっぱいになっているため）。

Deprecated:

詳細なエラー情報を提供する sendTextMessage:error: を使用します。

- (BOOL) sendTextMessage:		(NSString *)	message
error:		(GCKError *__nullable *__nullable)	error

このチャンネルでテキスト メッセージを送信します。

Parameters

message	The message.
error	A pointer at which to store the error result. May be nil.

戻り値

成功の場合は

YES、メッセージを送信できなかった場合はNO。

- (NSInteger) generateRequestID

新しいメッセージのリクエスト ID を生成します。

戻り値

生成された ID。チャンネルが現在接続されていない場合は kGCKInvalidRequestID。

- (NSNumber * __nullable) generateRequestNumber

generateRequestID の結果を NSNumber でラップする便利なメソッド。

戻り値

生成された ID。チャンネルが現在接続されていない場合は nil。

- (void) didConnect

このチャンネルが接続されたときに呼び出されます。このチャンネルでキャスト デバイスとメッセージを送受信できます。

デフォルトの実装は NoOps です。

- (void) didDisconnect

このチャンネルの接続が解除されたときに呼び出されます。現在はこのチャンネルでキャスト デバイスとメッセージを交換できないことを示します。

デフォルトの実装は NoOps です。

プロパティの詳細

- (GCKMediaStatus*) mediaStatus

readnonatomicstrong

現在読み込まれているメディアのメディア ステータス（存在する場合）。それ以外の場合は nil。

- (NSTimeInterval) timeSinceLastMediaStatusUpdate

readnonatomicassign

前回のメディア ステータスの更新を受信してから経過した時間です。

ステータス リクエストが進行中の場合、0 です。

- (GCKError*) lastError

readnonatomiccopy

最後のリクエストの場合はエラーの詳細（ある場合）、最後のリクエストが成功した場合は nil。

- (id<GCKMediaControlChannelDelegate>) delegate

readwritenonatomicweak

チャンネルの状態の変化に関する通知を受信するためのデリゲート。

- (NSString*) protocolNamespace

readnonatomiccopyinherited

チャンネルの名前空間。

- (BOOL) isConnected

readnonatomicassigninherited

このチャンネルが現在接続されているかどうかを示すフラグ。

- (GCKDeviceManager*) deviceManager

readnonatomicweakinherited

チャンネルが登録されているデバイス マネージャー（ある場合）。

Deprecated:

このチャンネルが非推奨の GCKDeviceManager クラスに登録されていない場合、これは nil になります。