GCKCommon.h File

    • GCKCommon.h defines several enumerations related to Google Cast states and statuses, including connection states, connection suspension reasons, active input status, and standby status.

    • The file includes a macro and a function, both named GCKAssertMainThread, which are used to assert if the calling thread is the main thread.

    • Three variables are defined: kGCKFrameworkVersion (framework version string), kGCKInvalidRequestID (an indicator for an invalid request), and kGCKThreadException (an exception type for invalid thread API calls).

    • The GCKCastState enum describes the possible casting states for the sender application, ranging from no devices available to being connected.
    Macros | Enumerations | Functions | Variables
    GCKCommon.h File Reference

    GCKCastState, GCKConnectionState, GCKConnectionSuspendReason, GCKActiveInputStatus, and GCKStandbyStatus enums. More...

    Macros

    #define 
    GCK_ASSERT_MAIN_THREAD ()    GCKAssertMainThread (__PRETTY_FUNCTION__)
    Asserts if the calling thread is not the main thread. More...

    Enumerations

    enum  
    GCKConnectionState { GCKConnectionStateDisconnected = 0, GCKConnectionStateConnecting = 1, GCKConnectionStateConnected = 2, GCKConnectionStateDisconnecting = 3 }
    Enum defining Cast connection states. More...
    enum  
    GCKConnectionSuspendReason { GCKConnectionSuspendReasonAppBackgrounded = 1, GCKConnectionSuspendReasonNetworkError = 2, GCKConnectionSuspendReasonNetworkNotReachable = 3 }
    Enum defining the reasons for a connection becoming suspended. More...
    enum  
    GCKActiveInputStatus { GCKActiveInputStatusUnknown = -1, GCKActiveInputStatusInactive = 0, GCKActiveInputStatusActive = 1 }
    An enum describing the active input status states. More...
    enum  
    GCKStandbyStatus { GCKStandbyStatusUnknown = -1, GCKStandbyStatusInactive = 0, GCKStandbyStatusActive = 1 }
    An enum describing the standby status states. More...
    enum  
    GCKCastState { GCKCastStateNoDevicesAvailable = 0, GCKCastStateNotConnected = 1, GCKCastStateConnecting = 2, GCKCastStateConnected = 3 }
    An enum describing the possible casting states for the sender application. More...

    Functions

    void 
    GCKAssertMainThread (const char *function)
    Asserts if the calling thread is not the main thread. More...

    Variables

    NSString *const 
    kGCKFrameworkVersion
    A string constant containing the version number of the GoogleCast framework. More...
    const NSInteger 
    kGCKInvalidRequestID
    An invalid request ID; if a method returns this request ID, it means that the request could not be made. More...
    NSString *const 
    kGCKThreadException
    An exception type indicating that an API was called from an invalid thread. More...

    Detailed Description

    GCKCastState, GCKConnectionState, GCKConnectionSuspendReason, GCKActiveInputStatus, and GCKStandbyStatus enums.

    Macro Definition Documentation

    #define GCK_ASSERT_MAIN_THREAD ( ) GCKAssertMainThread (__PRETTY_FUNCTION__)

    Asserts if the calling thread is not the main thread.

    Enumeration Type Documentation

    enum GCKConnectionState

    Enum defining Cast connection states.

    Enumerator
    GCKConnectionStateDisconnected 

    Disconnected from the device or application.

    GCKConnectionStateConnecting 

    Connecting to the device or application.

    GCKConnectionStateConnected 

    Connected to the device or application.

    GCKConnectionStateDisconnecting 

    Disconnecting from the device.

    enum GCKConnectionSuspendReason

    Enum defining the reasons for a connection becoming suspended.

    Enumerator
    GCKConnectionSuspendReasonAppBackgrounded 

    The connection was suspended because the application is going into the background.

    GCKConnectionSuspendReasonNetworkError 

    The connection was suspended because of a network I/O or protocol error.

    GCKConnectionSuspendReasonNetworkNotReachable 

    The connection was suspended because the network is not reachable.

    enum GCKActiveInputStatus

    An enum describing the active input status states.

    This status indicates whether a receiver device is currently the active input on its connected TV or AVR.

    Enumerator
    GCKActiveInputStatusUnknown 

    The active input status is unknown.

    GCKActiveInputStatusInactive 

    The input is inactive.

    GCKActiveInputStatusActive 

    The input is active.

    enum GCKStandbyStatus

    An enum describing the standby status states.

    This status indicates whether a receiver device's connected TV or AVR is currently in "standby" mode.

    Enumerator
    GCKStandbyStatusUnknown 

    The standby status is unknown.

    GCKStandbyStatusInactive 

    The device is not in standby mode.

    GCKStandbyStatusActive 

    The device is in standby mode.

    enum GCKCastState

    An enum describing the possible casting states for the sender application.

    Enumerator
    GCKCastStateNoDevicesAvailable 

    No Cast session is established, and no Cast devices are available.

    GCKCastStateNotConnected 

    No Cast session is establishd, and Cast devices are available.

    GCKCastStateConnecting 

    A Cast session is being established.

    GCKCastStateConnected 

    A Cast session is established.

    Function Documentation

    void GCKAssertMainThread ( const char *  function )

    Asserts if the calling thread is not the main thread.

    Variable Documentation

    kGCKFrameworkVersion

    A string constant containing the version number of the GoogleCast framework.

    kGCKInvalidRequestID

    An invalid request ID; if a method returns this request ID, it means that the request could not be made.

    kGCKThreadException

    An exception type indicating that an API was called from an invalid thread.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: