camera.ui Node SDK

Appearance

@camera.ui/sdk / sensor / PTZControlLike

Interface: PTZControlLike ​

Defined in: sensor/ptz.ts:104

Read-only proxy interface for a PTZ control.

Extends ​

Properties ​

assignedCameraIds ​

readonly assignedCameraIds: readonly string[]

Defined in: sensor/base.ts:177

Inherited from ​

SensorLike.assignedCameraIds

assignmentLocked ​

readonly assignmentLocked: boolean

Defined in: sensor/base.ts:178

Inherited from ​

SensorLike.assignmentLocked

capabilities ​

readonly capabilities: string[]

Defined in: sensor/base.ts:175

Inherited from ​

SensorLike.capabilities

connected ​

readonly connected: boolean

Defined in: sensor/base.ts:176

Inherited from ​

SensorLike.connected

displayName ​

readonly displayName: string

Defined in: sensor/base.ts:172

Inherited from ​

SensorLike.displayName

id ​

readonly id: string

Defined in: sensor/base.ts:169

Inherited from ​

SensorLike.id

name ​

readonly name: string

Defined in: sensor/base.ts:171

Inherited from ​

SensorLike.name

nativeId? ​

readonly optional nativeId?: string

Defined in: sensor/base.ts:173

Inherited from ​

SensorLike.nativeId

onAssignmentChanged ​

readonly onAssignmentChanged: Observable<readonly string[]>

Defined in: sensor/base.ts:182

Inherited from ​

SensorLike.onAssignmentChanged

onCapabilitiesChanged ​

readonly onCapabilitiesChanged: Observable<PTZCapability[]>

Defined in: sensor/ptz.ts:107

Overrides ​

SensorLike.onCapabilitiesChanged

onConnectedChanged ​

readonly onConnectedChanged: Observable<boolean>

Defined in: sensor/base.ts:181

Inherited from ​

SensorLike.onConnectedChanged

onPropertyChanged ​

readonly onPropertyChanged: Observable<PropertyChangeOf<PTZControlProperties>>

Defined in: sensor/ptz.ts:106

Overrides ​

SensorLike.onPropertyChanged

pluginId? ​

readonly optional pluginId?: string

Defined in: sensor/base.ts:174

Inherited from ​

SensorLike.pluginId

type ​

readonly type: PTZ

Defined in: sensor/ptz.ts:105

Overrides ​

SensorLike.type

Methods ​

getValue() ​

Call Signature ​

getValue(property): PTZPosition | undefined

Defined in: sensor/ptz.ts:109

Get the current value of a sensor property.

Parameters ​
property ​

Position

Returns ​

PTZPosition | undefined

Overrides ​

SensorLike.getValue

Call Signature ​

getValue(property): boolean | undefined

Defined in: sensor/ptz.ts:110

Get the current value of a sensor property.

Parameters ​
property ​

Moving

Returns ​

boolean | undefined

Overrides ​

SensorLike.getValue

Call Signature ​

getValue(property): string[] | undefined

Defined in: sensor/ptz.ts:111

Get the current value of a sensor property.

Parameters ​
property ​

Presets

Returns ​

string[] | undefined

Overrides ​

SensorLike.getValue

Call Signature ​

getValue(property): PTZDirection | undefined

Defined in: sensor/ptz.ts:112

Get the current value of a sensor property.

Parameters ​
property ​

Velocity

Returns ​

PTZDirection | undefined

Overrides ​

SensorLike.getValue

Call Signature ​

getValue(property): string | undefined

Defined in: sensor/ptz.ts:113

Get the current value of a sensor property.

Parameters ​
property ​

TargetPreset

Returns ​

string | undefined

Overrides ​

SensorLike.getValue

Call Signature ​

getValue(property): PTZRelativeMove | undefined

Defined in: sensor/ptz.ts:114

Get the current value of a sensor property.

Parameters ​
property ​

RelativeMove

Returns ​

PTZRelativeMove | undefined

Overrides ​

SensorLike.getValue

Call Signature ​

getValue(property): unknown

Defined in: sensor/ptz.ts:115

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

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

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

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