Optional idOptional nameOptional prebufferPrebuffer time in milliseconds.
Optional prebufferPrebuffer size in bytes.
Optional containerThe container type of this stream, ie: mp4, mpegts, rtsp.
Optional metadataStream specific metadata.
Optional toolThe tool was used to write the container or will be used to read teh container. Ie, scrypted, the ffmpeg tools, gstreamer.
Optional videoOptional audioOptional routeWhen 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.
Optional refreshSpecify the stream refresh behavior when this stream is requested. Use case is primarily for perioidic snapshot of streams while they are active.
true
Optional destinationThe 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.
Optional destinationThe 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.
Optional adaptiveRequest an adaptive bitrate stream, if available. The destination will need to report packet loss indication.
Generated using TypeDoc
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.