@camera.ui/sdk / camera / CameraDeviceSource

Interface: CameraDeviceSource

Defined in: camera/device.ts:56

Camera source with full streaming capabilities.

Extends

• CameraSource

Properties

_id

readonly _id: string

Defined in: camera/config.ts:12

Unique source ID

Inherited from

CameraSource._id

---

childSourceId?

optional childSourceId?: string

Defined in: camera/config.ts:26

Child source ID (for snapshot fallback)

Inherited from

CameraSource.childSourceId

---

hotMode

hotMode: boolean

Defined in: camera/config.ts:20

Keep connection always active

Inherited from

CameraSource.hotMode

---

name

name: string

Defined in: camera/config.ts:14

Source display name

Inherited from

CameraSource.name

---

preload

preload: boolean

Defined in: camera/config.ts:22

Preload stream on startup

Inherited from

CameraSource.preload

---

role

role: CameraRole

Defined in: camera/config.ts:16

Resolution role

Inherited from

CameraSource.role

---

urls

urls: StreamUrls

Defined in: camera/config.ts:24

Generated streaming URLs

Inherited from

CameraSource.urls

---

useForSnapshot

useForSnapshot: boolean

Defined in: camera/config.ts:18

Use this source for snapshots

Inherited from

CameraSource.useForSnapshot

Methods

createFmp4Session()

createFmp4Session(urlOrOptions?): Fmp4Session

Defined in: camera/device.ts:82

Create FMP4 streaming session.

Parameters

urlOrOptions?

string | RTSPUrlOptions

RTSP URL or options

Returns

Fmp4Session

FMP4 session instance

---

createRtpSession()

createRtpSession(urlOrOptions?): RtpSession

Defined in: camera/device.ts:73

Create RTP streaming session.

Parameters

urlOrOptions?

string | RTSPUrlOptions

RTSP URL or options

Returns

RtpSession

RTP session instance

---

generateRTSPUrl()

generateRTSPUrl(options?): string

Defined in: camera/device.ts:64

Generate RTSP URL with specified options.

Parameters

options?

RTSPUrlOptions

URL generation options

Returns

string

RTSP URL string

---

generateSnapshotUrl()

generateSnapshotUrl(options?): string

Defined in: camera/device.ts:50

Generate Snapshot URL with specified options.

Parameters

options?

SnapshotUrlOptions

URL generation options

Returns

string

Snapshot URL string

Inherited from

CameraSource.generateSnapshotUrl

---

getStreamStatus()

getStreamStatus(): Promise<string>

Defined in: camera/device.ts:41

Get the current stream connection status.

Returns

Promise<string>

Status string: 'connected', 'connecting', 'error', or 'idle'

Inherited from

CameraSource.getStreamStatus

---

probeStream()

probeStream(probeConfig?, refresh?): Promise<ProbeStream | undefined>

Defined in: camera/device.ts:34

Probe stream for codec and track information.

Parameters

probeConfig?

ProbeConfig

What to probe for

refresh?

boolean

Force fresh probe (ignore cache)

Returns

Promise<ProbeStream | undefined>

Stream information or undefined if unavailable

Inherited from

CameraSource.probeStream

---

snapshot()

snapshot(forceNew?): Promise<ArrayBuffer | undefined>

Defined in: camera/device.ts:23

Get camera snapshot image.

Parameters

forceNew?

boolean

Force fresh snapshot (ignore cache)

Returns

Promise<ArrayBuffer | undefined>

JPEG image data or undefined if unavailable

Inherited from

CameraSource.snapshot