Class Imaging

Imaging service

Example

  const is = await cam.imaging.getImagingSettings();
  is.brightness = 70;
  await cam.imaging.setImagingSettings({
    imagingSettings: is,
    forcePersistence: true,
  });

Hierarchy (View Summary)

default
- Imaging

Index

Constructors

constructor

new Imaging(onvif: Onvif, service: keyof OnvifServices): Imaging
Parameters
- onvif: Onvif
- service: keyof OnvifServices
Returns Imaging
Overrides default.constructor
- Defined in imaging.ts:68

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

getCurrentPreset

getCurrentPreset(options?: GetCurrentPresetExtended): Promise<ImagingPreset>
Get the current imaging preset for the requested video source.
Parameters
- options: GetCurrentPresetExtended = {}
Returns Promise<ImagingPreset>
- Defined in imaging.ts:304

getImagingSettings

getImagingSettings(
options?: GetImagingSettingsExtended,
): Promise<ImagingSettings20>
Get the imaging configuration for the requested video source.
Parameters
- options: GetImagingSettingsExtended = {}
Returns Promise<ImagingSettings20>
- Defined in imaging.ts:193

getMoveOptions

getMoveOptions(options?: GetMoveOptionsExtended): Promise<MoveOptions20>
Get valid ranges for focus lens move options.
Parameters
- options: GetMoveOptionsExtended = {}
Returns Promise<MoveOptions20>
- Defined in imaging.ts:250

getOptions

getOptions(options?: GetOptionsExtended): Promise<ImagingOptions20>
Get valid ranges for imaging parameters that have device-specific ranges.
Parameters
- options: GetOptionsExtended = {}
Returns Promise<ImagingOptions20>
- Defined in imaging.ts:224

getPresets

getPresets(options?: GetPresetsExtended): Promise<ImagingPreset[]>
Get imaging presets available for the requested video source.
Parameters
- options: GetPresetsExtended = {}
Returns Promise<ImagingPreset[]>
- Defined in imaging.ts:288

getServiceCapabilities

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

Returns Promise<Capabilities>
- Defined in imaging.ts:182

getStatus

getStatus(options?: GetStatusExtended): Promise<ImagingStatus20>
Get imaging status for the requested video source.
Parameters
- options: GetStatusExtended = {}
Returns Promise<ImagingStatus20>
- Defined in imaging.ts:275

move

move(options: MoveExtended): Promise<void>
Move the focus lens in absolute, relative, or continuous manner.
Parameters
- options: MoveExtended
Returns Promise<void>
- Defined in imaging.ts:237

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

setCurrentPreset

setCurrentPreset(options: SetCurrentPresetExtended): Promise<void>
Apply an imaging preset to the requested video source.
Parameters
- options: SetCurrentPresetExtended
Returns Promise<void>
- Defined in imaging.ts:317

setImagingSettings

setImagingSettings(options: SetImagingSettingsExtended): Promise<void>
Set the imaging configuration for the requested video source.
Parameters
- options: SetImagingSettingsExtended
Returns Promise<void>
- Defined in imaging.ts:206

stop

stop(options?: StopExtended): Promise<void>
Stop ongoing focus movement for the requested video source.
Parameters
- options: StopExtended = {}
Returns Promise<void>
- Defined in imaging.ts:263

Class Imaging

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Imaging

Properties

Protected Readonlyonvif

Protected Readonlyservice

Protected Readonlyxmlns

Methods

getCurrentPreset

Parameters

Returns Promise<ImagingPreset>

getImagingSettings

Parameters

Returns Promise<ImagingSettings20>

getMoveOptions

Parameters

Returns Promise<MoveOptions20>

getOptions

Parameters

Returns Promise<ImagingOptions20>

getPresets

Parameters

Returns Promise<ImagingPreset[]>

getServiceCapabilities

Returns Promise<Capabilities>

getStatus

Parameters

Returns Promise<ImagingStatus20>

move

Parameters

Returns Promise<void>

request

Parameters

Returns Promise<any>

setCurrentPreset

Parameters

Returns Promise<void>

setImagingSettings

Parameters

Returns Promise<void>

stop

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`onvif

`Protected` `Readonly`service

`Protected` `Readonly`xmlns