Skip to content

Display

Display service implementation.

Display

Bases: ONVIFService

0.0.1 2.0

Display service client.

Property Details
First introduced ONVIF 2.0 (November 2010)
Binding name DisplayBinding (ver10/display.wsdl)
Operations display.wsdl
Spec Display

GetServiceCapabilities

GetServiceCapabilities()

Returns the capabilities of the display service.

The result is returned in a typed answer.

GetLayout

GetLayout(VideoOutput)

Return the current layout of a video output.

The Layout assigns a pane configuration to a certain area of the display. The layout settings directly affect a specific video output. The layout consists of a list of PaneConfigurations and their associated display areas.

SetLayout

SetLayout(VideoOutput, Layout)

Change the layout of a display (e.g. change from single view to split screen view).The Layout assigns a pane configuration to a certain area of the display.

The layout settings directly affect a specific video output. The layout consists of a list of PaneConfigurations and their associated display areas.

A device implementation shall be tolerant against rounding errors when matching a layout against its fixed set of layouts by accepting differences of at least one percent.

GetDisplayOptions

GetDisplayOptions(VideoOutput)

The Display Options contain the supported layouts (LayoutOptions) and the decoding and encoding capabilities (CodingCapabilities) of the device.

The GetDisplayOptions command returns both, Layout and Coding Capabilities, of a VideoOutput.

GetPaneConfigurations

GetPaneConfigurations(VideoOutput)

List all currently defined panes of a device for a specified video output (regardless if this pane is visible at a moment).

A Pane is a display area on the monitor that is attached to a video output. A pane has a PaneConfiguration that describes which entities are associated with the pane. A client has to configure the pane according to the connection to be established by setting the AudioOutput and/or AudioSourceToken. If a Token is not set, the corresponding session will not be established.

GetPaneConfiguration

GetPaneConfiguration(VideoOutput, Pane)

Retrieve the pane configuration for a pane token.

SetPaneConfigurations

SetPaneConfigurations(VideoOutput, PaneConfiguration)

Modify one or more configurations of the specified video output.

This method will only modify the provided configurations and leave the others unchanged. Use DeletePaneConfiguration to remove pane configurations.

SetPaneConfiguration

SetPaneConfiguration(VideoOutput, PaneConfiguration)

This command changes the configuration of the specified pane (tbd)

CreatePaneConfiguration

CreatePaneConfiguration(VideoOutput, PaneConfiguration)

Create a new pane configuration describing the streaming and coding settings for a display area.

This optional method is only supported by devices that signal support of dynamic pane creation via their capabilities.

The content of the Token field may be ignored by the device.

DeletePaneConfiguration

DeletePaneConfiguration(VideoOutput, PaneToken)

Delete a pane configuration.

A service must respond with an error if the pane configuration is in use by the current layout.

This optional method is only supported by devices that signal support of dynamic pane creation via their capabilities.