Class Display

Display service

Hierarchy (View Summary)

default
- Display

Index

Constructors

Properties

onvif service xmlns

Methods

createPaneConfiguration deletePaneConfiguration getDisplayOptions getLayout getPaneConfiguration getPaneConfigurations getServiceCapabilities request setLayout setPaneConfiguration setPaneConfigurations

Constructors

constructor

new Display(onvif: Onvif, service: keyof OnvifServices): Display
Parameters
- onvif: Onvif
- service: keyof OnvifServices
Returns Display
Overrides default.constructor
- Defined in display.ts:35

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

createPaneConfiguration

createPaneConfiguration(options: CreatePaneConfiguration): Promise<string>
Creates a pane configuration on a video output.
Parameters
- options: CreatePaneConfiguration
Returns Promise<string>
- Defined in display.ts:220

deletePaneConfiguration

deletePaneConfiguration(options: DeletePaneConfiguration): Promise<void>
Deletes a pane configuration from a video output.
Parameters
- options: DeletePaneConfiguration
Returns Promise<void>
- Defined in display.ts:237

getDisplayOptions

getDisplayOptions(
options: GetDisplayOptions,
): Promise<GetDisplayOptionsResponse>
Returns display options for a video output.
Parameters
- options: GetDisplayOptions
Returns Promise<GetDisplayOptionsResponse>
- Defined in display.ts:145

getLayout

getLayout(options: GetLayout): Promise<any>
Returns the current layout of a video output.
Parameters
- options: GetLayout
Returns Promise<any>
- Defined in display.ts:116

getPaneConfiguration

getPaneConfiguration(options: GetPaneConfiguration): Promise<PaneConfiguration>
Returns a pane configuration for a video output.
Parameters
- options: GetPaneConfiguration
Returns Promise<PaneConfiguration>
- Defined in display.ts:177

getPaneConfigurations

getPaneConfigurations(
options: GetPaneConfigurations,
): Promise<PaneConfiguration[]>
Returns pane configurations for a video output.
Parameters
- options: GetPaneConfigurations
Returns Promise<PaneConfiguration[]>
- Defined in display.ts:161

getServiceCapabilities

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

Returns Promise<Capabilities>
- Defined in display.ts:105

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

setLayout

setLayout(options: SetLayout): Promise<void>
Sets the layout of a video output.
Parameters
- options: SetLayout
Returns Promise<void>
- Defined in display.ts:132

setPaneConfiguration

setPaneConfiguration(options: SetPaneConfiguration): Promise<void>
Sets a pane configuration for a video output.
Parameters
- options: SetPaneConfiguration
Returns Promise<void>
- Defined in display.ts:207

setPaneConfigurations

setPaneConfigurations(options: SetPaneConfigurations): Promise<void>
Sets pane configurations for a video output.
Parameters
- options: SetPaneConfigurations
Returns Promise<void>
- Defined in display.ts:194