Class CameraController

Everything needed to expose a HomeKit Camera.

Hierarchy

Implements

Constructors

Properties

motionService?: MotionSensor
occupancyService?: OccupancySensor
recordingManagement?: RecordingManagement

The RecordingManagement which is responsible for handling HomeKit Secure Video. This property is only present if recording was configured.

Methods

  • Parameters

    • event: "microphone-change"
    • muted: boolean
    • volume: number

    Returns boolean

  • Parameters

    • event: "speaker-change"
    • muted: boolean
    • volume: number

    Returns boolean

  • Call this method if you want to forcefully suspend an ongoing streaming session. This would be adequate if the rtp server or media encoding encountered an unexpected error.

    Parameters

    • sessionId: string

      id of the current ongoing streaming session

    Returns void

  • Parameters

    • event: "microphone-change"
    • listener: ((muted: boolean, volume: number) => void)
        • (muted: boolean, volume: number): void
        • Parameters

          • muted: boolean
          • volume: number

          Returns void

    Returns CameraController

  • Parameters

    • event: "speaker-change"
    • listener: ((muted: boolean, volume: number) => void)
        • (muted: boolean, volume: number): void
        • Parameters

          • muted: boolean
          • volume: number

          Returns void

    Returns CameraController