Overview
An abstract base class representing a session with a receiver device.
Subclasses must implement the start (GCKSession(Protected)) and endWithAction: (GCKSession(Protected)) methods, and must call the appropriate notifier methods (for example, notifyDidStartWithSessionID: (GCKSession(Protected)) ) to indicate corresponding changes in the session state. Subclasses may also implement setDeviceVolume: (GCKSession) , setDeviceMuted: (GCKSession) and remoteMediaClient if the device supports such operations.
A session is created and controlled using the session methods in GCKSessionManager , which uses the appropriate GCKDeviceProvider to create the session, and then delegates session requests to that GCKSession object.
- Since
- 3.0
Inherits NSObject.
Inherited by GCKCastSession .
Method Detail
| - (instancetype) initWithDevice: | ( GCKDevice *) | device | |
| traits: | (nullable GCKSessionTraits *) | traits | |
| sessionID: | (nullable NSString *) | sessionID | |
Initializes a new session object for the given device, with default options.
- Parameters
-
device The device. traits The session traits. sessionID The session ID of an existing session, if this object will be used to resume a session; otherwise nilif it will be used to start a new session.
| - (instancetype) initWithDevice: | ( GCKDevice *) | device | |
| traits: | (nullable GCKSessionTraits *) | traits | |
| sessionID: | (nullable NSString *) | sessionID | |
| sessionOptions: | (nullable GCKSessionOptions *) | sessionOptions | |
Initializes a new session object for the given device.
- Parameters
-
device The device. traits The session traits. sessionID The session ID of an existing session, if this object will be used to resume a session; otherwise nilif it will be used to start a new session.sessionOptions The session options, if any; otherwise nil.
- Since
- 4.0
| - ( GCKRequest *) setDeviceVolume: | (float) | volume |
Sets the device's volume.
This is an asynchronous operation. The default implementation is a no-op that fails the request with a GCKErrorCodeUnsupportedFeature error.
- Parameters
- volumeThe new volume.
- Returns
- A GCKRequest object for tracking the request.
- Since
- 3.4; in previous framework versions, this method returned
void.
| - ( GCKRequest *) setDeviceMuted: | (BOOL) | muted |
Sets the device's mute state.
This is an asynchronous operation. The default implementation is a no-op that fails the request with a GCKErrorCodeUnsupportedFeature error.
- Parameters
- mutedThe new mute state.
- Returns
- A GCKRequest object for tracking the request.
- Since
- 3.4; in previous framework versions, this method returned
void.
| - (void) start |
Starts the session.
This is an asynchronous operation. Must be overridden by subclasses.
Provided by category GCKSession(Protected) .
| - (void) endWithAction: | ( GCKSessionEndAction ) | action |
Ends the session with the specified action.
This is an asynchronous operation. Must be overridden by subclasses.
- Parameters
- actionThe action to take when ending the session; see GCKSessionEndAction for more details.
Provided by category GCKSession(Protected) .
| - (void) notifyDidStartWithSessionID: | (NSString *) | sessionID |
Called by subclasses to notify the framework that the session has been started.
- Parameters
- sessionIDThe session's unique ID.
Provided by category GCKSession(Protected) .
| - (void) notifyDidFailToStartWithError: | ( GCKError *) | error |
Called by subclasses to notify the framework that the session has failed to start.
- Parameters
- errorThe error that occurred.
Provided by category GCKSession(Protected) .
| - (void) notifyDidEndWithError: | (nullable NSError *) | error | |
| willTryToResume: | (BOOL) | willTryToResume | |
Called by subclasses to notify the framework that the session has ended.
- Parameters
-
error The error that caused the session to end, if any. Should be nilif the session was ended intentionally.willTryToResume Whether the session will try to resume itself automatically.
Provided by category GCKSession(Protected) .
| - (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
-
volume The device's current volume. Must be in the range [0, 1.0]; muted The device's current mute state.
Provided by category GCKSession(Protected) .
| - (void) notifyDidReceiveDeviceStatus: | (nullable NSString *) | statusText |
Called by subclasses to notify the framework that updated status has been received from the device.
- Parameters
- statusTextThe new status.
Provided by category GCKSession(Protected) .
| - (void) notifyDidSuspendWithReason: | ( GCKConnectionSuspendReason ) | reason |
Deprecated, do not use - implemented as a no-op.
- Deprecated:
- Do not call.
Provided by category GCKSession(Protected) .
| - (void) notifyDidResume |
Deprecated, do not use - implemented as a no-op.
- Deprecated:
- Do not call.
Provided by category GCKSession(Protected) .
Property Detail
The device that this session is associated with.
The current session ID, if any.
The session options, if any.
- Since
- 4.0
The current session connection state.
A flag indicating whether the session is currently suspended.
- Deprecated:
- GCKSession no longer supports being in suspended state. If needed, move this functionality to a subclass.
The current device status text.
The session traits.
The current device volume, in the range [0.0, 1.0].
The current device mute state.
The GCKRemoteMediaClient object that can be used to control media playback in this session.
It is nil
before the session has started, or if the session does not support the GCKRemoteMediaClient
API. Subclasses which provide a GCKRemoteMediaClient
interface must override the getter method.
The current media metadata, if any.
Will be nil
if the session does not support the media namespace or if no media is currently loaded on the receiver.
