Scrypted Development

Appearance

Scrypted Documentation / ResponseMediaStreamOptions

Interface: ResponseMediaStreamOptions ​

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.

Extends ​

Properties ​

name? ​

optional name: string

Inherited from ​

MediaStreamOptions.name

prebuffer? ​

optional prebuffer: number

Prebuffer time in milliseconds.

Inherited from ​

MediaStreamOptions.prebuffer

prebufferBytes? ​

optional prebufferBytes: number

Prebuffer size in bytes.

Inherited from ​

MediaStreamOptions.prebufferBytes

container? ​

optional container: string

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

Inherited from ​

MediaStreamOptions.container

metadata? ​

optional metadata: any

Stream specific metadata.

Inherited from ​

MediaStreamOptions.metadata

tool? ​

optional tool: MediaStreamTool

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

Inherited from ​

MediaStreamOptions.tool

video? ​

optional video: VideoStreamOptions

Inherited from ​

MediaStreamOptions.video

audio? ​

optional audio: AudioStreamOptions

Inherited from ​

MediaStreamOptions.audio

id ​

id: string

Overrides ​

MediaStreamOptions.id

refreshAt? ​

optional refreshAt: number

The time in milliseconds that this stream must be refreshed again via a call to getVideoStream.

source? ​

optional source: MediaStreamSource

userConfigurable? ​

optional userConfigurable: boolean

sdp? ​

optional sdp: string

oobCodecParameters? ​

optional oobCodecParameters: boolean

The stream's codec parameters are not contained in the stream and are available out of band via another mechanism such as the SDP.

destinations? ​

optional destinations: MediaStreamDestination[]

allowBatteryPrebuffer? ​

optional allowBatteryPrebuffer: boolean

Set this to true to allow for prebuffering even if the device implements the Battery interface. Handy if you have a device that can continuously prebuffer when on mains power, but you still want battery status reported.