<GCKMediaControlChannelDelegate> Protocol

AI-generated Key Takeaways

• The GCKMediaControlChannelDelegate protocol defines methods that inform your application about the status of media playback and control requests.

• It provides callbacks for successful media loading, playback status updates, queue updates, metadata changes, and request completions.

• It also handles errors during media loading and request failures, providing details about the errors.

• Delegate methods are optional, allowing you to implement only the functionalities your application requires.

Instance Methods

<GCKMediaControlChannelDelegate> Protocol Reference

Overview

The GCKMediaControlChannel delegate protocol.

Inherits <GCKCastChannelNSObject>.

Instance Method Summary
(void)	- mediaControlChannel:didCompleteLoadWithSessionID:
	Called when a request to load media has completed. More...
(void)	- mediaControlChannel:didFailToLoadMediaWithError:
	Called when a request to load media has failed. More...
(void)	- mediaControlChannelDidUpdateStatus:
	Called when updated player status information is received. More...
(void)	- mediaControlChannelDidUpdateQueue:
	Called when updated queue status information is received. More...
(void)	- mediaControlChannelDidUpdatePreloadStatus:
	Called when updated preload status is received. More...
(void)	- mediaControlChannelDidUpdateMetadata:
	Called when updated media metadata is received. More...
(void)	- mediaControlChannel:requestDidCompleteWithID:
	Called when a request succeeds. More...
(void)	- mediaControlChannel:didReplaceRequestWithID:
	Called when a request is no longer being tracked because another request of the same type has been issued by the application. More...
(void)	- mediaControlChannel:didCancelRequestWithID:
	Called when a request is no longer being tracked because it has been explicitly cancelled. More...
(void)	- mediaControlChannel:requestDidFailWithID:error:
	Called when a request fails. More...

Method Detail

- (void) mediaControlChannel: (GCKMediaControlChannel *)  mediaControlChannel didCompleteLoadWithSessionID: (NSInteger)  sessionID

optional

Called when a request to load media has completed.

Parameters

mediaControlChannel	The channel.
sessionID	The unique media session ID that has been assigned to this media item.

- (void) mediaControlChannel: (GCKMediaControlChannel *)  mediaControlChannel didFailToLoadMediaWithError: (GCKError *)  error

optional

Called when a request to load media has failed.

Parameters

mediaControlChannel	The channel.
error	The load error.

- (void) mediaControlChannelDidUpdateStatus: (GCKMediaControlChannel *)  mediaControlChannel

optional

Called when updated player status information is received.

Parameters

mediaControlChannel

The channel.

- (void) mediaControlChannelDidUpdateQueue: (GCKMediaControlChannel *)  mediaControlChannel

optional

Called when updated queue status information is received.

Parameters

mediaControlChannel

The channel.

- (void) mediaControlChannelDidUpdatePreloadStatus: (GCKMediaControlChannel *)  mediaControlChannel

optional

Called when updated preload status is received.

Parameters

mediaControlChannel

The channel.

- (void) mediaControlChannelDidUpdateMetadata: (GCKMediaControlChannel *)  mediaControlChannel

optional

Called when updated media metadata is received.

Parameters

mediaControlChannel

The channel.

- (void) mediaControlChannel: (GCKMediaControlChannel *)  mediaControlChannel requestDidCompleteWithID: (NSInteger)  requestID

optional

Called when a request succeeds.

Parameters

mediaControlChannel	The channel.
requestID	The request ID that failed. This is the ID returned when the request was made.

- (void) mediaControlChannel: (GCKMediaControlChannel *)  mediaControlChannel didReplaceRequestWithID: (NSInteger)  requestID

optional

Called when a request is no longer being tracked because another request of the same type has been issued by the application.

Parameters

mediaControlChannel	The channel.
requestID	The request ID that has been replaced. This is the ID returned when the request was made.

- (void) mediaControlChannel: (GCKMediaControlChannel *)  mediaControlChannel didCancelRequestWithID: (NSInteger)  requestID

optional

Called when a request is no longer being tracked because it has been explicitly cancelled.

Parameters

mediaControlChannel	The channel.
requestID	The request ID that has been cancelled. This is the ID returned when the request was made.

- (void) mediaControlChannel: (GCKMediaControlChannel *)  mediaControlChannel requestDidFailWithID: (NSInteger)  requestID error: (GCKError *)  error

optional

Called when a request fails.

Parameters

mediaControlChannel	The channel.
requestID	The request ID that failed. This is the ID returned when the request was made.
error	The error. If any custom data was associated with the error, it will be in the error's userInfo dictionary with the key kGCKErrorCustomDataKey .