Display
Display service implementation.
Display
Bases: ONVIFService
Display service client.
| Property | Details |
|---|---|
| First introduced | ONVIF 2.0 (November 2010) |
| Binding name | DisplayBinding (ver10/display.wsdl) |
| Operations | display.wsdl |
| Spec | Display |
GetServiceCapabilities
Returns the capabilities of the display service.
The result is returned in a typed answer.
Output
-
Capabilities[Capabilities]The capabilities for the display service is returned in the Capabilities element.-
FixedLayout- optional; [boolean]Indication that the SetLayout command supports only predefined layouts.
-
GetLayout
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.
Input
-
VideoOutput[ReferenceToken]Token of the Video Output whose Layout is requested
Output
-
Layout[Layout]Current layout of the video output.-
PaneLayout- unbounded; [PaneLayout]List of panes assembling the display layout.-
Pane[ReferenceToken]Reference to the configuration of the streaming and coding parameters. -
Area[Rectangle]Describes the location and size of the area on the monitor. The area coordinate values are expressed in normalized units [-1.0, 1.0].-
bottom- required; [float] -
top- required; [float] -
right- required; [float] -
left- required; [float]
-
-
-
Extension- optional; [LayoutExtension]
-
SetLayout
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.
Input
-
VideoOutput[ReferenceToken]Token of the Video Output whose Layout shall be changed. -
Layout[Layout]Layout to be set-
PaneLayout- unbounded; [PaneLayout]List of panes assembling the display layout.-
Pane[ReferenceToken]Reference to the configuration of the streaming and coding parameters. -
Area[Rectangle]Describes the location and size of the area on the monitor. The area coordinate values are expressed in normalized units [-1.0, 1.0].-
bottom- required; [float] -
top- required; [float] -
right- required; [float] -
left- required; [float]
-
-
-
Extension- optional; [LayoutExtension]
-
GetDisplayOptions
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.
Input
-
VideoOutput[ReferenceToken]Token of the Video Output whose options are requested
Output
-
LayoutOptions- optional; [LayoutOptions]The LayoutOptions describe the fixed and predefined layouts of a device. If the device does not offer fixed layouts and allows setting the layout free this element is empty.-
PaneLayoutOptions- unbounded; [PaneLayoutOptions]Lists the possible Pane Layouts of the Video Output-
Area- unbounded; [Rectangle]List of areas assembling a layout. Coordinate values are in the range [-1.0, 1.0].-
bottom- required; [float] -
top- required; [float] -
right- required; [float] -
left- required; [float]
-
-
Extension- optional; [PaneOptionExtension]
-
-
Extension- optional; [LayoutOptionsExtension]
-
-
CodingCapabilities[CodingCapabilities]decoding and encoding capabilities of the device-
AudioEncodingCapabilities- optional; [AudioEncoderConfigurationOptions]If the device supports audio encoding this section describes the supported codecs and their configuration.-
Options- optional, unbounded; [AudioEncoderConfigurationOption]list of supported AudioEncoderConfigurations-
Encoding[AudioEncoding]The encoding used for audio data (either G.711, G.726 or AAC).Enum Value Enum Description G711— G726— AAC— -
BitrateList[IntItems]List of supported bitrates in kbps for the specified Encoding.-
Items- optional, unbounded; [int]
-
-
SampleRateList[IntItems]List of supported Sample Rates in kHz for the specified Encoding.-
Items- optional, unbounded; [int]
-
-
-
-
AudioDecodingCapabilities- optional; [AudioDecoderConfigurationOptions]If the device supports audio decoding this section describes the supported codecs and their settings.-
AACDecOptions- optional; [AACDecOptions]If the device is able to decode AAC encoded audio this section describes the supported configurations-
Bitrate[IntItems]List of supported bitrates in kbps.-
Items- optional, unbounded; [int]
-
-
SampleRateRange[IntItems]List of supported sample rates in kHz-
Items- optional, unbounded; [int]
-
-
-
G711DecOptions- optional; [G711DecOptions]If the device is able to decode G711 encoded audio this section describes the supported configurations-
Bitrate[IntItems]List of supported bitrates in kbps.-
Items- optional, unbounded; [int]
-
-
SampleRateRange[IntItems]List of supported sample rates in kHz-
Items- optional, unbounded; [int]
-
-
-
G726DecOptions- optional; [G726DecOptions]If the device is able to decode G726 encoded audio this section describes the supported configurations-
Bitrate[IntItems]List of supported bitrates in kbps.-
Items- optional, unbounded; [int]
-
-
SampleRateRange[IntItems]List of supported sample rates in kHz-
Items- optional, unbounded; [int]
-
-
-
Extension- optional; [AudioDecoderConfigurationOptionsExtension]
-
-
VideoDecodingCapabilities[VideoDecoderConfigurationOptions]This section describes the supported video codecs and their configuration.-
JpegDecOptions- optional; [JpegDecOptions]If the device is able to decode Jpeg streams this element describes the supported codecs and configurations-
ResolutionsAvailable- unbounded; [VideoResolution]List of supported Jpeg Video Resolutions-
Width[int]Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image. -
Height[int]Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image.
-
-
SupportedInputBitrate[IntRange]Supported Jpeg bitrate range in kbps.-
Min[int] -
Max[int]
-
-
SupportedFrameRate[IntRange]Supported Jpeg framerate range in fps-
Min[int] -
Max[int]
-
-
-
H264DecOptions- optional; [H264DecOptions]If the device is able to decode H.264 streams this element describes the supported codecs and configurations-
ResolutionsAvailable- unbounded; [VideoResolution]List of supported H.264 Video Resolutions-
Width[int]Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image. -
Height[int]Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image.
-
-
SupportedH264Profiles- unbounded; [H264Profile]List of supported H264 Profiles (either baseline, main, extended or high).Enum Value Enum Description Baseline— Main— Extended— High— -
SupportedInputBitrate[IntRange]Supported H.264 bitrate range in kbps.-
Min[int] -
Max[int]
-
-
SupportedFrameRate[IntRange]Supported H.264 framerate range in fps-
Min[int] -
Max[int]
-
-
-
Mpeg4DecOptions- optional; [Mpeg4DecOptions]If the device is able to decode Mpeg4 streams this element describes the supported codecs and configurations-
ResolutionsAvailable- unbounded; [VideoResolution]List of supported Mpeg4 Video Resolutions-
Width[int]Number of the columns of the Video image. If there is a 90-degree rotation, this represents the number of lines of the Video image. -
Height[int]Number of the lines of the Video image. If there is a 90-degree rotation, this represents the number of columns of the Video image.
-
-
SupportedMpeg4Profiles- unbounded; [Mpeg4Profile]List of supported Mpeg4 Profiles (either SP or ASP)Enum Value Enum Description SP— ASP— -
SupportedInputBitrate[IntRange]Supported Mpeg4 bitrate range in kbps.-
Min[int] -
Max[int]
-
-
SupportedFrameRate[IntRange]Supported Mpeg4 framerate range in fps-
Min[int] -
Max[int]
-
-
-
Extension- optional; [VideoDecoderConfigurationOptionsExtension]
-
-
GetPaneConfigurations
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.
Input
-
VideoOutput[ReferenceToken]Reference Token of the Video Output whose Pane Configurations are requested
Output
-
PaneConfiguration- unbounded; [PaneConfiguration]Contains a list of defined Panes of the specified VideoOutput. Each VideoOutput has at least one PaneConfiguration.-
PaneName- optional; [string]Optional name of the pane configuration. -
AudioOutputToken- optional; [ReferenceToken]If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client can retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service. -
AudioSourceToken- optional; [ReferenceToken]If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane. The audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the DeviceIO service. -
AudioEncoderConfiguration- optional; [AudioEncoderConfiguration]The configuration of the audio encoder including codec, bitrate and sample rate.-
Name[Name]User readable name. Length up to 64 characters. -
UseCount[int]Number of internal references currently using this configuration.This informational parameter is read-only. Deprecated for Media2 Service.
-
Encoding[AudioEncoding]Audio codec used for encoding the audio input (either G.711, G.726 or AAC).Enum Value Enum Description G711— G726— AAC— -
Bitrate[int]The output bitrate in kbps. -
SampleRate[int]The output sample rate in kHz. -
Multicast[MulticastConfiguration]Defines the multicast settings that could be used for video streaming.-
Address[IPAddress]The multicast address (if this address is set to 0 no multicast streaming is enabled)-
Type[IPType]Indicates if the address is an IPv4 or IPv6 address.Enum Value Enum Description IPv4— IPv6— -
IPv4Address- optional; [IPv4Address]IPv4 address. -
IPv6Address- optional; [IPv6Address]IPv6 address
-
-
Port[int]The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification. -
TTL[int]In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope. -
AutoStart[boolean]Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state.
-
-
SessionTimeout[duration]The rtsp session timeout for the related audio stream
-
-
ReceiverToken- optional; [ReferenceToken]A pointer to a Receiver that has the necessary information to receive data from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the GetReceivers command of the Receiver Service. -
Token[ReferenceToken]A unique identifier in the display device.
-
GetPaneConfiguration
Retrieve the pane configuration for a pane token.
Input
-
VideoOutput[ReferenceToken]Reference Token of the Video Output the requested pane belongs to -
Pane[ReferenceToken]Reference Token of the Pane whose Configuration is requested
Output
-
PaneConfiguration[PaneConfiguration]returns the configuration of the requested pane.-
PaneName- optional; [string]Optional name of the pane configuration. -
AudioOutputToken- optional; [ReferenceToken]If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client can retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service. -
AudioSourceToken- optional; [ReferenceToken]If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane. The audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the DeviceIO service. -
AudioEncoderConfiguration- optional; [AudioEncoderConfiguration]The configuration of the audio encoder including codec, bitrate and sample rate.-
Name[Name]User readable name. Length up to 64 characters. -
UseCount[int]Number of internal references currently using this configuration.This informational parameter is read-only. Deprecated for Media2 Service.
-
Encoding[AudioEncoding]Audio codec used for encoding the audio input (either G.711, G.726 or AAC).Enum Value Enum Description G711— G726— AAC— -
Bitrate[int]The output bitrate in kbps. -
SampleRate[int]The output sample rate in kHz. -
Multicast[MulticastConfiguration]Defines the multicast settings that could be used for video streaming.-
Address[IPAddress]The multicast address (if this address is set to 0 no multicast streaming is enabled)-
Type[IPType]Indicates if the address is an IPv4 or IPv6 address.Enum Value Enum Description IPv4— IPv6— -
IPv4Address- optional; [IPv4Address]IPv4 address. -
IPv6Address- optional; [IPv6Address]IPv6 address
-
-
Port[int]The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification. -
TTL[int]In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope. -
AutoStart[boolean]Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state.
-
-
SessionTimeout[duration]The rtsp session timeout for the related audio stream
-
-
ReceiverToken- optional; [ReferenceToken]A pointer to a Receiver that has the necessary information to receive data from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the GetReceivers command of the Receiver Service. -
Token[ReferenceToken]A unique identifier in the display device.
-
SetPaneConfigurations
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.
Input
-
VideoOutput[ReferenceToken]Token of the video output whose panes to set. -
PaneConfiguration- unbounded; [PaneConfiguration]Pane Configuration to be set.-
PaneName- optional; [string]Optional name of the pane configuration. -
AudioOutputToken- optional; [ReferenceToken]If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client can retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service. -
AudioSourceToken- optional; [ReferenceToken]If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane. The audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the DeviceIO service. -
AudioEncoderConfiguration- optional; [AudioEncoderConfiguration]The configuration of the audio encoder including codec, bitrate and sample rate.-
Name[Name]User readable name. Length up to 64 characters. -
UseCount[int]Number of internal references currently using this configuration.This informational parameter is read-only. Deprecated for Media2 Service.
-
Encoding[AudioEncoding]Audio codec used for encoding the audio input (either G.711, G.726 or AAC).Enum Value Enum Description G711— G726— AAC— -
Bitrate[int]The output bitrate in kbps. -
SampleRate[int]The output sample rate in kHz. -
Multicast[MulticastConfiguration]Defines the multicast settings that could be used for video streaming.-
Address[IPAddress]The multicast address (if this address is set to 0 no multicast streaming is enabled)-
Type[IPType]Indicates if the address is an IPv4 or IPv6 address.Enum Value Enum Description IPv4— IPv6— -
IPv4Address- optional; [IPv4Address]IPv4 address. -
IPv6Address- optional; [IPv6Address]IPv6 address
-
-
Port[int]The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification. -
TTL[int]In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope. -
AutoStart[boolean]Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state.
-
-
SessionTimeout[duration]The rtsp session timeout for the related audio stream
-
-
ReceiverToken- optional; [ReferenceToken]A pointer to a Receiver that has the necessary information to receive data from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the GetReceivers command of the Receiver Service. -
Token[ReferenceToken]A unique identifier in the display device.
-
SetPaneConfiguration
This command changes the configuration of the specified pane (tbd)
Input
-
VideoOutput[ReferenceToken]Token of the video output whose panes to set. -
PaneConfiguration[PaneConfiguration]Pane Configuration to be set.-
PaneName- optional; [string]Optional name of the pane configuration. -
AudioOutputToken- optional; [ReferenceToken]If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client can retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service. -
AudioSourceToken- optional; [ReferenceToken]If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane. The audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the DeviceIO service. -
AudioEncoderConfiguration- optional; [AudioEncoderConfiguration]The configuration of the audio encoder including codec, bitrate and sample rate.-
Name[Name]User readable name. Length up to 64 characters. -
UseCount[int]Number of internal references currently using this configuration.This informational parameter is read-only. Deprecated for Media2 Service.
-
Encoding[AudioEncoding]Audio codec used for encoding the audio input (either G.711, G.726 or AAC).Enum Value Enum Description G711— G726— AAC— -
Bitrate[int]The output bitrate in kbps. -
SampleRate[int]The output sample rate in kHz. -
Multicast[MulticastConfiguration]Defines the multicast settings that could be used for video streaming.-
Address[IPAddress]The multicast address (if this address is set to 0 no multicast streaming is enabled)-
Type[IPType]Indicates if the address is an IPv4 or IPv6 address.Enum Value Enum Description IPv4— IPv6— -
IPv4Address- optional; [IPv4Address]IPv4 address. -
IPv6Address- optional; [IPv6Address]IPv6 address
-
-
Port[int]The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification. -
TTL[int]In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope. -
AutoStart[boolean]Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state.
-
-
SessionTimeout[duration]The rtsp session timeout for the related audio stream
-
-
ReceiverToken- optional; [ReferenceToken]A pointer to a Receiver that has the necessary information to receive data from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the GetReceivers command of the Receiver Service. -
Token[ReferenceToken]A unique identifier in the display device.
-
CreatePaneConfiguration
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.
Input
-
VideoOutput[ReferenceToken]Token of the video output where the pane shall be created. -
PaneConfiguration[PaneConfiguration]Configuration of the pane to be created.-
PaneName- optional; [string]Optional name of the pane configuration. -
AudioOutputToken- optional; [ReferenceToken]If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client can retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service. -
AudioSourceToken- optional; [ReferenceToken]If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane. The audio connection from a decoder device to the NVT is established using the backchannel mechanism. A client can retrieve the available audio sources of a device using the GetAudioSources command of the DeviceIO service. -
AudioEncoderConfiguration- optional; [AudioEncoderConfiguration]The configuration of the audio encoder including codec, bitrate and sample rate.-
Name[Name]User readable name. Length up to 64 characters. -
UseCount[int]Number of internal references currently using this configuration.This informational parameter is read-only. Deprecated for Media2 Service.
-
Encoding[AudioEncoding]Audio codec used for encoding the audio input (either G.711, G.726 or AAC).Enum Value Enum Description G711— G726— AAC— -
Bitrate[int]The output bitrate in kbps. -
SampleRate[int]The output sample rate in kHz. -
Multicast[MulticastConfiguration]Defines the multicast settings that could be used for video streaming.-
Address[IPAddress]The multicast address (if this address is set to 0 no multicast streaming is enabled)-
Type[IPType]Indicates if the address is an IPv4 or IPv6 address.Enum Value Enum Description IPv4— IPv6— -
IPv4Address- optional; [IPv4Address]IPv4 address. -
IPv6Address- optional; [IPv6Address]IPv6 address
-
-
Port[int]The RTP multicast destination port. A device may support RTCP. In this case the port value shall be even to allow the corresponding RTCP stream to be mapped to the next higher (odd) destination port number as defined in the RTSP specification. -
TTL[int]In case of IPv6 the TTL value is assumed as the hop limit. Note that for IPV6 and administratively scoped IPv4 multicast the primary use for hop limit / TTL is to prevent packets from (endlessly) circulating and not limiting scope. In these cases the address contains the scope. -
AutoStart[boolean]Read only property signalling that streaming is persistent. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state.
-
-
SessionTimeout[duration]The rtsp session timeout for the related audio stream
-
-
ReceiverToken- optional; [ReferenceToken]A pointer to a Receiver that has the necessary information to receive data from a Transmitter. This Receiver can be connected and the network video decoder displays the received data on the specified outputs. A client can retrieve the available Receivers using the GetReceivers command of the Receiver Service. -
Token[ReferenceToken]A unique identifier in the display device.
-
Output
-
PaneToken[ReferenceToken]Token of the new pane configuration.
DeletePaneConfiguration
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.
Input
-
VideoOutput[ReferenceToken]Token of the video output where the pane shall be deleted. -
PaneToken[ReferenceToken]Token of the pane to be deleted.