GCKDevice Class

    • GCKDevice is an object in the Cast SDK representing a receiver device.

    • You can test if two GCKDevice objects refer to the same physical device.

    • GCKDevice objects have properties like IP address, device ID, friendly name, and status.

    • You can add, retrieve, and remove arbitrary attributes on a GCKDevice object.
    Instance Methods | Properties
    GCKDevice Class Reference

    Overview

    An object representing a receiver device.

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

    Instance Method Summary

    (BOOL) 
    - isSameDeviceAs:
    Tests if this device refers to the same physical device as another. More...
    (BOOL) 
    - hasCapabilities:
    Returns YES if the device supports the given capabilities. More...
    (void) 
    - setAttribute:forKey:
    Sets an arbitrary attribute in the object. More...
    (NSObject< NSCoding > *__nullable) 
    - 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...

    Property Summary

    NSString * 
    ipAddress
    The device's IPv4 address, in dot-notation. 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 * 
    manufacturer
    The device's manufacturer 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: (NSInteger)  deviceCapabilities

    Returns YES if the device supports the given capabilities.

    Parameters
    deviceCapabilities
    A bitwise-OR of one or more of the GCKDeviceCapability constants.
    - (void) setAttribute: (NSObject< NSCoding > *)  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 .
    - (NSObject<NSCoding> * __nullable) 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.

    Property Detail

    - (NSString*) ipAddress
    read nonatomic copy

    The device's IPv4 address, in dot-notation.

    Used when making network requests.

    - (uint16_t) servicePort
    read nonatomic assign

    The device's service port.

    - (NSString*) deviceID
    read nonatomic copy

    A unique identifier for the device.

    - (NSString*) friendlyName
    read write nonatomic copy

    The device's friendly name.

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

    - (NSString*) manufacturer
    read write nonatomic copy

    The device's manufacturer name.

    Deprecated:
    Use the modelName or custom attributes instead.
    - (NSString*) modelName
    read write nonatomic copy

    The device's model name.

    - (NSArray< GCKImage *>*) icons
    read write nonatomic copy

    An array of GCKImage objects containing icons for the device.

    - ( GCKDeviceStatus ) status
    read write nonatomic assign

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

    - (NSString*) statusText
    read write nonatomic copy

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

    - (NSString*) deviceVersion
    read write nonatomic copy

    The device's protocol version.

    - (BOOL) isOnLocalNetwork
    read nonatomic assign

    YES if this device is on the local network.

    - ( GCKDeviceType ) type
    read nonatomic assign

    The device type.

    Since
    3.3
    - (NSString*) category
    read nonatomic copy

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

    Cast devices have a category of kGCKCastDeviceCategory .

    - (NSString*) uniqueID
    read nonatomic copy

    A globally unique ID for this device.

    This is a concatenation of the category and deviceID properties.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: