Class CameraController

Everything needed to expose a HomeKit Camera.

Hierarchy (View Summary)

EventEmitter
- CameraController
  - DoorbellController

Implements

SerializableController<CameraControllerServiceMap, CameraControllerState>

Index

Constructors

Properties

motionService? occupancyService? recordingManagement?

Methods

emit forceStopStreamingSession on setMicrophoneMuted setMicrophoneVolume setSpeakerMuted setSpeakerVolume generateSynchronisationSource

Constructors

constructor

new CameraController(
options: CameraControllerOptions,
legacyMode?: boolean,
): CameraController
Parameters
- options: CameraControllerOptions
- legacyMode: boolean = false
Returns CameraController
- Defined in lib/controller/CameraController.ts:422

Properties

`Optional`motionService

motionService?: MotionSensor

`Optional`occupancyService

occupancyService?: OccupancySensor

`Optional`recordingManagement

recordingManagement?: RecordingManagement

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

Methods

emit

emit(event: "microphone-change", muted: boolean, volume: number): boolean
Parameters
- event: "microphone-change"
- muted: boolean
- volume: number
Returns boolean
- Defined in lib/controller/CameraController.ts:363
emit(event: "speaker-change", muted: boolean, volume: number): boolean
Parameters
- event: "speaker-change"
- muted: boolean
- volume: number
Returns boolean
- Defined in lib/controller/CameraController.ts:364

forceStopStreamingSession

forceStopStreamingSession(sessionId: string): void
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
- Defined in lib/controller/CameraController.ts:448

on

on(
event: "microphone-change",
listener: (muted: boolean, volume: number) => void,
): this
Parameters
- event: "microphone-change"
- listener: (muted: boolean, volume: number) => void
Returns this
- Defined in lib/controller/CameraController.ts:360
on(
event: "speaker-change",
listener: (muted: boolean, volume: number) => void,
): this
Parameters
- event: "speaker-change"
- listener: (muted: boolean, volume: number) => void
Returns this
- Defined in lib/controller/CameraController.ts:361

setMicrophoneMuted

setMicrophoneMuted(muted?: boolean): void
Parameters
- muted: boolean = true
Returns void
- Defined in lib/controller/CameraController.ts:464

setMicrophoneVolume

setMicrophoneVolume(volume: number): void
Parameters
- volume: number
Returns void
- Defined in lib/controller/CameraController.ts:473

setSpeakerMuted

setSpeakerMuted(muted?: boolean): void
Parameters
- muted: boolean = true
Returns void
- Defined in lib/controller/CameraController.ts:482

setSpeakerVolume

setSpeakerVolume(volume: number): void
Parameters
- volume: number
Returns void
- Defined in lib/controller/CameraController.ts:491

`Static`generateSynchronisationSource

generateSynchronisationSource(): number
Returns number
- Defined in lib/controller/CameraController.ts:456