GCKCommon.h File
Stay organized with collections
Save and categorize content based on your preferences.
GCKCastState, GCKConnectionState, GCKConnectionSuspendReason, GCKActiveInputStatus, and GCKStandbyStatus enums.
More...
|
|
typedef | NS_CLOSED_ENUM (NSInteger, GCKConnectionState) |
| |
|
typedef | NS_CLOSED_ENUM (NSInteger, GCKActiveInputStatus) |
| |
|
typedef | NS_CLOSED_ENUM (NSInteger, GCKStandbyStatus) |
| |
|
typedef | NS_CLOSED_ENUM (NSUInteger, GCKCastState) |
| |
GCKCastState, GCKConnectionState, GCKConnectionSuspendReason, GCKActiveInputStatus, and GCKStandbyStatus enums.
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.
|
A string constant containing the version number of the GoogleCast framework.
An invalid request ID; if a method returns this request ID, it means that the request could not be made.
An exception type indicating that an API was called from an invalid thread.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThe GCKCommon.h file defines enums for Cast state, connection state, connection suspension reasons, active input status, and standby status.\u003c/p\u003e\n"],["\u003cp\u003eIt includes an enum, \u003ccode\u003eGCKConnectionSuspendReason\u003c/code\u003e, which specifies the reasons behind a connection suspension, such as app backgrounding, network errors, and app termination.\u003c/p\u003e\n"],["\u003cp\u003eThe file declares constants like \u003ccode\u003ekGCKFrameworkVersion\u003c/code\u003e for the framework version, \u003ccode\u003ekGCKInvalidRequestID\u003c/code\u003e representing an invalid request, and \u003ccode\u003ekGCKThreadException\u003c/code\u003e indicating an API call from an invalid thread.\u003c/p\u003e\n"],["\u003cp\u003eIt contains typedefs for GCKConnectionState, GCKActiveInputStatus, GCKStandbyStatus, and GCKCastState, all of which are closed enums using NSInteger or NSUInteger.\u003c/p\u003e\n"]]],["This document outlines key elements within the GCKCommon.h file, which contains enumerations, functions, and variables related to Google Cast. The `GCKConnectionSuspendReason` enum details reasons for connection suspension, such as the app being backgrounded, network errors, network unreachability, or app termination. Other enums include `GCKCastState`, `GCKConnectionState`, `GCKActiveInputStatus`, and `GCKStandbyStatus`. Notable variables are `kGCKFrameworkVersion` (framework version), `kGCKInvalidRequestID` (for failed requests), and `kGCKThreadException` (invalid thread calls).\n"],null,["[Enumerations](#enum-members) \\| [Functions](#func-members) \\| [Variables](#var-members) \nGCKCommon.h File Reference \nGCKCastState, GCKConnectionState, GCKConnectionSuspendReason, GCKActiveInputStatus, and GCKStandbyStatus enums.\n[More...](#details)\n\n|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Enumerations ||\n| enum | [GCKConnectionSuspendReason](/cast/docs/reference/ios/g_c_k_common_8h#a9ac76146a1ad598bb34070e314876a37) { **GCKConnectionSuspendReasonUnknown** = -1, **GCKConnectionSuspendReasonNone** = 0, [GCKConnectionSuspendReasonAppBackgrounded](/cast/docs/reference/ios/g_c_k_common_8h#a9ac76146a1ad598bb34070e314876a37a3beae0a74cb6e012ea141e4de0b6f236) = 1, [GCKConnectionSuspendReasonNetworkError](/cast/docs/reference/ios/g_c_k_common_8h#a9ac76146a1ad598bb34070e314876a37af6a10736daef7dec6b223762c5e9ba32) = 2, [GCKConnectionSuspendReasonNetworkNotReachable](/cast/docs/reference/ios/g_c_k_common_8h#a9ac76146a1ad598bb34070e314876a37a31ee22db9cb40a6b6e8720569601997c) = 3, [GCKConnectionSuspendReasonAppTerminated](/cast/docs/reference/ios/g_c_k_common_8h#a9ac76146a1ad598bb34070e314876a37ab8059192a4d1f1e55bf9eebacff80cdc) = 4 } |\n| | Enum defining the reasons for a connection becoming suspended. [More...](/cast/docs/reference/ios/g_c_k_common_8h#a9ac76146a1ad598bb34070e314876a37) |\n| ||\n\n|---------|------------------------------------------------------|\n| Functions ||\n| typedef | **NS_CLOSED_ENUM** (NSInteger, GCKConnectionState) |\n| ||\n| typedef | **NS_CLOSED_ENUM** (NSInteger, GCKActiveInputStatus) |\n| ||\n| typedef | **NS_CLOSED_ENUM** (NSInteger, GCKStandbyStatus) |\n| ||\n| typedef | **NS_CLOSED_ENUM** (NSUInteger, GCKCastState) |\n| ||\n\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Variables ||\n| NSString \\*const | [kGCKFrameworkVersion](/cast/docs/reference/ios/g_c_k_common_8h#a7b9ba3834f883cf1a100a8da0fdc42b3) |\n| | A string constant containing the version number of the GoogleCast framework. [More...](#a7b9ba3834f883cf1a100a8da0fdc42b3) |\n| ||\n| const NSInteger | [kGCKInvalidRequestID](/cast/docs/reference/ios/g_c_k_common_8h#aad76567f243bc1b4fb113abd97bf3327) |\n| | An invalid request ID; if a method returns this request ID, it means that the request could not be made. [More...](#aad76567f243bc1b4fb113abd97bf3327) |\n| ||\n| NSString \\*const | [kGCKThreadException](/cast/docs/reference/ios/g_c_k_common_8h#a2b77feb60f085716a32a446407799c5c) |\n| | An exception type indicating that an API was called from an invalid thread. [More...](#a2b77feb60f085716a32a446407799c5c) |\n| ||\n\nDetailed Description \nGCKCastState, GCKConnectionState, GCKConnectionSuspendReason, GCKActiveInputStatus, and GCKStandbyStatus enums.\n\nEnumeration Type Documentation \n\n|---------------------------------------------------------------------------------------------------------------|\n| enum [GCKConnectionSuspendReason](/cast/docs/reference/ios/g_c_k_common_8h#a9ac76146a1ad598bb34070e314876a37) |\n\nEnum defining the reasons for a connection becoming suspended.\n\n| Enumerator ||\n|-----------------------------------------------|------------------------------------------------------------------------------------|\n| GCKConnectionSuspendReasonAppBackgrounded | The connection was suspended because the application is going into the background. |\n| GCKConnectionSuspendReasonNetworkError | The connection was suspended because of a network I/O or protocol error. |\n| GCKConnectionSuspendReasonNetworkNotReachable | The connection was suspended because the network is not reachable. |\n| GCKConnectionSuspendReasonAppTerminated | The connection was suspended because app was terminated while connected. |\n\nVariable Documentation \n\n|----------------------|\n| kGCKFrameworkVersion |\n\nA string constant containing the version number of the GoogleCast framework. \n\n|----------------------|\n| kGCKInvalidRequestID |\n\nAn invalid request ID; if a method returns this request ID, it means that the request could not be made. \n\n|---------------------|\n| kGCKThreadException |\n\nAn exception type indicating that an API was called from an invalid thread."]]