Interface RequestRecordingStreamOptions

Options passed to VideoCamera.getVideoStream to request specific media formats. The audio/video properties may be omitted to indicate no audio/video is available when calling getVideoStreamOptions or no audio/video is requested when calling getVideoStream.



id?: string
name?: string
prebuffer?: number

Prebuffer time in milliseconds.

prebufferBytes?: number

Prebuffer size in bytes.

container?: string

The container type of this stream, ie: mp4, mpegts, rtsp.

metadata?: any

Stream specific metadata.

The tool was used to write the container or will be used to read teh container. Ie, scrypted, the ffmpeg tools, gstreamer.

route?: "direct" | "internal" | "external"

When retrieving media, setting route directs how the media should be retrieved and exposed. A direct route will get the stream as is from the source. This will bypass any intermediaries if possible, such as an NVR or restreamers. An external route will request that that provided route is exposed to the local network.

refresh?: boolean

Specify the stream refresh behavior when this stream is requested. Use case is primarily for perioidic snapshot of streams while they are active.



The intended destination for this media stream. May be used as a hint to determine which main/substream to send if no id is explicitly provided.

destinationId?: string

The destination id for this media stream. This should generally be the IP address of the destination, if known. May be used by to determine stream selection and track dynamic bitrate history.

adaptive?: boolean

Request an adaptive bitrate stream, if available. The destination will need to report packet loss indication.

startTime: number
duration?: number
loop?: boolean
playbackRate?: number

Generated using TypeDoc