hap-nodejs 0.10.0-beta.3 → 0.10.0-beta.7

package/dist/lib/camera/RecordingManagement.d.ts

@@ -0,0 +1,267 @@
+/// <reference types="node" />
+import { VideoCodecType } from ".";
+import { AudioBitrate, CameraRecordingDelegate, StateChangeDelegate } from "../controller";
+import { DataStreamManagement } from "../datastream";
+import { CameraOperatingMode, CameraRecordingManagement } from "../definitions";
+import { Service } from "../Service";
+import { H264CodecParameters, H264Level, H264Profile, Resolution } from "./RTPStreamManagement";
+/**
+ * Describes options passed to the {@link RecordingManagement}.
+ */
+export declare type CameraRecordingOptions = {
+    /**
+     * The size of the prebuffer in milliseconds. It must be at least 4000 ms.
+     * A sensible value for this property is in the interval [4000, 8000].
+     *
+     * In order to provide some context to recording event, it is a good user experience
+     * to also have the recording of a few seconds before the event occurs.
+     * This exactly is the prebuffer. A camera will constantly store the last
+     * x seconds (the `prebufferLength`) to provide more context to a given event.
+     */
+    prebufferLength: number;
+    /**
+     * This property can be used to override the automatic heuristic of the {@link CameraController}
+     * which derives the {@link EventTriggerOption}s from application state.
+     *
+     * {@link EventTriggerOption}s are derived automatically as follows:
+     * * {@link EventTriggerOption.MOTION} is enabled when a {@link MotionSensor} is configured (via {@link CameraControllerOptions.sensors}).
+     * * {@link EventTriggerOption.DOORBELL} is enabled when the {@link DoorbellController} is used.
+     *
+     * Note: This property is **ADDITIVE**. Meaning if the {@link CameraController} decides to add
+     * a certain {@link EventTriggerOption} it will still do so. This option can only be used to
+     * add **additional** {@link EventTriggerOption}s!
+     */
+    overrideEventTriggerOptions?: EventTriggerOption[];
+    /**
+     * List of supported media {@link MediaContainerConfiguration}s (or a single one).
+     */
+    mediaContainerConfiguration: MediaContainerConfiguration | MediaContainerConfiguration[];
+    video: VideoRecordingOptions;
+    audio: AudioRecordingOptions;
+};
+/**
+ * Describes the Event trigger.
+ */
+export declare const enum EventTriggerOption {
+    /**
+     * The Motion trigger. If enabled motion should trigger the start of a recording.
+     */
+    MOTION = 1,
+    /**
+     * The Doorbell trigger. If enabled a doorbell button press should trigger the start of a recording.
+     */
+    DOORBELL = 2
+}
+export declare const enum MediaContainerType {
+    FRAGMENTED_MP4 = 0
+}
+export interface MediaContainerConfiguration {
+    /**
+     * The type of media container.
+     */
+    type: MediaContainerType;
+    /**
+     * The length in milliseconds of every individual recording fragment.
+     * A typical value of HomeKit Secure Video cameras is 4000ms.
+     */
+    fragmentLength: number;
+}
+export interface VideoRecordingOptions {
+    type: VideoCodecType;
+    parameters: H264CodecParameters;
+    /**
+     * Required resolutions to be supported are:
+     * * 1920x1080
+     * * 1280x720
+     *
+     * The following frame rates are required to be supported:
+     * * 15 fps
+     * * 24fps or 30fps
+     */
+    resolutions: Resolution[];
+}
+export declare type AudioRecordingOptions = {
+    /**
+     * List (or single entry) of supported {@link AudioRecordingCodec}s.
+     */
+    codecs: AudioRecordingCodec | AudioRecordingCodec[];
+};
+export declare type AudioRecordingCodec = {
+    type: AudioRecordingCodecType;
+    /**
+     * The count of audio channels. Must be at least `1`.
+     * Defaults to `1`.
+     */
+    audioChannels?: number;
+    /**
+     * The supported bitrate mode. Defaults to {@link AudioBitrate.VARIABLE}.
+     */
+    bitrateMode?: AudioBitrate;
+    samplerate: AudioRecordingSamplerate[] | AudioRecordingSamplerate;
+};
+/**
+ * This type describes the SelectedCameraRecordingConfiguration (written by the device to {@link SelectedCameraRecordingConfiguration}).
+ */
+export interface CameraRecordingConfiguration {
+    /**
+     * The size of the prebuffer in milliseconds.
+     * This value is less or equal of the value advertised in the {@link SupportedCameraRecordingConfiguration}.
+     */
+    prebufferLength: number;
+    /**
+     * List of the enabled {@link EventTriggerOption}s.
+     */
+    eventTriggerTypes: EventTriggerOption[];
+    /**
+     * The selected {@link MediaContainerConfiguration}.
+     */
+    mediaContainerConfiguration: MediaContainerConfiguration;
+    /**
+     * The selected video codec configuration.
+     */
+    videoCodec: {
+        type: VideoCodecType.H264;
+        parameters: SelectedH264CodecParameters;
+        resolution: Resolution;
+    };
+    /**
+     * The selected audio codec configuration.
+     */
+    audioCodec: AudioRecordingCodec & {
+        bitrate: number;
+        samplerate: AudioRecordingSamplerate;
+    };
+}
+export interface SelectedH264CodecParameters {
+    profile: H264Profile;
+    level: H264Level;
+    bitRate: number;
+    /**
+     * The selected i-frame interval in milliseconds.
+     */
+    iFrameInterval: number;
+}
+export declare const enum AudioRecordingCodecType {
+    AAC_LC = 0,
+    AAC_ELD = 1
+}
+export declare const enum AudioRecordingSamplerate {
+    KHZ_8 = 0,
+    KHZ_16 = 1,
+    KHZ_24 = 2,
+    KHZ_32 = 3,
+    KHZ_44_1 = 4,
+    KHZ_48 = 5
+}
+export declare const enum PacketDataType {
+    MEDIA_INITIALIZATION = "mediaInitialization",
+    MEDIA_FRAGMENT = "mediaFragment"
+}
+export interface RecordingPacket {
+    /**
+     * The `Buffer` containing the data of the packet.
+     */
+    data: Buffer;
+    /**
+     * Defines if this `RecordingPacket` is the last one in the recording stream.
+     * If `true` this will signal an end of stream and closes the recording stream.
+     */
+    isLast: boolean;
+}
+interface RecordingManagementServices {
+    recordingManagement: CameraRecordingManagement;
+    operatingMode: CameraOperatingMode;
+    dataStreamManagement: DataStreamManagement;
+}
+export interface RecordingManagementState {
+    /**
+     * This property stores a hash of the supported configurations (recording, video and audio) of
+     * the recording management. We use this to determine if the configuration was changed by the user.
+     * If it was changed, we need to discard the `selectedConfiguration` to signify to HomeKit Controllers
+     * that they might reconsider their decision based on the updated configuration.
+     */
+    configurationHash: {
+        algorithm: "sha256";
+        hash: string;
+    };
+    /**
+     * The base64 encoded tlv of the {@link CameraRecordingConfiguration}.
+     * This value MIGHT be `undefined` if no HomeKit controller has yet selected a configuration.
+     */
+    selectedConfiguration?: string;
+    /**
+     * Service `CameraRecordingManagement`; Characteristic `Active`
+     */
+    recordingActive: boolean;
+    /**
+     * Service `CameraRecordingManagement`; Characteristic `RecordingAudioActive`
+     */
+    recordingAudioActive: boolean;
+    /**
+     * Service `CameraOperatingMode`; Characteristic `EventSnapshotsActive`
+     */
+    eventSnapshotsActive: boolean;
+    /**
+     * Service `CameraOperatingMode`; Characteristic `HomeKitCameraActive`
+     */
+    homeKitCameraActive: boolean;
+    /**
+     * Service `CameraOperatingMode`; Characteristic `PeriodicSnapshotsActive`
+     */
+    periodicSnapshotsActive: boolean;
+}
+export declare class RecordingManagement {
+    readonly options: CameraRecordingOptions;
+    readonly delegate: CameraRecordingDelegate;
+    private stateChangeDelegate?;
+    private readonly supportedCameraRecordingConfiguration;
+    private readonly supportedVideoRecordingConfiguration;
+    private readonly supportedAudioRecordingConfiguration;
+    /**
+     * 32 bit mask of enabled {@link EventTriggerOption}s.
+     */
+    private readonly eventTriggerOptions;
+    readonly recordingManagementService: CameraRecordingManagement;
+    readonly operatingModeService: CameraOperatingMode;
+    readonly dataStreamManagement: DataStreamManagement;
+    /**
+     * The currently active recording stream.
+     * Any camera only supports one stream at a time.
+     */
+    private recordingStream?;
+    private selectedConfiguration?;
+    /**
+     * Array of sensor services (e.g. {@link Service.MotionSensor} or {@link Service.OccupancySensor}).
+     * Any service in this array owns a {@link Characteristic.StatusActive} characteristic.
+     * The value of the {@link Characteristic.HomeKitCameraActive} is mirrored towards the {@link Characteristic.StatusActive} characteristic.
+     * The array is initialized my the caller shortly after calling the constructor.
+     */
+    sensorServices: Service[];
+    constructor(options: CameraRecordingOptions, delegate: CameraRecordingDelegate, eventTriggerOptions: Set<EventTriggerOption>, services?: RecordingManagementServices);
+    private constructService;
+    private setupServiceHandlers;
+    private handleDataSendOpen;
+    private handleSelectedCameraRecordingConfigurationRead;
+    private handleSelectedCameraRecordingConfigurationWrite;
+    private parseSelectedConfiguration;
+    private _supportedCameraRecordingConfiguration;
+    private _supportedVideoRecordingConfiguration;
+    private _supportedAudioStreamConfiguration;
+    private computeConfigurationHash;
+    /**
+     * @private
+     */
+    serialize(): RecordingManagementState | undefined;
+    /**
+     * @private
+     */
+    deserialize(serialized: RecordingManagementState): void;
+    /**
+     * @private
+     */
+    setupStateChangeDelegate(delegate?: StateChangeDelegate): void;
+    destroy(): void;
+    handleFactoryReset(): void;
+}
+export {};
+//# sourceMappingURL=RecordingManagement.d.ts.map

