Skip to content

@camera.ui/sdk / camera / CameraInput

Interface: CameraInput

Defined in: camera/config.ts:21

Camera video input/source with resolved URLs.

Extended by

Properties

_id

readonly _id: string

Defined in: camera/config.ts:23

Unique source ID.


audioCodecs?

optional audioCodecs?: AudioCodec[]

Defined in: camera/config.ts:41

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:43

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


childSourceId?

optional childSourceId?: string

Defined in: camera/config.ts:45

Child source ID (for snapshot fallback).


hotMode

hotMode: boolean

Defined in: camera/config.ts:31

Keep connection always active.


muted?

optional muted?: boolean

Defined in: camera/config.ts:35

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


name

name: string

Defined in: camera/config.ts:25

Source display name.


preload

preload: boolean

Defined in: camera/config.ts:33

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:27

Resolution role.


urls

urls: StreamUrls

Defined in: camera/config.ts:37

Generated streaming URLs.


useForSnapshot

useForSnapshot: boolean

Defined in: camera/config.ts:29

Use this source for snapshots.


videoCodec?

optional videoCodec?: VideoCodec

Defined in: camera/config.ts:39

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