camera.ui Node SDK

Appearance

@camera.ui/sdk / sensor / AudioSensorLike

Interface: AudioSensorLike ​

Defined in: sensor/audio.ts:51

Read-only proxy interface for an audio sensor.

Extends ​

Properties ​

assignedCameraIds ​

readonly assignedCameraIds: readonly string[]

Defined in: sensor/base.ts:192

Inherited from ​

SensorLike.assignedCameraIds

assignmentLocked ​

readonly assignmentLocked: boolean

Defined in: sensor/base.ts:193

Inherited from ​

SensorLike.assignmentLocked

capabilities ​

readonly capabilities: string[]

Defined in: sensor/base.ts:190

Inherited from ​

SensorLike.capabilities

connected ​

readonly connected: boolean

Defined in: sensor/base.ts:191

Inherited from ​

SensorLike.connected

displayName ​

readonly displayName: string

Defined in: sensor/base.ts:187

Inherited from ​

SensorLike.displayName

id ​

readonly id: string

Defined in: sensor/base.ts:184

Inherited from ​

SensorLike.id

name ​

readonly name: string

Defined in: sensor/base.ts:186

Inherited from ​

SensorLike.name

nativeId? ​

readonly optional nativeId?: string

Defined in: sensor/base.ts:188

Inherited from ​

SensorLike.nativeId

onAssignmentChanged ​

readonly onAssignmentChanged: Observable<readonly string[]>

Defined in: sensor/base.ts:197

Inherited from ​

SensorLike.onAssignmentChanged

onCapabilitiesChanged ​

readonly onCapabilitiesChanged: Observable<string[]>

Defined in: sensor/base.ts:195

Inherited from ​

SensorLike.onCapabilitiesChanged

onConnectedChanged ​

readonly onConnectedChanged: Observable<boolean>

Defined in: sensor/base.ts:196

Inherited from ​

SensorLike.onConnectedChanged

onPropertyChanged ​

readonly onPropertyChanged: Observable<PropertyChangeOf<AudioSensorProperties>>

Defined in: sensor/audio.ts:53

Overrides ​

SensorLike.onPropertyChanged

pluginId? ​

readonly optional pluginId?: string

Defined in: sensor/base.ts:189

Inherited from ​

SensorLike.pluginId

type ​

readonly type: Audio

Defined in: sensor/audio.ts:52

Overrides ​

SensorLike.type

Methods ​

getValue() ​

Call Signature ​

getValue(property): boolean | undefined

Defined in: sensor/audio.ts:55

Get the current value of a sensor property.

Parameters ​
property ​

Detected

Returns ​

boolean | undefined

Overrides ​

SensorLike.getValue

Call Signature ​

getValue(property): Detection[] | undefined

Defined in: sensor/audio.ts:56

Get the current value of a sensor property.

Parameters ​
property ​

Detections

Returns ​

Detection[] | undefined

Overrides ​

SensorLike.getValue

Call Signature ​

getValue(property): number | undefined

Defined in: sensor/audio.ts:57

Get the current value of a sensor property.

Parameters ​
property ​

Decibels

Returns ​

number | undefined

Overrides ​

SensorLike.getValue

Call Signature ​

getValue(property): unknown

Defined in: sensor/audio.ts:58

Get the current value of a sensor property.

Parameters ​
property ​

string

Returns ​

unknown

Overrides ​

SensorLike.getValue

getValues() ​

getValues(): Readonly<Record<string, unknown>>

Defined in: sensor/base.ts:202

Get a read-only snapshot of all property values.

Returns ​

Readonly<Record<string, unknown>>

Inherited from ​

SensorLike.getValues

hasCapability() ​

hasCapability(capability): boolean

Defined in: sensor/base.ts:211

Whether the sensor advertises the given capability.

Parameters ​

capability ​

string

Returns ​

boolean

Inherited from ​

SensorLike.hasCapability

updateValue() ​

updateValue(property, value): void | Promise<void>

Defined in: sensor/base.ts:209

Generic property write used by cross-process bridges. The owning sensor dispatches it to the matching semantic method, so plugin-side hardware overrides still run. Plugin authors call the semantic methods instead.

Parameters ​

property ​

string

value ​

unknown

Returns ​

void | Promise<void>

Inherited from ​

SensorLike.updateValue