Class Thermal

Thermal service

Example

 const configs = await cam.thermal.getConfigurations();
 const token = configs.configurations![0].token;
 console.log((await cam.thermal.getConfiguration({ videoSourceToken: token })).polarity);
 await cam.thermal.setConfiguration({
   videoSourceToken: token,
   configuration: {
     colorPalette: configs.configurations![0].configuration.colorPalette,
     polarity: 'WhiteHot',
   },
 });

Hierarchy (View Summary)

default
- Thermal

Index

Constructors

constructor

new Thermal(onvif: Onvif): Thermal
Parameters
- onvif: Onvif
Returns Thermal
Overrides default.constructor
- Defined in thermal.ts:45

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

getConfiguration

getConfiguration(options: GetConfiguration): Promise<Configuration>
Gets the Thermal Configuration for the requested VideoSource.
Parameters
- options: GetConfiguration
Returns Promise<Configuration>
- Defined in thermal.ts:147

getConfigurationOptions

getConfigurationOptions(
options: GetConfigurationOptions,
): Promise<ConfigurationOptions>
Gets the valid ranges for the Thermal parameters that have device specific ranges.
Parameters
- options: GetConfigurationOptions
Returns Promise<ConfigurationOptions>
- Defined in thermal.ts:131

getConfigurations

getConfigurations(): Promise<GetConfigurationsResponse>
Gets the Thermal Configuration for all thermal VideoSources of the Device.

Returns Promise<GetConfigurationsResponse>
- Defined in thermal.ts:159

getRadiometryConfiguration

getRadiometryConfiguration(
options: GetRadiometryConfiguration,
): Promise<RadiometryConfiguration>
Gets the Radiometry Configuration for the requested VideoSource.
Parameters
- options: GetRadiometryConfiguration
Returns Promise<RadiometryConfiguration>
- Defined in thermal.ts:201

getRadiometryConfigurationOptions

getRadiometryConfigurationOptions(
options: GetRadiometryConfigurationOptions,
): Promise<RadiometryConfigurationOptions>
Gets the valid ranges for the Radiometry parameters that have device specific ranges.
Parameters
- options: GetRadiometryConfigurationOptions
Returns Promise<RadiometryConfigurationOptions>
- Defined in thermal.ts:186

getServiceCapabilities

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

Returns Promise<Capabilities>
- Defined in thermal.ts:120

request

request<T = any>(
body: Record<string, any>,
options?: LineraseOptions,
): Promise<T>
Type Parameters
- T = any
Parameters
- body: Record<string, any>
- Optionaloptions: LineraseOptions
Returns Promise<T>
Inherited from default.request
- Defined in service.ts:49

setConfiguration

setConfiguration(options: SetConfiguration): Promise<void>
Sets the Thermal Configuration for the requested VideoSource.
Parameters
- options: SetConfiguration
Returns Promise<void>
- Defined in thermal.ts:173

setRadiometryConfiguration

setRadiometryConfiguration(options: SetRadiometryConfiguration): Promise<void>
Sets the Radiometry Configuration for the requested VideoSource.
Parameters
- options: SetRadiometryConfiguration
Returns Promise<void>
- Defined in thermal.ts:214

Class Thermal

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Thermal

Properties

Protected Readonlyonvif

Protected Readonlyservice

Protected Readonlyxmlns

Methods

getConfiguration

Parameters

Returns Promise<Configuration>

getConfigurationOptions

Parameters

Returns Promise<ConfigurationOptions>

getConfigurations

Returns Promise<GetConfigurationsResponse>

getRadiometryConfiguration

Parameters

Returns Promise<RadiometryConfiguration>

getRadiometryConfigurationOptions

Parameters

Returns Promise<RadiometryConfigurationOptions>

getServiceCapabilities

Returns Promise<Capabilities>

request

Type Parameters

Parameters

Returns Promise<T>

setConfiguration

Parameters

Returns Promise<void>

setRadiometryConfiguration

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`onvif

`Protected` `Readonly`service

`Protected` `Readonly`xmlns