Skip to content

@camera.ui/sdk / camera / CameraConfigInputSettings

Interface: CameraConfigInputSettings ​

Defined in: camera/config.ts:60

Camera input settings for config.

Extends ​

  • Omit<CameraInputSettings, "_id" | "urls">

Properties ​

backchannelDisabled? ​

optional backchannelDisabled?: boolean

Defined in: internal/camera-config-internal.ts:20

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

Inherited from ​

Omit.backchannelDisabled


childCameraId? ​

optional childCameraId?: string

Defined in: internal/camera-config-internal.ts:30

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

Inherited from ​

Omit.childCameraId


childCameraRole? ​

optional childCameraRole?: StreamingRole

Defined in: internal/camera-config-internal.ts:32

Role of the childCameraId stream shown in the overlay.

Inherited from ​

Omit.childCameraRole


childSourceId? ​

optional childSourceId?: string

Defined in: internal/camera-config-internal.ts:28

Child source ID (for snapshot fallback).

Inherited from ​

Omit.childSourceId


handshakeTimeout? ​

optional handshakeTimeout?: number

Defined in: internal/camera-config-internal.ts:24

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

Inherited from ​

Omit.handshakeTimeout


hotMode ​

hotMode: boolean

Defined in: internal/camera-config-internal.ts:14

Keep connection always active.

Inherited from ​

Omit.hotMode


muted? ​

optional muted?: boolean

Defined in: internal/camera-config-internal.ts:18

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

Inherited from ​

Omit.muted


name ​

name: string

Defined in: internal/camera-config-internal.ts:8

Source display name.

Inherited from ​

Omit.name


preload ​

preload: boolean

Defined in: internal/camera-config-internal.ts:16

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

Inherited from ​

Omit.preload


role ​

role: CameraRole

Defined in: internal/camera-config-internal.ts:10

Resolution role.

Inherited from ​

Omit.role


timeout? ​

optional timeout?: number

Defined in: internal/camera-config-internal.ts:22

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

Inherited from ​

Omit.timeout


urls? ​

optional urls?: string[]

Defined in: camera/config.ts:62

Raw source URLs, the server resolves them into streaming URLs.


useForSnapshot ​

useForSnapshot: boolean

Defined in: internal/camera-config-internal.ts:12

Use this source for snapshots.

Inherited from ​

Omit.useForSnapshot