GCKDevice Class

AI-generated Key Takeaways

• The GCKDevice class represents a Cast receiver device on the network, providing information such as its name, IP address, capabilities, and status.

• It offers methods to check device capabilities, compare devices, and manage device-specific attributes.

• Developers can access properties like friendlyName, modelName, deviceID, and icons to identify and interact with the device.

• The GCKDevice class helps in discovering and managing Cast-enabled devices for seamless integration with Cast applications.

• It includes properties like networkAddress, servicePort and deviceVersion for handling network communication and device identification.

Instance Methods | Class Methods | Properties

GCKDevice Class Reference

Overview

An object representing a receiver device.

Inherits NSObject, <NSCopying>, and <NSSecureCoding>.

Instance Method Summary
(instancetype)	- init
(BOOL)	- isSameDeviceAs:
	Tests if this device refers to the same physical device as another. More...
(BOOL)	- hasCapabilities:
	Returns YES if the device supports all of the given capabilities. More...
(void)	- setAttribute:forKey:
	Sets an arbitrary attribute in the object. More...
(nullable NSObject < NSSecureCoding > *)	- attributeForKey:
	Looks up an attribute in the object. More...
(void)	- removeAttributeForKey:
	Removes an attribute from the object. More...
(void)	- removeAllAttributes
	Removes all attributes from the object. More...

Class Method Summary
(NSString *)	+ deviceCategoryForDeviceUniqueID:
	Extracts the device category from a device unique ID. More...

Property Summary
NSString *	ipAddress
GCKNetworkAddress *	networkAddress
	The device's IP address. More...
uint16_t	servicePort
	The device's service port. More...
NSString *	deviceID
	A unique identifier for the device. More...
NSString *	friendlyName
	The device's friendly name. More...
NSString *	modelName
	The device's model name. More...
NSArray< GCKImage * > *	icons
	An array of GCKImage objects containing icons for the device. More...
GCKDeviceStatus	status
	The device's status at the time that it was most recently scanned. More...
NSString *	statusText
	The status text reported by the currently running receiver application, if any. More...
NSString *	deviceVersion
	The device's protocol version. More...
BOOL	isOnLocalNetwork
	YES if this device is on the local network. More...
GCKDeviceType	type
	The device type. More...
NSString *	category
	The device category, a string that uniquely identifies the type of device. More...
NSString *	uniqueID
	A globally unique ID for this device. More...

Method Detail

- (BOOL) isSameDeviceAs:

(const GCKDevice *)

other

Tests if this device refers to the same physical device as another.

Returns YES if both GCKDevice objects have the same category, device ID, IP address, service port, and protocol version.

- (BOOL) hasCapabilities:

(GCKDeviceCapabilities)

deviceCapabilities

Returns YES if the device supports all of the given capabilities.

Parameters

deviceCapabilities

A bitwise-OR of one or more of the GCKDeviceCapabilities constants.

- (void) setAttribute:		(NSObject< NSSecureCoding > *)	attribute
forKey:		(NSString *)	key

Sets an arbitrary attribute in the object.

May be used by custom device providers to store device-specific information for non-Cast devices.

Parameters

attribute	The attribute value, which must be key-value coding compliant, and cannot be nil.
key	The key that identifies the attribute. The key is an arbitrary string. It cannot be nil.

- (nullable NSObject<NSSecureCoding> *) attributeForKey:

(NSString *)

key

Looks up an attribute in the object.

Parameters

key	The key that identifies the attribute. The key is an arbitrary string. It cannot be nil.

Returns

The value of the attribute, or nil if no such attribute exists.

- (void) removeAttributeForKey:

(NSString *)

key

Removes an attribute from the object.

Parameters

key	The key that identifies the attribute. The key is an arbitrary string. It cannot be nil.

- (void) removeAllAttributes

Removes all attributes from the object.

+ (NSString *) deviceCategoryForDeviceUniqueID:

(NSString *)

deviceUniqueID

Extracts the device category from a device unique ID.

Property Detail

- (NSString*) ipAddress

readnonatomiccopy

Deprecated:

Use networkAddress The device's IPv4 address, in dot-notation. Used when making network requests. This will be an empty string for GCKDevice objects that are created with an IPv6 address.

- (GCKNetworkAddress*) networkAddress

readnonatomiccopy

The device's IP address.

Used when making network requests.

Since

4.2

- (uint16_t) servicePort

readnonatomicassign

The device's service port.

- (NSString*) deviceID

readnonatomiccopy

A unique identifier for the device.

- (NSString*) friendlyName

readwritenonatomiccopy

The device's friendly name.

This is a user-assignable name such as "Living Room".

- (NSString*) modelName

readwritenonatomiccopy

The device's model name.

- (NSArray<GCKImage *>*) icons

readwritenonatomiccopy

An array of GCKImage objects containing icons for the device.

- (GCKDeviceStatus) status

readwritenonatomicassign

The device's status at the time that it was most recently scanned.

- (NSString*) statusText

readwritenonatomiccopy

The status text reported by the currently running receiver application, if any.

- (NSString*) deviceVersion

readwritenonatomiccopy

The device's protocol version.

- (BOOL) isOnLocalNetwork

readnonatomicassign

YES if this device is on the local network.

- (GCKDeviceType) type

readnonatomicassign

The device type.

Since

3.3

- (NSString*) category

readnonatomiccopy

The device category, a string that uniquely identifies the type of device.

Cast devices have a category of kGCKCastDeviceCategory.

- (NSString*) uniqueID

readnonatomiccopy

A globally unique ID for this device.

This is a concatenation of the category and deviceID properties.