type alias Preview

The live stream selection in <Preview>.

Properties

optional
channelId: number

Zero-based channel.

optional
handle: number

Client-chosen stream handle.

optional
streamType:
"mainStream"
| "subStream"
| "mobileStream"
| "externStream"
| "aiYuvData"

Which encoder stream to send. aiYuvData (raw frames for AI) is Video Doorbell PoE only.

optional
preRec: number

Pre-record setting.

optional
resolution: number

Resolution selector.

optional
fps: number

Frame rate.

optional
needTLV: number

For aiYuvData: 1 to wrap frames in TLV records. Video Doorbell PoE only.

optional
gapms: number

For aiYuvData: gap between frames, in milliseconds. Video Doorbell PoE only.

optional
resoWidth: number

For aiYuvData: frame width. Video Doorbell PoE only.

optional
resoHeight: number

For aiYuvData: frame height. Video Doorbell PoE only.

optional
algorithm: number

For aiYuvData: algorithm selector; values not recovered. Video Doorbell PoE only.

Usage

import { type Preview } from "protocol/params/mod.ts";