GCKError.h File

  • GCKError is a subclass of NSError used for framework errors, with GCKErrorCode providing a comprehensive list of potential issues.

  • GCKErrorCode covers a wide range of errors including network problems, device and session issues, media playback failures, and authentication errors.

  • Additional error information can be found in the userInfo dictionary of an NSError object using specific keys like kGCKErrorCustomDataKey and kGCKErrorDetailedCodeKey.

  • The kGCKErrorDomain defines the error domain for GCKErrorCode.
Classes | Enumerations | Variables
GCKError.h File Reference

Framework errors. More...

Classes

class  GCKError
 A subclass of NSError for framework errors. More...
 

Enumerations

enum  GCKErrorCode {
  GCKErrorCodeNoError = 0, GCKErrorCodeNetworkError = 1, GCKErrorCodeTimeout = 2, GCKErrorCodeDeviceAuthenticationFailure = 3,
  GCKErrorCodeInvalidRequest = 4, GCKErrorCodeCancelled = 5, GCKErrorCodeReplaced = 6, GCKErrorCodeNotAllowed = 7,
  GCKErrorCodeDuplicateRequest = 8, GCKErrorCodeInvalidState = 9, GCKErrorCodeSendBufferFull = 10, GCKErrorCodeMessageTooBig = 11,
  GCKErrorCodeChannelNotConnected = 12, GCKErrorCodeDeviceAuthorizationFailure = 13, GCKErrorCodeDeviceNotConnected = 14, GCKErrorCodeProtocolVersionMismatch = 15,
  GCKErrorCodeMaxUsersConnected = 16, GCKErrorCodeNetworkNotReachable = 17, GCKErrorCodeProtocolError = 18, GCKErrorCodeAlreadyInitialized = 19,
  GCKErrorCodeApplicationNotFound = 20, GCKErrorCodeApplicationNotRunning = 21, GCKErrorCodeInvalidApplicationSessionID = 22, GCKErrorCodeSecureTransportError = 23,
  GCKErrorCodeSocketAlreadyConnected = 24, GCKErrorCodeSocketInvalidAddress = 25, GCKErrorCodeSocketInvalidParameter = 26, GCKErrorCodeInvalidResponse = 27,
  GCKErrorCodeFailedSessionUpdate = 28, GCKErrorCodeSessionIsNotActive = 29, GCKErrorCodeMediaLoadFailed = 30, GCKErrorCodeInvalidMediaPlayerState = 31,
  GCKErrorCodeNoMediaSession = 32, GCKErrorCodeNotCastSession = 33, GCKErrorCodeMediaError = 34, GCKErrorCodeAuthenticationErrorReceived = 40,
  GCKErrorCodeMalformedClientCertificate = 41, GCKErrorCodeNotX509Certificate = 42, GCKErrorCodeDeviceCertificateNotTrusted = 43, GCKErrorCodeSSLCertificateNotTrusted = 44,
  GCKErrorCodeMalformedAuthenticationResponse = 45, GCKErrorCodeDeviceCapabilityNotSupported = 46, GCKErrorCodeCRLInvalid = 47, GCKErrorCodeCRLCheckFailed = 48,
  GCKErrorCodeBroadcastMessageEncryptionFailed = 50, GCKErrorCodeBroadcastKeyExchangeInvalidResponse = 51, GCKErrorCodeBroadcastKeyExchangeInvalidInput = 52, GCKErrorCodeBroadcastKeyExchangeEmptyResponse = 53,
  GCKErrorCodeBroadcastKeyExchangeRequestTimeout = 54, GCKErrorCodeBroadcastKeyExchangeFailedToFindDevice = 55, GCKErrorCodeBroadcastKeyExchangeFailedToConnect = 56, GCKErrorCodeBroadcastMessageDropped = 57,
  GCKErrorCodeBroadcastSocketError = 58, GCKErrorCodeBroadcastFailedToGenerateEncryptionKey = 59, GCKErrorCodeGuestModeListenFailed = 60, GCKErrorCodeRemoteDisplayError = 80,
  GCKErrorCodeRemoteDisplayDeviceNotSupported = 81, GCKErrorCodeRemoteDisplayFeatureNotSupported = 82, GCKErrorCodeRemoteDisplayConfigurationRejectedByReceiver = 83, GCKErrorCodeRemoteDisplayOpenGLError = 84,
  GCKErrorCodeRemoteDisplayMetalError = 85, GCKErrorCodeRemoteDisplayAudioConversionError = 86, GCKErrorCodeAppDidEnterBackground = 91, GCKErrorCodeDisconnected = 92,
  GCKErrorCodeUnsupportedFeature = 93, GCKErrorCodeUnknown = 99, GCKErrorCodeDeviceAuthenticationMessageParseFailure = 100, GCKErrorCodeDeviceAuthenticationMessageChallengeReceivedFailure = 101,
  GCKErrorCodeDeviceAuthenticationTimeoutFailure = 102, GCKErrorCodeLaunchRequestCancelled = 103, GCKErrorCodeApplicationNotRunningWithNamespaceMismatched = 104, GCKErrorCodeApplicationNotRunningWhenResumed = 105,
  GCKErrorCodeApplicationNotRunningForJoin = 106, GCKErrorCodeApplicationNotRunningForJoinWhenReconnecting = 107
}
 Framework error codes. More...
 

Variables

NSString *const kGCKErrorCustomDataKey
 The key for the customData JSON object associated with the error in the userInfo dictionary. More...
 
NSString *const kGCKErrorDetailedCodeKey
 The key for an API-specific detailed error code. More...
 
NSString *const kGCKErrorExtraInfoKey
 The key for extra error information, such as an API-specific error description. More...
 
NSString *const kGCKErrorReasonKey
 The key for an API-specific error reason. More...
 
NSString *const kGCKErrorDomain
 The error domain for GCKErrorCode. More...
 

Detailed Description

Framework errors.

Enumeration Type Documentation

enum GCKErrorCode

Framework error codes.

Enumerator
GCKErrorCodeNoError 

Error Code indicating no error.

GCKErrorCodeNetworkError 

Error code indicating a network I/O error.

GCKErrorCodeTimeout 

Error code indicating that an operation has timed out.

GCKErrorCodeDeviceAuthenticationFailure 

Error code indicating an authentication error.

GCKErrorCodeInvalidRequest 

Error code indicating that an invalid request was made.

GCKErrorCodeCancelled 

Error code indicating that an in-progress request has been cancelled, most likely because another action has preempted it.

GCKErrorCodeReplaced 

Error code indicating that a request has been replaced by another request of the same type.

GCKErrorCodeNotAllowed 

Error code indicating that the request was disallowed and could not be completed.

GCKErrorCodeDuplicateRequest 

Error code indicating that a request could not be made because the same type of request is still in process.

GCKErrorCodeInvalidState 

Error code indicating that the request is not allowed in the current state.

GCKErrorCodeSendBufferFull 

Error code indicating that data could not be sent because the send buffer is full.

GCKErrorCodeMessageTooBig 

Error indicating that the request could not be sent because the message exceeds the maximum allowed message size.

GCKErrorCodeChannelNotConnected 

Error indicating that a channel operation could not be completed because the channel is not currently connected.

GCKErrorCodeDeviceAuthorizationFailure 

Error indicating that the user is not authorized to use a Cast device.

GCKErrorCodeDeviceNotConnected 

Error indicating that a device request could not be completed because there is no connection currently established to the device.

GCKErrorCodeProtocolVersionMismatch 

Error indicating that there is a mismatch between the protocol versions being used on the sender and the receiver for a given namespace implementation.

GCKErrorCodeMaxUsersConnected 

