Class DeviceIO

DeviceIO service

Example

await cam.connect();
const caps = await cam.deviceIO.getServiceCapabilities();
const relays = await cam.deviceIO.getRelayOutputs();
const inputs = await cam.deviceIO.getDigitalInputs();
await cam.deviceIO.setRelayOutputState({
  relayOutputToken: 'RelayOutputToken_1',
  logicalState: 'active',
});

Hierarchy (View Summary)

default
- DeviceIO

Constructors

constructor

new DeviceIO(onvif: Onvif, service: keyof OnvifServices): DeviceIO
Parameters
- onvif: Onvif
- service: keyof OnvifServices
Returns DeviceIO
Overrides default.constructor
- Defined in deviceio.ts:69

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

getAudioOutputConfiguration

getAudioOutputConfiguration(
options: GetAudioOutputConfiguration,
): Promise<AudioOutputConfiguration>
Returns the audio output configuration for a physical audio output.
Parameters
- options: GetAudioOutputConfiguration
Returns Promise<AudioOutputConfiguration>
- Defined in deviceio.ts:294

getAudioOutputConfigurationOptions

getAudioOutputConfigurationOptions(
options: GetAudioOutputConfigurationOptions,
): Promise<AudioOutputConfigurationOptions>
Returns valid ranges for audio output configuration parameters.
Parameters
- options: GetAudioOutputConfigurationOptions
Returns Promise<AudioOutputConfigurationOptions>
- Defined in deviceio.ts:406

getAudioOutputs

getAudioOutputs(): Promise<string[]>
Returns tokens of available audio outputs.

Returns Promise<string[]>
- Defined in deviceio.ts:232

getAudioSourceConfiguration

getAudioSourceConfiguration(
options: GetAudioSourceConfiguration,
): Promise<AudioSourceConfiguration>
Returns the audio source configuration for a physical audio source.
Parameters
- options: GetAudioSourceConfiguration
Returns Promise<AudioSourceConfiguration>
- Defined in deviceio.ts:279

getAudioSourceConfigurationOptions

getAudioSourceConfigurationOptions(
options: GetAudioSourceConfigurationOptions,
): Promise<AudioSourceConfigurationOptions>
Returns valid ranges for audio source configuration parameters.
Parameters
- options: GetAudioSourceConfigurationOptions
Returns Promise<AudioSourceConfigurationOptions>
- Defined in deviceio.ts:391

getAudioSources

getAudioSources(): Promise<string[]>
Returns tokens of available audio sources.

Returns Promise<string[]>
- Defined in deviceio.ts:224

getDigitalInputConfigurationOptions

getDigitalInputConfigurationOptions(
options?: GetDigitalInputConfigurationOptions,
): Promise<DigitalInputConfigurationOptions>
Returns configuration options for digital inputs.
Parameters
- options: GetDigitalInputConfigurationOptions = {}
Returns Promise<DigitalInputConfigurationOptions>
- Defined in deviceio.ts:462

getDigitalInputs

getDigitalInputs(): Promise<DigitalInput[]>
Returns digital inputs available on the device.

Returns Promise<DigitalInput[]>
- Defined in deviceio.ts:453

getRelayOutputOptions

getRelayOutputOptions(
options?: GetRelayOutputOptions,
): Promise<RelayOutputOptions[]>
Request the available settings and ranges for one or all relay outputs.
Parameters
- options: GetRelayOutputOptions = {}
Returns Promise<RelayOutputOptions[]>
- Defined in deviceio.ts:201

getRelayOutputs

getRelayOutputs(): Promise<RelayOutput[]>
Returns relay outputs available on the device.

Returns Promise<RelayOutput[]>
- Defined in deviceio.ts:420

getSerialPortConfiguration

getSerialPortConfiguration(
options: GetSerialPortConfiguration,
): Promise<SerialPortConfiguration>
Returns the configuration of a serial port.
Parameters
- options: GetSerialPortConfiguration
Returns Promise<SerialPortConfiguration>
- Defined in deviceio.ts:500

getSerialPortConfigurationOptions

getSerialPortConfigurationOptions(
options: GetSerialPortConfigurationOptions,
): Promise<SerialPortConfigurationOptions>
Returns configuration options for a serial port.
Parameters
- options: GetSerialPortConfigurationOptions
Returns Promise<SerialPortConfigurationOptions>
- Defined in deviceio.ts:529

getSerialPorts

getSerialPorts(): Promise<SerialPort[]>
Returns serial ports available on the device.

Returns Promise<SerialPort[]>
- Defined in deviceio.ts:491

getServiceCapabilities

getServiceCapabilities(): Promise<Capabilities>
Returns the capabilities of the device IO service.

Returns Promise<Capabilities>
- Defined in deviceio.ts:190

getVideoOutputConfiguration

getVideoOutputConfiguration(
options: GetVideoOutputConfiguration,
): Promise<VideoOutputConfiguration>
Returns the video output configuration for a physical video output.
Parameters
- options: GetVideoOutputConfiguration
Returns Promise<VideoOutputConfiguration>
- Defined in deviceio.ts:264

getVideoOutputConfigurationOptions

getVideoOutputConfigurationOptions(
options: GetVideoOutputConfigurationOptions,
): Promise<VideoOutputConfigurationOptions>
Returns valid ranges for video output configuration parameters.
Parameters
- options: GetVideoOutputConfigurationOptions
Returns Promise<VideoOutputConfigurationOptions>
- Defined in deviceio.ts:376

getVideoOutputs

getVideoOutputs(): Promise<VideoOutput[]>
Returns available physical video outputs.

Returns Promise<VideoOutput[]>
- Defined in deviceio.ts:240

getVideoSourceConfiguration