package/dist/lib/camera/RecordingManagement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordingManagement.d.ts","sourceRoot":"","sources":["../../../src/lib/camera/RecordingManagement.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,CAAC;AAEnC,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAC3F,OAAO,EAGL,oBAAoB,EASrB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAwC,MAAM,gBAAgB,CAAC;AAEtH,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrC,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAIhG;;GAEG;AACH,oBAAY,sBAAsB,GAAG;IACnC;;;;;;;;OAQG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,2BAA2B,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAElD;;OAEG;IACH,2BAA2B,EAAE,2BAA2B,GAAG,2BAA2B,EAAE,CAAC;IAEzF,KAAK,EAAE,qBAAqB,CAAC;IAC7B,KAAK,EAAE,qBAAqB,CAAC;CAC9B,CAAA;AAED;;GAEG;AACH,0BAAkB,kBAAkB;IAClC;;OAEG;IACH,MAAM,IAAO;IACb;;OAEG;IACH,QAAQ,IAAO;CAChB;AAED,0BAAkB,kBAAkB;IAClC,cAAc,IAAO;CACtB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC;IACzB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,cAAc,CAAC;IACrB,UAAU,EAAE,mBAAmB,CAAC;IAChC;;;;;;;;OAQG;IACH,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,MAAM,EAAE,mBAAmB,GAAG,mBAAmB,EAAE,CAAC;CACrD,CAAA;AAED,oBAAY,mBAAmB,GAAG;IAChC,IAAI,EAAE,uBAAuB,CAAC;IAC9B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,UAAU,EAAE,wBAAwB,EAAE,GAAG,wBAAwB,CAAC;CACnE,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,iBAAiB,EAAE,kBAAkB,EAAE,CAAC;IACxC;;OAEG;IACH,2BAA2B,EAAE,2BAA2B,CAAC;IAEzD;;OAEG;IACH,UAAU,EAAE;QACV,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC;QAC1B,UAAU,EAAE,2BAA2B,CAAC;QACxC,UAAU,EAAE,UAAU,CAAC;KACxB,CAAC;IAEF;;OAEG;IACH,UAAU,EAAE,mBAAmB,GAAG;QAChC,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,wBAAwB,CAAC;KACtC,CAAC;CACH;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,WAAW,CAAC;IACrB,KAAK,EAAE,SAAS,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AA4BD,0BAAkB,uBAAuB;IACvC,MAAM,IAAI;IACV,OAAO,IAAI;CACZ;AAED,0BAAkB,wBAAwB;IACxC,KAAK,IAAI;IACT,MAAM,IAAI;IACV,MAAM,IAAI;IACV,MAAM,IAAI;IACV,QAAQ,IAAI;IACZ,MAAM,IAAI;CACX;AAqCD,0BAAkB,cAAc;IAE9B,oBAAoB,wBAAwB;IAE5C,cAAc,kBAAkB;CACjC;AAiBD,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAGD,UAAU,2BAA2B;IACnC,mBAAmB,EAAE,yBAAyB,CAAC;IAC/C,aAAa,EAAE,mBAAmB,CAAC;IACnC,oBAAoB,EAAE,oBAAoB,CAAC;CAC5C;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,iBAAiB,EAAE;QACjB,SAAS,EAAE,QAAQ,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IAEF;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,uBAAuB,EAAE,OAAO,CAAC;CAClC;AAED,qBAAa,mBAAmB;IAC9B,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IACzC,QAAQ,CAAC,QAAQ,EAAE,uBAAuB,CAAC;IAE3C,OAAO,CAAC,mBAAmB,CAAC,CAAsB;IAElD,OAAO,CAAC,QAAQ,CAAC,qCAAqC,CAAS;IAC/D,OAAO,CAAC,QAAQ,CAAC,oCAAoC,CAAS;IAC9D,OAAO,CAAC,QAAQ,CAAC,oCAAoC,CAAS;IAE9D;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAS;IAE7C,QAAQ,CAAC,0BAA0B,EAAE,yBAAyB,CAAC;IAC/D,QAAQ,CAAC,oBAAoB,EAAE,mBAAmB,CAAC;IACnD,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IAEpD;;;OAGG;IACH,OAAO,CAAC,eAAe,CAAC,CAAwB;IAChD,OAAO,CAAC,qBAAqB,CAAC,CAS7B;IAED;;;;;OAKG;IACH,cAAc,EAAE,OAAO,EAAE,CAAM;gBAEnB,OAAO,EAAE,sBAAsB,EAAE,QAAQ,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,GAAG,CAAC,kBAAkB,CAAC,EAAE,QAAQ,CAAC,EAAE,2BAA2B;IAqBpK,OAAO,CAAC,gBAAgB;IAoBxB,OAAO,CAAC,oBAAoB;IA6C5B,OAAO,CAAC,kBAAkB;IAyD1B,OAAO,CAAC,8CAA8C;IAQtD,OAAO,CAAC,+CAA+C;IAcvD,OAAO,CAAC,0BAA0B;IAwElC,OAAO,CAAC,sCAAsC;IA6B9C,OAAO,CAAC,qCAAqC;IA0C7C,OAAO,CAAC,kCAAkC;IAmC1C,OAAO,CAAC,wBAAwB;IAQhC;;OAEG;IACH,SAAS,IAAI,wBAAwB,GAAG,SAAS;IAiBjD;;OAEG;IACH,WAAW,CAAC,UAAU,EAAE,wBAAwB,GAAG,IAAI;IA2CvD;;OAEG;IACH,wBAAwB,CAAC,QAAQ,CAAC,EAAE,mBAAmB,GAAG,IAAI;IAI9D,OAAO,IAAI,IAAI;IAIf,kBAAkB;CAqBnB"}