GCKCommon.h File

AI-generated Key Takeaways

• The GCKCommon.h file defines enums for Cast state, connection state, connection suspension reasons, active input status, and standby status.

• It includes an enum, GCKConnectionSuspendReason, which specifies the reasons behind a connection suspension, such as app backgrounding, network errors, and app termination.

• The file declares constants like kGCKFrameworkVersion for the framework version, kGCKInvalidRequestID representing an invalid request, and kGCKThreadException indicating an API call from an invalid thread.

• It contains typedefs for GCKConnectionState, GCKActiveInputStatus, GCKStandbyStatus, and GCKCastState, all of which are closed enums using NSInteger or NSUInteger.

Enumerations | Functions | Variables

GCKCommon.h File Reference

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

Enumerations
enum	GCKConnectionSuspendReason {   GCKConnectionSuspendReasonUnknown = -1, GCKConnectionSuspendReasonNone = 0, GCKConnectionSuspendReasonAppBackgrounded = 1, GCKConnectionSuspendReasonNetworkError = 2,   GCKConnectionSuspendReasonNetworkNotReachable = 3, GCKConnectionSuspendReasonAppTerminated = 4 }
	Enum defining the reasons for a connection becoming suspended. More...

Functions
typedef	NS_CLOSED_ENUM (NSInteger, GCKConnectionState)
typedef	NS_CLOSED_ENUM (NSInteger, GCKActiveInputStatus)
typedef	NS_CLOSED_ENUM (NSInteger, GCKStandbyStatus)
typedef	NS_CLOSED_ENUM (NSUInteger, GCKCastState)

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.

Enumeration Type Documentation

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.
GCKConnectionSuspendReasonAppTerminated	The connection was suspended because app was terminated while connected.

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.