GCKSession(Protected) Category

GCKSession(Protected) Category Reference

Overview

Methods to be overridden and called by GCKSession subclasses only.

Since
3.0

Instance Method Summary

(void) - start
 Starts the session. More...
 
(void) - endAndStopCasting:
 Ends the session. More...
 
(void) - suspendWithReason:
 Suspends the session for the given reason. More...
 
(void) - resume
 Resumes the session. More...
 
(void) - notifyDidStartWithSessionID:
 Called by subclasses to notify the framework that the session has been started. More...
 
(void) - notifyDidFailToStartWithError:
 Called by subclasses to notify the framework that the session has failed to start. More...
 
(void) - notifyDidResume
 Called by subclasses to notify the framework that the session been resumed. More...
 
(void) - notifyDidSuspendWithReason:
 Called by subclasses to notify the framework that the session has been suspended. More...
 
(void) - notifyDidEndWithError:
 Called by subclasses to notify the framework that the session has ended. More...
 
(void) - notifyDidReceiveDeviceVolume:muted:
 Called by subclasses to notify the framework that updated device volume and mute state has been received from the device. More...
 
(void) - notifyDidReceiveDeviceStatus:
 Called by subclasses to notify the framework that updated status has been received from the device. More...
 

Method Detail

- (void) start

Starts the session.

This is an asynchronous operation. Must be overridden by subclasses.

Extends class GCKSession.

- (void) endAndStopCasting: (BOOL)  stopCasting

Ends the session.

This is an asynchronous operation. Must be overridden by subclasses.

Parameters
stopCastingWhether to stop casting content to the receiver.

Extends class GCKSession.

- (void) suspendWithReason: (GCKConnectionSuspendReason reason

Suspends the session for the given reason.

This is an asynchronous operation. Must be overridden by subclasses.

Extends class GCKSession.

- (void) resume

Resumes the session.

This is an asynchronous operation. Must be overridden by subclasses.

Extends class GCKSession.

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

Called by subclasses to notify the framework that the session has been started.

Parameters
sessionIDThe session's unique ID.

Extends class GCKSession.

- (void) notifyDidFailToStartWithError: (NSError *)  error

Called by subclasses to notify the framework that the session has failed to start.

Parameters
errorThe error that occurred.

Extends class GCKSession.

- (void) notifyDidResume

Called by subclasses to notify the framework that the session been resumed.

Extends class GCKSession.

- (void) notifyDidSuspendWithReason: (GCKConnectionSuspendReason reason

Called by subclasses to notify the framework that the session has been suspended.

Parameters
reasonThe reason for the suspension.

Extends class GCKSession.

- (void) notifyDidEndWithError: (NSError *__nullable)  error

Called by subclasses to notify the framework that the session has ended.

Parameters
errorThe error that caused the session to end, if any. Should be nil if the session was ended intentionally.

Extends class GCKSession.

- (void) notifyDidReceiveDeviceVolume: (float)  volume
muted: (BOOL)  muted 

Called by subclasses to notify the framework that updated device volume and mute state has been received from the device.

Parameters
volumeThe device's current volume. Must be in the range [0, 1.0];
mutedThe device's current mute state.

Extends class GCKSession.

- (void) notifyDidReceiveDeviceStatus: (NSString *__nullable)  statusText

Called by subclasses to notify the framework that updated status has been received from the device.

Parameters
statusTextThe new status.

Extends class GCKSession.

Send feedback about...