Interface CameraStreamingDelegate

interface CameraStreamingDelegate {
    handleSnapshotRequest(request: SnapshotRequest, callback: SnapshotRequestCallback): void;
    handleStreamRequest(request: StreamingRequest, callback: StreamRequestCallback): void;
    prepareStream(request: PrepareStreamRequest, callback: PrepareStreamCallback): void;
}

Index

Methods

handleSnapshotRequest handleStreamRequest prepareStream

Methods

handleSnapshotRequest

handleSnapshotRequest(request, callback): void
This method is called when a HomeKit controller requests a snapshot image for the given camera. The handler must respect the desired image height and width given in the SnapshotRequest. The returned Buffer (via the callback) must be encoded in jpeg.

HAP-NodeJS will complain about slow running handlers after 5 seconds and terminate the request after 15 seconds.
Parameters
- request: SnapshotRequest
  Request containing image size.
- callback: SnapshotRequestCallback
  Callback supplied with the resulting Buffer
Returns void
- Defined in lib/controller/CameraController.ts:162

handleStreamRequest

handleStreamRequest(request, callback): void
Parameters
- request: StreamingRequest
- callback: StreamRequestCallback
Returns void
- Defined in lib/controller/CameraController.ts:165

prepareStream

prepareStream(request, callback): void
Parameters
- request: PrepareStreamRequest
- callback: PrepareStreamCallback
Returns void
- Defined in lib/controller/CameraController.ts:164