camera.ui Node SDK

Appearance

@camera.ui/sdk / camera / CameraInput

Interface: CameraInput ​

Defined in: camera/config.ts:22

Camera video input/source with resolved URLs.

Extended by ​

Properties ​

_id ​

readonly _id: string

Defined in: camera/config.ts:24

Unique source ID.

audioCodecs? ​

optional audioCodecs?: AudioCodec[]

Defined in: camera/config.ts:48

Probed audio codecs of this source (camera to client, deduplicated, in track order). Filled by the server once the stream has been probed; absent until then.

backchannelAudioCodec? ​

optional backchannelAudioCodec?: AudioCodec

Defined in: camera/config.ts:50

Probed talkback audio codec (client to camera). Present only when the probed source has a backchannel.

backchannelDisabled? ​

optional backchannelDisabled?: boolean

Defined in: camera/config.ts:38

Drop the talk channel of this source, so clients get no microphone (defaults to false).

childCameraId? ​

optional childCameraId?: string

Defined in: camera/config.ts:54

Camera whose stream shows in the picture-in-picture overlay, instead of a source of this camera.

childCameraRole? ​

optional childCameraRole?: StreamingRole

Defined in: camera/config.ts:56

Role of the childCameraId stream shown in the overlay.

childSourceId? ​

optional childSourceId?: string

Defined in: camera/config.ts:52

Child source ID (for snapshot fallback).

handshakeTimeout? ​

optional handshakeTimeout?: number

Defined in: camera/config.ts:42

Seconds allowed per RTSP request while connecting. Raise it for cameras that wake slowly. Unset means 5.

hotMode ​

hotMode: boolean

Defined in: camera/config.ts:32

Keep connection always active.

muted? ​

optional muted?: boolean

Defined in: camera/config.ts:36

Strip the audio track from this source (defaults to false).

name ​

name: string

Defined in: camera/config.ts:26

Source display name.

preload ​

preload: boolean

Defined in: camera/config.ts:34

Keep a keyframe cache for this source, so the view opens faster. Use hotMode to keep the stream connected.

role ​

role: CameraRole

Defined in: camera/config.ts:28

Resolution role.

timeout? ​

optional timeout?: number

Defined in: camera/config.ts:40

Seconds without media before the stream reconnects. Unset means the host default: 5 for cameras, 60 for plugin-served sources.

urls ​

urls: StreamUrls

Defined in: camera/config.ts:44

Generated streaming URLs.

useForSnapshot ​

useForSnapshot: boolean

Defined in: camera/config.ts:30

Use this source for snapshots.

videoCodec? ​

optional videoCodec?: VideoCodec

Defined in: camera/config.ts:46

Probed video codec of this source. Filled by the server once the stream has been probed; absent until then.