GCKDevice.h

// Copyright 2012 Google Inc.

#import <GoogleCast/GCKDefines.h>

#import <Foundation/Foundation.h>

#import <GoogleCast/GCKNetworkAddress.h>

GCK_ASSUME_NONNULL_BEGIN

typedef NS_ENUM(NSInteger, GCKDeviceStatus) {
  GCKDeviceStatusUnknown = -1,
  GCKDeviceStatusIdle = 0,
  GCKDeviceStatusBusy = 1,
};

typedef NS_ENUM(NSInteger, GCKDeviceCapability) {
  GCKDeviceCapabilityVideoOut = 1 << 0,
  GCKDeviceCapabilityVideoIn = 1 << 1,
  GCKDeviceCapabilityAudioOut = 1 << 2,
  GCKDeviceCapabilityAudioIn = 1 << 3,
  GCKDeviceCapabilityMultizoneGroup = 1 << 5,
  GCKDeviceCapabilityMasterOrFixedVolume = 1 << 11,
  GCKDeviceCapabilityAttenuationOrFixedVolume = 1 << 12,
};

typedef NS_ENUM(NSInteger, GCKDeviceType) {
  GCKDeviceTypeGeneric = 0,
  GCKDeviceTypeTV,
  GCKDeviceTypeSpeaker,
  GCKDeviceTypeSpeakerGroup,
  GCKDeviceTypeNearbyUnpaired
};

GCK_EXTERN NSString *const kGCKCastDeviceCategory;

@class GCKImage;

GCK_EXPORT
@interface GCKDevice : NSObject <NSCopying, NSSecureCoding>

- (instancetype)init NS_UNAVAILABLE;

@property(nonatomic, copy, readonly)
    NSString *ipAddress GCK_DEPRECATED("Use networkAddress for both IPv4 and IPv6 support");

@property(nonatomic, copy, readonly) GCKNetworkAddress *networkAddress;

@property(nonatomic, assign, readonly) uint16_t servicePort;

@property(nonatomic, copy, readonly) NSString *deviceID;

@property(nonatomic, copy, readwrite, GCK_NULLABLE) NSString *friendlyName;

@property(nonatomic, copy, readwrite, GCK_NULLABLE) NSString *modelName;

@property(nonatomic, copy, readwrite, GCK_NULLABLE) NSArray<GCKImage *> *icons;

@property(nonatomic, assign, readwrite) GCKDeviceStatus status;

@property(nonatomic, copy, readwrite, GCK_NULLABLE) NSString *statusText;

@property(nonatomic, copy, readwrite, GCK_NULLABLE) NSString *deviceVersion;

@property(nonatomic, assign, readonly) BOOL isOnLocalNetwork;

@property(nonatomic, assign, readonly) GCKDeviceType type;

@property(nonatomic, copy, readonly) NSString *category;

@property(nonatomic, copy, readonly) NSString *uniqueID;

- (BOOL)isSameDeviceAs:(const GCKDevice *)other;

- (BOOL)hasCapabilities:(NSInteger)deviceCapabilities;

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

- (NSObject<NSSecureCoding> * GCK_NULLABLE_TYPE)attributeForKey:(NSString *)key;

- (void)removeAttributeForKey:(NSString *)key;

- (void)removeAllAttributes;

+ (NSString *)deviceCategoryForDeviceUniqueID:(NSString *)deviceUniqueID;

@end

GCK_ASSUME_NONNULL_END