getVideoSourceConfiguration(
options: GetVideoSourceConfiguration,
): Promise<VideoSourceConfiguration>
Returns the video source configuration for a physical video source.
Parameters
- options: GetVideoSourceConfiguration
Returns Promise<VideoSourceConfiguration>
- Defined in deviceio.ts:249

getVideoSourceConfigurationOptions

getVideoSourceConfigurationOptions(
options: GetVideoSourceConfigurationOptions,
): Promise<VideoSourceConfigurationOptions>
Returns valid ranges for video source configuration parameters.
Parameters
- options: GetVideoSourceConfigurationOptions
Returns Promise<VideoSourceConfigurationOptions>
- Defined in deviceio.ts:361

getVideoSources

getVideoSources(): Promise<string[]>
Returns tokens of available video sources.

Returns Promise<string[]>
- Defined in deviceio.ts:216

request

request(query: Record<string, any>, options?: LineraseOptions): Promise<any>
Parameters
- query: Record<string, any>
- Optionaloptions: LineraseOptions
Returns Promise<any>
Inherited from default.request
- Defined in service.ts:37

sendReceiveSerialCommand

sendReceiveSerialCommand(
options: SendReceiveSerialCommand,
): Promise<SendReceiveSerialCommandResponse>
Sends data to a serial port and optionally receives a response.
Parameters
- options: SendReceiveSerialCommand
Returns Promise<SendReceiveSerialCommandResponse>
- Defined in deviceio.ts:544

setAudioOutputConfiguration

setAudioOutputConfiguration(options: SetAudioOutputConfiguration): Promise<void>
Modifies an audio output configuration.
Parameters
- options: SetAudioOutputConfiguration
Returns Promise<void>
- Defined in deviceio.ts:348

setAudioSourceConfiguration

setAudioSourceConfiguration(options: SetAudioSourceConfiguration): Promise<void>
Modifies an audio source configuration.
Parameters
- options: SetAudioSourceConfiguration
Returns Promise<void>
- Defined in deviceio.ts:335

setDigitalInputConfigurations

setDigitalInputConfigurations(
options: SetDigitalInputConfigurations,
): Promise<void>
Modifies digital input configurations.
Parameters
- options: SetDigitalInputConfigurations
Returns Promise<void>
- Defined in deviceio.ts:480

setRelayOutputSettings

setRelayOutputSettings(options: SetRelayOutputSettings): Promise<void>
Modifies relay output settings.
Parameters
- options: SetRelayOutputSettings
Returns Promise<void>
- Defined in deviceio.ts:429

setRelayOutputState

setRelayOutputState(options: SetRelayOutputState): Promise<void>
Sets the logical state of a relay output.
Parameters
- options: SetRelayOutputState
Returns Promise<void>
- Defined in deviceio.ts:441

setSerialPortConfiguration

setSerialPortConfiguration(options: SetSerialPortConfiguration): Promise<void>
Modifies the configuration of a serial port.
Parameters
- options: SetSerialPortConfiguration
Returns Promise<void>
- Defined in deviceio.ts:513

setVideoOutputConfiguration

setVideoOutputConfiguration(options: SetVideoOutputConfiguration): Promise<void>
Modifies a video output configuration.
Parameters
- options: SetVideoOutputConfiguration
Returns Promise<void>
- Defined in deviceio.ts:322

setVideoSourceConfiguration

setVideoSourceConfiguration(options: SetVideoSourceConfiguration): Promise<void>
Modifies a video source configuration.
Parameters
- options: SetVideoSourceConfiguration
Returns Promise<void>
- Defined in deviceio.ts:309

Class DeviceIO

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DeviceIO

Properties

Protected Readonlyonvif

Protected Readonlyservice

Protected Readonlyxmlns

Methods

getAudioOutputConfiguration

Parameters

Returns Promise<AudioOutputConfiguration>

getAudioOutputConfigurationOptions

Parameters

Returns Promise<AudioOutputConfigurationOptions>

getAudioOutputs

Returns Promise<string[]>

getAudioSourceConfiguration

Parameters

Returns Promise<AudioSourceConfiguration>

getAudioSourceConfigurationOptions

Parameters

Returns Promise<AudioSourceConfigurationOptions>

getAudioSources

Returns Promise<string[]>

getDigitalInputConfigurationOptions

Parameters

Returns Promise<DigitalInputConfigurationOptions>

getDigitalInputs

Returns Promise<DigitalInput[]>

getRelayOutputOptions

Parameters

Returns Promise<RelayOutputOptions[]>

getRelayOutputs

Returns Promise<RelayOutput[]>

getSerialPortConfiguration

Parameters

Returns Promise<SerialPortConfiguration>

getSerialPortConfigurationOptions

Parameters

Returns Promise<SerialPortConfigurationOptions>

getSerialPorts

Returns Promise<SerialPort[]>

getServiceCapabilities

Returns Promise<Capabilities>

getVideoOutputConfiguration

Parameters

Returns Promise<VideoOutputConfiguration>

getVideoOutputConfigurationOptions

Parameters

Returns Promise<VideoOutputConfigurationOptions>

getVideoOutputs

Returns Promise<VideoOutput[]>

getVideoSourceConfiguration

Parameters

Returns Promise<VideoSourceConfiguration>

getVideoSourceConfigurationOptions

Parameters

Returns Promise<VideoSourceConfigurationOptions>

getVideoSources

Returns Promise<string[]>

request

Parameters

Returns Promise<any>

sendReceiveSerialCommand

Parameters

Returns Promise<SendReceiveSerialCommandResponse>

setAudioOutputConfiguration

Parameters

Returns Promise<void>

setAudioSourceConfiguration

Parameters

Returns Promise<void>

`Protected` `Readonly`onvif

`Protected` `Readonly`service

`Protected` `Readonly`xmlns