<GCKRemoteMediaClientListener> Protocol

  • The GCKRemoteMediaClientListener protocol is a listener protocol for the GCKRemoteMediaClient class, which controls media playback on a Cast receiver.

  • This protocol includes methods that are called when various media events occur on the receiver, such as when a new media session starts, or when media status, metadata, or queue information is updated.

  • Methods like remoteMediaClient:didStartMediaSessionWithID:, remoteMediaClient:didUpdateMediaStatus:, and remoteMediaClient:didUpdateMediaMetadata: provide updates on the current media playback.

  • Queue-related methods such as remoteMediaClientDidUpdateQueue:, remoteMediaClient:didReceiveQueueItemIDs:, and remoteMediaClient:didInsertQueueItemsWithIDs:beforeItemWithID: offer detailed insights into changes in the media playback queue.

  • Additional methods like remoteMediaClientDidUpdatePreloadStatus:, remoteMediaClient:didUpdateQueueItemsWithIDs:, and remoteMediaClient:didRemoveQueueItemsWithIDs: track preload status and modifications to queue items.
Instance Methods
<GCKRemoteMediaClientListener> Protocol Reference

Overview

The GCKRemoteMediaClient listener protocol.

Since
3.0

Inherits <NSObjectNSObject>.

Instance Method Summary

(void) - remoteMediaClient:didStartMediaSessionWithID:
 Called when a new media session has started on the receiver. More...
 
(void) - remoteMediaClient:didUpdateMediaStatus:
 Called when updated media status has been received from the receiver. More...
 
(void) - remoteMediaClient:didUpdateMediaMetadata:
 Called when updated media metadata has been received from the receiver. More...
 
(void) - remoteMediaClientDidUpdateQueue:
 Called when the media playback queue has been updated on the receiver. More...
 
(void) - remoteMediaClientDidUpdatePreloadStatus:
 Called when the media preload status has been updated on the receiver. More...
 
(void) - remoteMediaClient:didReceiveQueueItemIDs:
 Called when the list of media queue item IDs has been received. More...
 
(void) - remoteMediaClient:didInsertQueueItemsWithIDs:beforeItemWithID:
 Called when a contiguous sequence of items has been inserted into the media queue. More...
 
(void) - remoteMediaClient:didUpdateQueueItemsWithIDs:
 Called when existing items has been updated in the media queue. More...
 
(void) - remoteMediaClient:didRemoveQueueItemsWithIDs:
 Called when a contiguous sequence of items has been removed from the media queue. More...
 
(void) - remoteMediaClient:didReceiveQueueItems:
 Called when detailed information has been received for one or more items in the queue. More...
 

Method Detail

- (void) remoteMediaClient: (GCKRemoteMediaClient *)  client
didStartMediaSessionWithID: (NSInteger)  sessionID 
optional

Called when a new media session has started on the receiver.

Parameters
clientThe client.
sessionIDThe ID of the new session.
- (void) remoteMediaClient: (GCKRemoteMediaClient *)  client
didUpdateMediaStatus: (nullable GCKMediaStatus *)  mediaStatus 
optional

Called when updated media status has been received from the receiver.

Parameters
clientThe client.
mediaStatusThe updated media status. The status can also be accessed as a property of the player.
- (void) remoteMediaClient: (GCKRemoteMediaClient *)  client
didUpdateMediaMetadata: (nullable GCKMediaMetadata *)  mediaMetadata 
optional

Called when updated media metadata has been received from the receiver.

Parameters
clientThe client.
mediaMetadataThe updated media metadata. The metadata can also be accessed through the GCKRemoteMediaClient::mediaStatus property.
- (void) remoteMediaClientDidUpdateQueue: (GCKRemoteMediaClient *)  client
optional

Called when the media playback queue has been updated on the receiver.

Parameters
clientThe client.
- (void) remoteMediaClientDidUpdatePreloadStatus: (GCKRemoteMediaClient *)  client
optional

Called when the media preload status has been updated on the receiver.

Parameters
clientThe client.
- (void) remoteMediaClient: (GCKRemoteMediaClient *)  client
didReceiveQueueItemIDs: (NSArray< NSNumber * > *)  queueItemIDs 
optional

Called when the list of media queue item IDs has been received.

Parameters
clientThe client.
queueItemIDsThe list of media queue item IDs.
Since
4.1
- (void) remoteMediaClient: (GCKRemoteMediaClient *)  client
didInsertQueueItemsWithIDs: (NSArray< NSNumber * > *)  queueItemIDs
beforeItemWithID: (GCKMediaQueueItemID)  beforeItemID 
optional

Called when a contiguous sequence of items has been inserted into the media queue.

Parameters
clientThe client.
queueItemIDsThe item IDs of the inserted items.
beforeItemIDThe item ID of the item in front of which the new items have been inserted. If the value is kGCKMediaQueueInvalidItemID, it indicates that the items were appended at the end of the queue.
Since
4.1
- (void) remoteMediaClient: (GCKRemoteMediaClient *)  client
didUpdateQueueItemsWithIDs: (NSArray< NSNumber * > *)  queueItemIDs 
optional

Called when existing items has been updated in the media queue.

Parameters
clientThe client.
queueItemIDsThe item IDs of the updated items.
Since
4.1
- (void) remoteMediaClient: (GCKRemoteMediaClient *)  client
didRemoveQueueItemsWithIDs: (NSArray< NSNumber * > *)  queueItemIDs 
optional

Called when a contiguous sequence of items has been removed from the media queue.

Parameters
clientThe client.
queueItemIDsThe item IDs of the removed items.
Since
4.1
- (void) remoteMediaClient: (GCKRemoteMediaClient *)  client
didReceiveQueueItems: (NSArray< GCKMediaQueueItem * > *)  queueItems 
optional

Called when detailed information has been received for one or more items in the queue.

Parameters
clientThe client.
queueItemsThe queue items.
Since
4.1