GCKSession(Protected) Category

    • GCKSession(Protected) category contains methods to be overridden and called only by GCKSession subclasses.

    • Subclasses must override the start and endWithAction: methods, which are asynchronous operations for managing the session lifecycle.

    • Subclasses use notify methods to inform the framework about session events such as starting, failing to start, ending, receiving device volume and mute state, and receiving device status.

    • The notifyDidSuspendWithReason: and notifyDidResume methods are deprecated and should not be used.
    Instance Methods
    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) 
    - endWithAction:
    Ends the session with the specified action. 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) 
    - notifyDidEndWithError:willTryToResume:
    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...
    (void) 
    - notifyDidSuspendWithReason:
    Deprecated, do not use - implemented as a no-op. More...
    (void) 
    - notifyDidResume
    Deprecated, do not use - implemented as a no-op. More...

    Method Detail

    - (void) start

    Starts the session.

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

    Extends class GCKSession .

    - (void) endWithAction: ( GCKSessionEndAction )  action

    Ends the session with the specified action.

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

    Parameters
    action
    The action to take when ending the session; see GCKSessionEndAction for more details.

    Extends class GCKSession .

    - (void) notifyDidStartWithSessionID: (NSString *)  sessionID

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

    Parameters
    sessionID
    The session's unique ID.

    Extends class GCKSession .

    - (void) notifyDidFailToStartWithError: ( GCKError *)  error

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

    Parameters
    error
    The error that occurred.

    Extends class GCKSession .

    - (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 nil if the session was ended intentionally.
    willTryToResume Whether the session will try to resume itself automatically.

    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
    volume The device's current volume. Must be in the range [0, 1.0];
    muted The device's current mute state.

    Extends class GCKSession .

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

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

    Parameters
    statusText
    The new status.

    Extends class GCKSession .

    - (void) notifyDidSuspendWithReason: ( GCKConnectionSuspendReason )  reason

    Deprecated, do not use - implemented as a no-op.

    Deprecated:
    Do not call.

    Extends class GCKSession .

    - (void) notifyDidResume

    Deprecated, do not use - implemented as a no-op.

    Deprecated:
    Do not call.

    Extends class GCKSession .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: