Skip to content

DeviceIO

DeviceIO service implementation.

DeviceIO

Bases: ONVIFService

0.0.1 2.0

DeviceIO service client.

Property Details
First introduced ONVIF 2.0 (November 2010)
Binding name DeviceIOBinding (ver10/deviceio.wsdl)
Operations deviceio.wsdl
Spec DeviceIO

GetServiceCapabilities 

GetServiceCapabilities()

Returns the capabilities of the device IO service.

The result is returned in a typed answer.

Output
  • Capabilities [Capabilities]
    The capabilities for the device IO service is returned in the Capabilities element.
    • VideoSources - optional; [int]
      Number of video sources (defaults to none).
    • VideoOutputs - optional; [int]
      Number of video outputs (defaults to none).
    • AudioSources - optional; [int]
      Number of audio sources (defaults to none).
    • AudioOutputs - optional; [int]
      Number of audio outputs (defaults to none).
    • RelayOutputs - optional; [int]
      Number of relay outputs (defaults to none).
    • SerialPorts - optional; [int]
      Number of serial ports (defaults to none).
    • DigitalInputs - optional; [int]
      Number of digital inputs (defaults to none).
    • DigitalInputOptions - optional; [boolean]
      Indicates support for DigitalInput configuration of the idle state (defaults to false).

GetRelayOutputOptions 

GetRelayOutputOptions(RelayOutputToken=None)

Request the available settings and ranges for one or all relay outputs.

A device that has one or more RelayOutputs should support this command.

Two examples that illustrate usage:

1) Device supports range PT1S to PT120S:

<tmd:RelayOutputOptions token='44'>
  <tmd:Mode>Monostable</tmd:Mode>
  <tmd:DelayTimes>1 120</tmd:DelayTimes>
</tmd:RelayOutputOptions>

2) Device supports values PT0.5S, PT1S, PT2s and PT1M:

<tmd:RelayOutputOptions token='123'>
  <tmd:Mode>Monostable</tmd:Mode>
  <tmd:DelayTimes>0.5 1 2 60</tmd:DelayTimes>
  <tmd:Discrete>True</tmd:Discrete>
</tmd:RelayOutputOptions>
Input
  • RelayOutputToken - optional; [ReferenceToken]
    Optional reference token to the relay for which the options are requested.
    Maximum length: 64
Output
  • RelayOutputOptions - optional, unbounded; [RelayOutputOptions]
    Valid values and ranges for the configuration of a relay output.
    • token - required; [ReferenceToken]
      Token of the relay output.
    • Mode - unbounded; [RelayMode]
      Supported Modes.
      Enum Value Enum Description
      Monostable —
      Bistable —
    • DelayTimes - optional; [FloatList]
      Supported delay time range or discrete values in seconds. This element must be present if MonoStable mode is supported.
    • Discrete - optional; [boolean]
      True if the relay only supports the exact values for the DelayTimes listed. Default is false.
    • Extension - optional; [RelayOutputOptionsExtension]

GetAudioSources 

GetAudioSources()

List all available audio sources for the device.

The device that has one or more audio sources shall support the listing of available audio inputs through the GetAudioSources command.

Output
  • Token - optional, unbounded; [ReferenceToken]
    List tokens of a physical IO of a device.
    Maximum length: 64

GetAudioOutputs 

GetAudioOutputs()

List all available audio outputs of a device.

A device that has one or more physical audio outputs shall support listing of available audio outputs through the GetAudioOutputs command.

Output
  • Token - optional, unbounded; [ReferenceToken]
    List tokens of a physical IO of a device.
    Maximum length: 64

GetVideoSources 

GetVideoSources()

List all available video sources for the device.

The device that has one or more video inputs shall support the listing of available video sources through the GetVideoSources command.

Output
  • Token - optional, unbounded; [ReferenceToken]
    List tokens of a physical IO of a device.
    Maximum length: 64

GetVideoOutputs 

GetVideoOutputs()

List all available video outputs of a device.

A device that has one or more physical video outputs shall support listing of available video outputs through the GetVideoOutputs command.

Output
  • VideoOutputs - optional, unbounded; [VideoOutput]
    List containing all physical Video output connections of a device.
    • Layout [Layout]
      • PaneLayout - unbounded; [PaneLayout]
        List of panes assembling the display layout.
        • Pane [ReferenceToken]
          Reference to the configuration of the streaming and coding parameters.
          Maximum length: 64
        • 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]
    • Resolution - optional; [VideoResolution]
      Resolution of the display in Pixel.
      • 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.
    • RefreshRate - optional; [float]
      Refresh rate of the display in Hertz.
    • AspectRatio - optional; [float]
      Aspect ratio of the display as physical extent of width divided by height.
    • Extension - optional; [VideoOutputExtension]

GetVideoSourceConfiguration 

GetVideoSourceConfiguration(VideoSourceToken)

Get the video source configurations of a VideoSource.

A device with one or more video sources shall support the GetVideoSourceConfigurations command.

This method is deprecated.

Input
  • VideoSourceToken [ReferenceToken]
    Token of the requested VideoSource.
    Maximum length: 64
Output
  • VideoSourceConfiguration [VideoSourceConfiguration]
    Current configuration of the Video input.
    • ViewMode - optional; [string]
      Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes.
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • SourceToken [ReferenceToken]
      Reference to the physical input.
      Maximum length: 64
    • Bounds [IntRectangle]
      Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area.
      • x - required; [int]
      • y - required; [int]
      • width - required; [int]
      • height - required; [int]
    • Extension - optional; [VideoSourceConfigurationExtension]
      • Rotate - optional; [Rotate]
        Optional element to configure rotation of captured image. What resolutions a device supports shall be unaffected by the Rotate parameters.
        If a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
        The device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition: if Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection
        • Mirror - optional; [boolean]
          When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
          when Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction.
        • Mode [RotateMode]
          Parameter to enable/disable Rotation feature.
          Enum Value Enum Description
          OFF Enable the Rotate feature. Degree of rotation is specified Degree parameter.
          ON Disable the Rotate feature.
          AUTO Rotate feature is automatically activated by the device.
        • Degree - optional; [int]
          Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation.
        • Extension - optional; [RotateExtension]
      • Extension - optional; [VideoSourceConfigurationExtension2]
        • LensDescription - optional, unbounded; [LensDescription]
          Optional element describing the geometric lens distortion. Multiple instances for future variable lens support.
          • FocalLength - optional; [float]
            Optional focal length of the optical system.
          • Offset [LensOffset]
            Offset of the lens center to the imager center in normalized coordinates.
            • x - optional; [float]
              Optional horizontal offset of the lens center in normalized coordinates.
            • y - optional; [float]
              Optional vertical offset of the lens center in normalized coordinates.
          • Projection - unbounded; [LensProjection]
            Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation over the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius. Items outside the last projection Radius shall be assumed to be invisible (black).
            • Angle [float]
              Angle of incidence.
            • Radius [float]
              Mapping radius as a consequence of the emergent angle.
            • Transmittance - optional; [float]
              Optional ray absorption at the given angle due to vignetting. A value of one means no absorption.
          • XFactor [float]
            Compensation of the x coordinate needed for the ONVIF normalized coordinate system.
        • SceneOrientation - optional; [SceneOrientation]
          Optional element describing the scene orientation in the camera's field of view.
          • Mode [SceneOrientationMode]
            Parameter to assign the way the camera determines the scene orientation.
            Enum Value Enum Description
            MANUAL —
            AUTO —
          • Orientation - optional; [string]
            Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field is optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required and the device will return an InvalidArgs fault if missing.

GetVideoOutputConfiguration 

GetVideoOutputConfiguration(VideoOutputToken)

Get the configuration of a Video Output.

A device that has one or more Video Outputs shall support the retrieval of the VideoOutputConfiguration through this command.

Input
  • VideoOutputToken [ReferenceToken]
    Token of the requested VideoOutput.
    Maximum length: 64
Output
  • VideoOutputConfiguration [VideoOutputConfiguration]
    Current configuration of the Video output.
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • OutputToken [ReferenceToken]
      Token of the Video Output the configuration applies to
      Maximum length: 64

GetAudioSourceConfiguration 

GetAudioSourceConfiguration(AudioSourceToken)

List the configuration of an Audio Input.

A device with one or more audio inputs shall support the GetAudioSourceConfiguration command.

This method is deprecated.

Input
  • AudioSourceToken [ReferenceToken]
    Token of the requested AudioSource.
    Maximum length: 64
Output
  • AudioSourceConfiguration [AudioSourceConfiguration]
    Current configuration of the Audio input.
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • SourceToken [ReferenceToken]
      Token of the Audio Source the configuration applies to
      Maximum length: 64

GetAudioOutputConfiguration 

GetAudioOutputConfiguration(AudioOutputToken)

Request the current configuration of a physical Audio output.

A device that has one or more AudioOutputs shall support the retrieval of the AudioOutputConfiguration through this command.

This method is deprecated.

Input
  • AudioOutputToken [ReferenceToken]
    Token of the physical Audio output.
    Maximum length: 64
Output
  • AudioOutputConfiguration [AudioOutputConfiguration]
    Current configuration of the Audio output.
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • OutputToken [ReferenceToken]
      Token of the physical Audio output.
      Maximum length: 64
    • SendPrimacy - optional; [anyURI]
      An audio channel MAY support different types of audio transmission. While for full duplex operation no special handling is required, in half duplex operation the transmission direction needs to be switched. The optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which direction is currently active. An NVC can switch between different modes by setting the AudioOutputConfiguration.
      The following modes for the Send-Primacy are defined:
      • www.onvif.org/ver20/HalfDuplex/Server The server is allowed to send audio data to the client. The client shall not send audio data via the backchannel to the NVT in this mode.
      • www.onvif.org/ver20/HalfDuplex/Client The client is allowed to send audio data via the backchannel to the server. The NVT shall not send audio data to the client in this mode.
      • www.onvif.org/ver20/HalfDuplex/Auto It is up to the device how to deal with sending and receiving audio data.
      Acoustic echo cancellation is out of ONVIF scope.
    • OutputLevel [int]
      Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange.

SetVideoSourceConfiguration 

SetVideoSourceConfiguration(
    Configuration, ForcePersistence
)

Modify a video input configuration.

A device that has one or more video sources shall support the setting of the VideoSourceConfiguration through this command.

This method is deprecated.

Input
  • Configuration [VideoSourceConfiguration]
    • ViewMode - optional; [string]
      Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes.
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • SourceToken [ReferenceToken]
      Reference to the physical input.
      Maximum length: 64
    • Bounds [IntRectangle]
      Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area.
      • x - required; [int]
      • y - required; [int]
      • width - required; [int]
      • height - required; [int]
    • Extension - optional; [VideoSourceConfigurationExtension]
      • Rotate - optional; [Rotate]
        Optional element to configure rotation of captured image. What resolutions a device supports shall be unaffected by the Rotate parameters.
        If a device is configured with Rotate=AUTO, the device shall take control over the Degree parameter and automatically update it so that a client can query current rotation.
        The device shall automatically apply the same rotation to its pan/tilt control direction depending on the following condition: if Reverse=AUTO in PTControlDirection or if the device doesn't support Reverse in PTControlDirection
        • Mirror - optional; [boolean]
          When enabled, the video will be flipped horizontally. If applied alongside rotation, the mirror effect shall be executed after the rotation. Additionally,
          when Mirror is enabled and Reverse=Auto is set in PTControlDirection or if the device doesn't support Reverse in PTControlDirection, the device shall automatically adjust the pan direction.
        • Mode [RotateMode]
          Parameter to enable/disable Rotation feature.
          Enum Value Enum Description
          OFF Enable the Rotate feature. Degree of rotation is specified Degree parameter.
          ON Disable the Rotate feature.
          AUTO Rotate feature is automatically activated by the device.
        • Degree - optional; [int]
          Optional parameter to configure how much degree of clockwise rotation of image for On mode. Omitting this parameter for On mode means 180 degree rotation.
        • Extension - optional; [RotateExtension]
      • Extension - optional; [VideoSourceConfigurationExtension2]
        • LensDescription - optional, unbounded; [LensDescription]
          Optional element describing the geometric lens distortion. Multiple instances for future variable lens support.
          • FocalLength - optional; [float]
            Optional focal length of the optical system.
          • Offset [LensOffset]
            Offset of the lens center to the imager center in normalized coordinates.
            • x - optional; [float]
              Optional horizontal offset of the lens center in normalized coordinates.
            • y - optional; [float]
              Optional vertical offset of the lens center in normalized coordinates.
          • Projection - unbounded; [LensProjection]
            Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation over the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius. Items outside the last projection Radius shall be assumed to be invisible (black).
            • Angle [float]
              Angle of incidence.
            • Radius [float]
              Mapping radius as a consequence of the emergent angle.
            • Transmittance - optional; [float]
              Optional ray absorption at the given angle due to vignetting. A value of one means no absorption.
          • XFactor [float]
            Compensation of the x coordinate needed for the ONVIF normalized coordinate system.
        • SceneOrientation - optional; [SceneOrientation]
          Optional element describing the scene orientation in the camera's field of view.
          • Mode [SceneOrientationMode]
            Parameter to assign the way the camera determines the scene orientation.
            Enum Value Enum Description
            MANUAL —
            AUTO —
          • Orientation - optional; [string]
            Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field is optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required and the device will return an InvalidArgs fault if missing.
  • ForcePersistence [boolean]
    The ForcePersistence element determines how configuration changes shall be stored. If true, changes shall be persistent. If false, changes MAY revert to previous values after reboot.

SetVideoOutputConfiguration 

SetVideoOutputConfiguration(
    Configuration, ForcePersistence
)

Modify a video output configuration.

A device that has one or more video outputs shall support the setting of its video output configuration through this command.

Input
  • Configuration [VideoOutputConfiguration]
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • OutputToken [ReferenceToken]
      Token of the Video Output the configuration applies to
      Maximum length: 64
  • ForcePersistence [boolean]
    The ForcePersistence element determines how configuration changes shall be stored. If true, changes shall be persistent. If false, changes MAY revert to previous values after reboot.

SetAudioSourceConfiguration 

SetAudioSourceConfiguration(
    Configuration, ForcePersistence
)

Modify an audio source configuration.

A device that has a one or more audio sources shall support the setting of the AudioSourceConfiguration through this command.

This method is deprecated.

Input
  • Configuration [AudioSourceConfiguration]
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • SourceToken [ReferenceToken]
      Token of the Audio Source the configuration applies to
      Maximum length: 64
  • ForcePersistence [boolean]
    The ForcePersistence element determines how configuration changes shall be stored. If true, changes shall be persistent. If false, changes MAY revert to previous values after reboot.

SetAudioOutputConfiguration 

SetAudioOutputConfiguration(
    Configuration, ForcePersistence
)

Modify an audio output configuration.

A device that has one or more audio outputs shall support the setting of the AudioOutputConfiguration through this command.

This method is deprecated.

Input
  • Configuration [AudioOutputConfiguration]
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • OutputToken [ReferenceToken]
      Token of the physical Audio output.
      Maximum length: 64
    • SendPrimacy - optional; [anyURI]
      An audio channel MAY support different types of audio transmission. While for full duplex operation no special handling is required, in half duplex operation the transmission direction needs to be switched. The optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which direction is currently active. An NVC can switch between different modes by setting the AudioOutputConfiguration.
      The following modes for the Send-Primacy are defined:
      • www.onvif.org/ver20/HalfDuplex/Server The server is allowed to send audio data to the client. The client shall not send audio data via the backchannel to the NVT in this mode.
      • www.onvif.org/ver20/HalfDuplex/Client The client is allowed to send audio data via the backchannel to the server. The NVT shall not send audio data to the client in this mode.
      • www.onvif.org/ver20/HalfDuplex/Auto It is up to the device how to deal with sending and receiving audio data.
      Acoustic echo cancellation is out of ONVIF scope.
    • OutputLevel [int]
      Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange.
  • ForcePersistence [boolean]
    The ForcePersistence element determines how configuration changes shall be stored. If true, changes shall be persistent. If false, changes MAY revert to previous values after reboot.

GetVideoSourceConfigurationOptions 

GetVideoSourceConfigurationOptions(VideoSourceToken)

Request the VideoSourceConfigurationOptions of a VideoSource.

A device with one or more video sources shall support this command.

This method is deprecated.

Input
  • VideoSourceToken [ReferenceToken]
    Token of the Video input whose options are requested..
    Maximum length: 64
Output
  • VideoSourceConfigurationOptions [VideoSourceConfigurationOptions]
    • MaximumNumberOfProfiles - optional; [int]
      Maximum number of profiles.
    • BoundsRange [IntRectangleRange]
      Supported range for the capturing area. Device that does not support cropped streaming shall express BoundsRange option as mentioned below BoundsRange->XRange and BoundsRange->YRange with same Min/Max values HeightRange and WidthRange Min/Max values same as VideoSource Height and Width Limits.
      • XRange [IntRange]
        Range of X-axis.
        • Min [int]
        • Max [int]
      • YRange [IntRange]
        Range of Y-axis.
        • Min [int]
        • Max [int]
      • WidthRange [IntRange]
        Range of width.
        • Min [int]
        • Max [int]
      • HeightRange [IntRange]
        Range of height.
        • Min [int]
        • Max [int]
    • VideoSourceTokensAvailable - unbounded; [ReferenceToken]
      List of physical inputs.
      Maximum length: 64
    • Extension - optional; [VideoSourceConfigurationOptionsExtension]
      • Rotate - optional; [RotateOptions]
        Options of parameters for Rotation feature.
        • Reboot - optional; [boolean]
          Signals if a device requires a reboot after changing the rotation or mirror. If a device can handle rotation changes or mirror changes without rebooting this value shall be set to false.
        • Mirror - optional; [boolean]
          Signals if video source mirroring is supported.
        • Mode - unbounded; [RotateMode]
          Supported options of Rotate mode parameter.
          Enum Value Enum Description
          OFF Enable the Rotate feature. Degree of rotation is specified Degree parameter.
          ON Disable the Rotate feature.
          AUTO Rotate feature is automatically activated by the device.
        • DegreeList - optional; [IntItems]
          List of supported degree value for rotation.
          • Items - optional, unbounded; [int]
        • Extension - optional; [RotateOptionsExtension]
      • Extension - optional; [VideoSourceConfigurationOptionsExtension2]
        • SceneOrientationMode - optional, unbounded; [SceneOrientationMode]
          Scene orientation modes supported by the device for this configuration.
          Enum Value Enum Description
          MANUAL —
          AUTO —

GetVideoOutputConfigurationOptions 

GetVideoOutputConfigurationOptions(VideoOutputToken)

Request the VideoOutputConfigurationOptions of a VideoOutput.

A device that has one or more video outputs shall support the retrieval of VideoOutputConfigurationOptions through this command.

Input
  • VideoOutputToken [ReferenceToken]
    Token of the Video Output whose options are requested..
    Maximum length: 64
Output
  • VideoOutputConfigurationOptions [VideoOutputConfigurationOptions]

GetAudioSourceConfigurationOptions 

GetAudioSourceConfigurationOptions(AudioSourceToken)

Request the AudioSourceConfigurationOptions of an AudioSource.

A device with one or more AudioSources shall support this command.

This method is deprecated.

Input
  • AudioSourceToken [ReferenceToken]
    Token of the physical Audio input whose options are requested..
    Maximum length: 64
Output
  • AudioSourceOptions [AudioSourceConfigurationOptions]
    Returns the AudioSourceToken available.
    • InputTokensAvailable - unbounded; [ReferenceToken]
      Tokens of the audio source the configuration can be used for.
      Maximum length: 64
    • Extension - optional; [AudioSourceOptionsExtension]

GetAudioOutputConfigurationOptions 

GetAudioOutputConfigurationOptions(AudioOutputToken)

Request the available settings and ranges for a physical Audio output.

A device that has one or more AudioOutputs shall support this command.

This method is deprecated.

Input
  • AudioOutputToken [ReferenceToken]
    Token of the physical Audio Output whose options are requested..
    Maximum length: 64
Output
  • AudioOutputOptions [AudioOutputConfigurationOptions]
    Available settings and ranges for the requested Audio output.
    • OutputTokensAvailable - unbounded; [ReferenceToken]
      Tokens of the physical Audio outputs (typically one).
      Maximum length: 64
    • SendPrimacyOptions - optional, unbounded; [anyURI]
      An audio channel MAY support different types of audio transmission. While for full duplex operation no special handling is required, in half duplex operation the transmission direction needs to be switched. The optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which direction is currently active. An NVC can switch between different modes by setting the AudioOutputConfiguration.
      The following modes for the Send-Primacy are defined:
      • www.onvif.org/ver20/HalfDuplex/Server The server is allowed to send audio data to the client. The client shall not send audio data via the backchannel to the NVT in this mode.
      • www.onvif.org/ver20/HalfDuplex/Client The client is allowed to send audio data via the backchannel to the server. The NVT shall not send audio data to the client in this mode.
      • www.onvif.org/ver20/HalfDuplex/Auto It is up to the device how to deal with sending and receiving audio data.
      Acoustic echo cancellation is out of ONVIF scope.
    • OutputLevelRange [IntRange]
      Minimum and maximum level range supported for this Output.
      • Min [int]
      • Max [int]
    • EQPresetScheduleSupport - optional; [boolean]
      Indicates whether EQPreset scheduling is supported.
    • EQPresets - optional, unbounded; [EQPreset]
      List of supported EQPresets.
      • Token [ReferenceToken]
        Unique identifier for the preset.
        Maximum length: 64
      • Name [string]
        Preset name. (Readonly)
      • isDefault [boolean]
        This indicates whether the EQ preset is designated as the default. When the scheduler is inactive, this preset will be applied. Only one preset can be set as the default among the EQ presets linked to an audio output. If all presets have isDefault set to false, the device may automatically select one preset as the default.
      • ScheduleToken - optional; [string]
        Optional schedule token (if supported).
      • isFrequencyDecibelEditable [boolean]
        Indicates whether the device allows changing the decibel level for frequencies. (Readonly)
      • FrequencyDecibelPair - optional, unbounded; [FrequencyDecibelPair]
        List of frequency decibel pairs, each defined by a center frequency and its corresponding decibel value.
        • CenterFrequency [int]
          The center frequency of the band in hertz (Readonly). For example, value of 1000 refers to 1kHz and 2000 refers to 2kHz.
        • Decibel [float]
          Decibel value associated with the center frequency.

GetRelayOutputs 

GetRelayOutputs()

This operation gets a list of all available relay outputs and their settings.

Output
  • RelayOutputs - optional, unbounded; [RelayOutput]
    • Properties [RelayOutputSettings]
      • Mode [RelayMode]
        'Bistable' or 'Monostable'
        • Bistable - After setting the state, the relay remains in this state.
        • Monostable - After setting the state, the relay returns to its idle state after the specified time.
        Enum Value Enum Description
        Monostable —
        Bistable —
      • DelayTime [duration]
        Time after which the relay returns to its idle state if it is in monostable mode. If the Mode field is set to bistable mode the value of the parameter can be ignored.
      • IdleState [RelayIdleState]
        'open' or 'closed'
        • 'open' means that the relay is open when the relay state is set to 'inactive' through the trigger command and closed when the state is set to 'active' through the same command.
        • 'closed' means that the relay is closed when the relay state is set to 'inactive' through the trigger command and open when the state is set to 'active' through the same command.
        Enum Value Enum Description
        closed —
        open —

SetRelayOutputSettings 

SetRelayOutputSettings(
    RelayOutput, RelayOutputToken, Properties
)

This operation sets the settings of a relay output.

The relay can work in two relay modes:

  • Bistable - After setting the state, the relay remains in this state.
  • Monostable - After setting the state, the relay returns to its idle state after the specified time. The physical idle state of a relay output can be configured by setting the IdleState to 'open' or 'closed' (inversion of the relay behaviour).

Idle State 'open' means that the relay is open when the relay state is set to 'inactive' through the trigger command (see Section 8.5.3) and closed when the state is set to 'active' through the same command.

Idle State 'closed' means, that the relay is closed when the relay state is set to 'inactive' through the trigger command (see Section 8.5.3) and open when the state is set to 'active' through the same command.

Input
  • RelayOutput [RelayOutput]
    • Properties [RelayOutputSettings]
      • Mode [RelayMode]
        'Bistable' or 'Monostable'
        • Bistable - After setting the state, the relay remains in this state.
        • Monostable - After setting the state, the relay returns to its idle state after the specified time.
        Enum Value Enum Description
        Monostable —
        Bistable —
      • DelayTime [duration]
        Time after which the relay returns to its idle state if it is in monostable mode. If the Mode field is set to bistable mode the value of the parameter can be ignored.
      • IdleState [RelayIdleState]
        'open' or 'closed'
        • 'open' means that the relay is open when the relay state is set to 'inactive' through the trigger command and closed when the state is set to 'active' through the same command.
        • 'closed' means that the relay is closed when the relay state is set to 'inactive' through the trigger command and open when the state is set to 'active' through the same command.
        Enum Value Enum Description
        closed —
        open —

SetRelayOutputState 

SetRelayOutputState(RelayOutputToken, LogicalState)

Modify the relay state.

Input
  • RelayOutputToken [ReferenceToken]
    Maximum length: 64
  • LogicalState [RelayLogicalState]
    Enum Value Enum Description
    active —
    inactive —

GetDigitalInputs 

GetDigitalInputs()

This operation gets a list of all available digital inputs.

Output

Requested digital inputs.

  • DigitalInputs - optional, unbounded; [DigitalInput]
    • IdleState - optional; [DigitalIdleState]
      Indicate the Digital IdleState status.

GetDigitalInputConfigurationOptions 

GetDigitalInputConfigurationOptions(Token=None)

This operation lists what configuration is available for digital inputs.

Input
  • Token - optional; [ReferenceToken]
    Maximum length: 64
Output
  • DigitalInputOptions [DigitalInputConfigurationOptions]
    • IdleState - unbounded; [DigitalIdleState]
      Configuration Options for a digital input.
      Enum Value Enum Description
      closed —
      open —

SetDigitalInputConfigurations 

SetDigitalInputConfigurations(DigitalInputs)

Modify a digital input configuration.

Input
  • DigitalInputs - unbounded; [DigitalInput]
    • IdleState - optional; [DigitalIdleState]
      Indicate the Digital IdleState status.

GetSerialPorts 

GetSerialPorts()

This operation gets a list of all available serial ports.

Output

Requested serial ports.

  • SerialPort - optional, unbounded; [SerialPort]

GetSerialPortConfiguration 

GetSerialPortConfiguration(SerialPortToken)

This operation gets the configuration of a serial port.

Input

Gets the configuration that relates to serial port configuration.

  • SerialPortToken [ReferenceToken]
    Maximum length: 64
Output

Requested serial port configuration.

  • SerialPortConfiguration [SerialPortConfiguration]
    • token - required; [ReferenceToken]
    • type - required; [SerialPortType]
    • BaudRate [int]
      The transfer bitrate.
    • ParityBit [ParityBit]
      The parity for the data error detection.
      Enum Value Enum Description
      None —
      Even —
      Odd —
      Mark —
      Space —
      Extended —
    • CharacterLength [int]
      The bit length for each character.
    • StopBit [float]
      The number of stop bits used to terminate each character.

SetSerialPortConfiguration 

SetSerialPortConfiguration(
    SerialPortConfiguration, ForcePersistance
)

Modify a serial port configuration.

Input

Sets the configuration that relates to serial port configuration.

  • SerialPortConfiguration [SerialPortConfiguration]
    • token - required; [ReferenceToken]
    • type - required; [SerialPortType]
    • BaudRate [int]
      The transfer bitrate.
    • ParityBit [ParityBit]
      The parity for the data error detection.
      Enum Value Enum Description
      None —
      Even —
      Odd —
      Mark —
      Space —
      Extended —
    • CharacterLength [int]
      The bit length for each character.
    • StopBit [float]
      The number of stop bits used to terminate each character.
  • ForcePersistance [boolean]

GetSerialPortConfigurationOptions 

GetSerialPortConfigurationOptions(SerialPortToken)

This operation lists what configuration is available for serial ports.

Input

Gets the configuration options that relates to serial port configuration.

  • SerialPortToken [ReferenceToken]
    Maximum length: 64
Output

Requested serial port configuration options.

  • SerialPortOptions [SerialPortConfigurationOptions]
    • token - required; [ReferenceToken]
    • BaudRateList [IntItems]
      The list of configurable transfer bitrate.
      • Items - optional, unbounded; [int]
    • ParityBitList [ParityBitList]
      The list of configurable parity for the data error detection.
      • Items - optional, unbounded; [ParityBit]
        Enum Value Enum Description
        None —
        Even —
        Odd —
        Mark —
        Space —
        Extended —
    • CharacterLengthList [IntItems]
      The list of configurable bit length for each character.
      • Items - optional, unbounded; [int]
    • StopBitList [FloatItems]
      The list of configurable number of stop bits used to terminate each character.
      • Items - optional, unbounded; [float]

SendReceiveSerialCommand 

SendReceiveSerialCommand(
    Token=None,
    SerialData=None,
    TimeOut=None,
    DataLength=None,
    Delimiter=None,
)

This operation transmitting arbitrary data to the connected serial device and then receiving its response data.

Input

Transmitting arbitrary data to the connected serial device and then receiving its response data.

  • Token - optional; [ReferenceToken]
    The physical serial port reference to be used when this request is invoked.
    Maximum length: 64
  • SerialData - optional; [SerialData]
    The serial port data.
    • Binary [base64Binary]
    • String [string]
  • TimeOut - optional; [duration]
    Indicates that the command should be responded back within the specified period of time.
  • DataLength - optional; [integer]
    This element may be put in the case that data length returned from the connected serial device is already determined as some fixed bytes length. It indicates the length of received data which can be regarded as available.
  • Delimiter - optional; [string]
    This element may be put in the case that the delimiter codes returned from the connected serial device is already known. It indicates the termination data sequence of the responded data. In case the string has more than one character a device shall interpret the whole string as a single delimiter. Furthermore a device shall return the delimiter character(s) to the client.
Output

Receiving the response data.

  • SerialData - optional; [SerialData]
    • Binary [base64Binary]
    • String [string]