CBLCameraDescriptor

Objective-C


@interface CBLCameraDescriptor : NSObject

Swift

class CameraDescriptor : NSObject

A camera descriptor is a manual (usually user-entered) description of where a camera can be found.

  • Creates a camera descriptor for a camera located at a network interface’s gateway. Typically, this describes cameras that create their own WiFi networks. The gateway will be auto-calulated, usually settling on the default Wi-Fi interface.

    Declaration

    Objective-C

    + (CBLCameraDescriptor *_Nonnull)descriptorForCameraFamilyAtSuggestedGateway:
    (CBLCameraFamily)family;

    Swift

    class func descriptor(atSuggestedGatewayFor family: CameraFamily) -> CameraDescriptor

    Parameters

    family

    The camera family.

  • Creates a camera descriptor for a camera located at a specified network interface’s gateway. Typically, this describes cameras that create their own WiFi networks.

    Declaration

    Objective-C

    + (CBLCameraDescriptor *_Nonnull)
    descriptorForCameraFamily:(CBLCameraFamily)family
         atGatewayOfInterface:(NSString *_Nullable)interface;

    Swift

    class func descriptor(for family: CameraFamily, atGatewayOf interface: String?) -> CameraDescriptor

    Parameters

    family

    The camera family.
    interface

    The interface on which the camera resides. Pass nil to auto-calculate this.

  • Creates a camera descriptor for a camera with a known IP address.

    Declaration

    Objective-C

    + (CBLCameraDescriptor *_Nonnull)
    descriptorForCameraFamily:(CBLCameraFamily)family
                  atIPAddress:(NSString *_Nonnull)address;

    Swift

    class func descriptor(for family: CameraFamily, at address: String) -> CameraDescriptor

    Parameters

    family

    The camera family.
    address

    The IPv4 address at which the camera resides.

  • The family of the target camera.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CBLCameraFamily cameraFamily;

    Swift

    var cameraFamily: CameraFamily { get }

  • The location of the target camera.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CBLCameraLocation cameraLocation;

    Swift

    var cameraLocation: CameraLocation { get }

  • The IP address of the target camera. Required if connectionLocation is specifiedIPAddress.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *ipv4Address;

    Swift

    var ipv4Address: String? { get }

  • The network interface on which the target camera can be found if connectionLocation is gateway. If nil, the most sensible interface will be used (usually that of the WiFi interface).

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *networkInterface;

    Swift

    var networkInterface: String? { get }