Error indicating that the maximum number of users is already connected to the receiver.

GCKErrorCodeNetworkNotReachable 

Error indicating that the network is not reachable.

GCKErrorCodeProtocolError 

Error indicating a protocol error (invalid data received).

GCKErrorCodeAlreadyInitialized 

Error indicating that an attempt was made to initialize an already initialized singleton.

GCKErrorCodeApplicationNotFound 

Error code indicating that a requested application could not be found.

GCKErrorCodeApplicationNotRunning 

Error code indicating that a requested application is not currently running.

GCKErrorCodeInvalidApplicationSessionID 

Error code indicating that the application session ID was not valid.

GCKErrorCodeSecureTransportError 

Error code indicating a TLS error.

The underlying error is one of the error codes as documented here: https://developer.apple.com/library/mac/documentation/Security/Reference/secureTransportRef/

GCKErrorCodeSocketAlreadyConnected 

Error indicating that a connect attempt was made on a socket that is already connected.

GCKErrorCodeSocketInvalidAddress 

Error indicating that an invalid network or socket address or address type was supplied to a method or initializer.

GCKErrorCodeSocketInvalidParameter 

Error indicating that an invalid parameter was supplied to a method or initializer.

GCKErrorCodeInvalidResponse 

Error indicating that the response received was invalid.

GCKErrorCodeFailedSessionUpdate 

Error indicating that the session update went through, but all devices could not be moved.

GCKErrorCodeSessionIsNotActive 

Error indicating that a device request could not be completed because the current session is not active.

Since
4.4.5
GCKErrorCodeMediaLoadFailed 

Error code indicating that a media load failed on the receiver side.

GCKErrorCodeInvalidMediaPlayerState 

Error code indicating that a media media command failed because of the media player state.

GCKErrorCodeNoMediaSession 

Error indicating that no media session is currently available.

GCKErrorCodeNotCastSession 

Error code indicating that the current session is not a cast session.

GCKErrorCodeMediaError 

Error code indicating that a generic media error happens.

GCKErrorCodeAuthenticationErrorReceived 

Error code indicating that device authentication failed due to error received.

GCKErrorCodeMalformedClientCertificate 

Error code indicating that device authentication failed because a malformed client certificate is received.

GCKErrorCodeNotX509Certificate 

Error code indicating that device authentication failed because certificate received from Chromecast is not expected format.

GCKErrorCodeDeviceCertificateNotTrusted 

Error code indicating that device authentication failed because the device certificate is not trusted.

GCKErrorCodeSSLCertificateNotTrusted 

Error code indicating that device authentication failed because the SSL certificate is not trusted.

GCKErrorCodeMalformedAuthenticationResponse 

Error code indicating that device authentication failed because the response from device is malformed.

GCKErrorCodeDeviceCapabilityNotSupported 

Error code indicating that device authentication failed because the device capability shows unsupported.

GCKErrorCodeCRLInvalid 

Error code indicating that device authentication failed because CRL from device is invalid.

GCKErrorCodeCRLCheckFailed 

Error code indicating that device authentication failed because device certificate is revoked by CRL.

GCKErrorCodeBroadcastMessageEncryptionFailed 

Error code indicating that the broadcast message failed to encrypt.

GCKErrorCodeBroadcastKeyExchangeInvalidResponse 

Error code indicating that the key exchange response is invalid.

GCKErrorCodeBroadcastKeyExchangeInvalidInput 

Error code indicating that the key exchange response shows an invalid input error.

GCKErrorCodeBroadcastKeyExchangeEmptyResponse 

Error code indicating that the key exchange response doesn't contain a wrapped sender key.

GCKErrorCodeBroadcastKeyExchangeRequestTimeout 

Error code indicating that the key exchange request has timed out.

GCKErrorCodeBroadcastKeyExchangeFailedToFindDevice 

Error code indicating that no device that is capable for key exchange can be found.

GCKErrorCodeBroadcastKeyExchangeFailedToConnect 

Error code indicating that it failed to connect to the device that is capable for key exchange.

GCKErrorCodeBroadcastMessageDropped 

Error code indicating that the broadcast message is dropped because of cache limit.

GCKErrorCodeBroadcastSocketError 

Error code indicating that the broadcast message is not sent out due to socket error.

GCKErrorCodeBroadcastFailedToGenerateEncryptionKey 

Error code indicating that the broadcast encryption key is failed to be generated.

GCKErrorCodeGuestModeListenFailed 

Error code indicating that the listening failed.

GCKErrorCodeRemoteDisplayError 

Error code indicating that an unspecified Remote Display error has occurred.

Additional details may be available in the value associated with the key kGCKErrorExtraInfoKey in the user info.

GCKErrorCodeRemoteDisplayDeviceNotSupported 

Error code indicating that the target device does not support Remote Display.

GCKErrorCodeRemoteDisplayFeatureNotSupported 

Error code indicating that the target device does not support a paraticular Remote Display feature.

GCKErrorCodeRemoteDisplayConfigurationRejectedByReceiver 

Error code indicating that the provided Remote Display configuration has been rejected by the receiver device.

GCKErrorCodeRemoteDisplayOpenGLError 

Error indicating that an OpenGL error has occurred.

Additional details may be available in the value associated with the key kGCKErrorExtraInfoKey in the user info.

GCKErrorCodeRemoteDisplayMetalError 

Error indicating that a Metal error has occurred.

Additional details may be available in the value associated with the key kGCKErrorExtraInfoKey in the user info.

GCKErrorCodeRemoteDisplayAudioConversionError 

Error indicating that an audio conversion error has occurred.

Additional details may be available in the value associated with the key kGCKErrorExtraInfoKey in the user info.

GCKErrorCodeAppDidEnterBackground 

Error code indicating that the application moved to the background.

GCKErrorCodeDisconnected 

Error code indicating that the connection to the receiver was closed.

GCKErrorCodeUnsupportedFeature 

Error code indicating that the feature or action is unsupported either on this iOS device or the receiver.

GCKErrorCodeUnknown 

Error code indicating that an unknown, unexpected error has occurred.

GCKErrorCodeDeviceAuthenticationMessageParseFailure 

Error code indicating that the authentication message received was not properly formatted and encountered an error while parsing.

Since
4.4.5
GCKErrorCodeDeviceAuthenticationMessageChallengeReceivedFailure 

Error code indicating that the authentication message received had the challenge property set to a non-null value.

Since
4.4.5
GCKErrorCodeDeviceAuthenticationTimeoutFailure 

Error code indicating that the authentication message request timed out.

Since
4.4.5
GCKErrorCodeLaunchRequestCancelled 

Error code indicating that an Application launch request was cancelled.

Since
4.6.0
GCKErrorCodeApplicationNotRunningWithNamespaceMismatched 

Error code indicating that a requested application is not currently running due to a mismatched namespace.

GCKErrorCodeApplicationNotRunningWhenResumed 

Error code indicating that a requested application is not currently running when resumed.

GCKErrorCodeApplicationNotRunningForJoin 

Error code indicating that a request application can not be joined.

GCKErrorCodeApplicationNotRunningForJoinWhenReconnecting 

Error code indicating that a requested application can not be joined when reconnecting.

Variable Documentation

NSString* const kGCKErrorCustomDataKey

The key for the customData JSON object associated with the error in the userInfo dictionary.

NSString* const kGCKErrorDetailedCodeKey

The key for an API-specific detailed error code.

Since
4.4.3
NSString* const kGCKErrorExtraInfoKey

The key for extra error information, such as an API-specific error description.

NSString* const kGCKErrorReasonKey

The key for an API-specific error reason.

Since
4.4.3
NSString* const kGCKErrorDomain

The error domain for GCKErrorCode.