Skip to content

Media

Media service implementation.

Media

Bases: ONVIFService

0.0.1 1.0 open_stream.py

Media service client.

Property Details
First introduced ONVIF 1.0 (November 2008)
Binding name MediaBinding (ver10/media/wsdl/media.wsdl)
Operations media.wsdl
Spec Media
Data Format Streaming

GetServiceCapabilities 

GetServiceCapabilities()

Returns the capabilities of the media service.

The result is returned in a typed answer.

Output
  • Capabilities [Capabilities]
    The capabilities for the media service is returned in the Capabilities element.
    • SnapshotUri - optional; [boolean]
      Indicates if GetSnapshotUri is supported.
    • Rotation - optional; [boolean]
      Indicates whether or not Rotation feature is supported.
    • VideoSourceMode - optional; [boolean]
      Indicates the support for changing video source mode.
    • OSD - optional; [boolean]
      Indicates if OSD is supported.
    • TemporaryOSDText - optional; [boolean]
      Indicates the support for temporary osd text configuration.
    • EXICompression - optional; [boolean]
      Indicates the support for the Efficient XML Interchange (EXI) binary XML format.
    • ProfileCapabilities [ProfileCapabilities]
      Media profile capabilities.
      • MaximumNumberOfProfiles - optional; [int]
        Maximum number of profiles supported.
    • StreamingCapabilities [StreamingCapabilities]
      Streaming capabilities.
      • RTPMulticast - optional; [boolean]
        Indicates support for RTP multicast.
      • RTP_TCP - optional; [boolean]
        Indicates support for RTP over TCP.
      • RTP_RTSP_TCP - optional; [boolean]
        Indicates support for RTP/RTSP/TCP.
      • NonAggregateControl - optional; [boolean]
        Indicates support for non aggregate RTSP control.
      • NoRTSPStreaming - optional; [boolean]
        Indicates the device does not support live media streaming via RTSP.

GetVideoSources 

GetVideoSources()

This command lists all available physical video inputs of the device.

Output
  • VideoSources - optional, unbounded; [VideoSource]
    List of existing Video Sources
    • Framerate [float]
      Frame rate in frames per second.
    • Resolution [VideoResolution]
      Horizontal and vertical resolution
      • 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.
    • Imaging - optional; [ImagingSettings]
      Optional configuration of the image sensor.
      • BacklightCompensation - optional; [BacklightCompensation]
        Enabled/disabled BLC mode (on/off).
        • Mode [BacklightCompensationMode]
          Backlight compensation mode (on/off).
          Enum Value Enum Description
          OFF Backlight compensation is disabled.
          ON Backlight compensation is enabled.
        • Level [float]
          Optional level parameter (unit unspecified).
      • Brightness - optional; [float]
        Image brightness (unit unspecified).
      • ColorSaturation - optional; [float]
        Color saturation of the image (unit unspecified).
      • Contrast - optional; [float]
        Contrast of the image (unit unspecified).
      • Exposure - optional; [Exposure]
        Exposure mode of the device.
        • Mode [ExposureMode]
          Exposure Mode
          • Auto - Enabled the exposure algorithm on the NVT.
          • Manual - Disabled exposure algorithm on the NVT.
          Enum Value Enum Description
          AUTO —
          MANUAL —
        • Priority [ExposurePriority]
          The exposure priority mode (low noise/framerate).
          Enum Value Enum Description
          LowNoise —
          FrameRate —
        • Window [Rectangle]
          Rectangular exposure mask.
          • bottom - required; [float]
          • top - required; [float]
          • right - required; [float]
          • left - required; [float]
        • MinExposureTime [float]
          Minimum value of exposure time range allowed to be used by the algorithm.
        • MaxExposureTime [float]
          Maximum value of exposure time range allowed to be used by the algorithm.
        • MinGain [float]
          Minimum value of the sensor gain range that is allowed to be used by the algorithm.
        • MaxGain [float]
          Maximum value of the sensor gain range that is allowed to be used by the algorithm.
        • MinIris [float]
          Minimum value of the iris range allowed to be used by the algorithm.
        • MaxIris [float]
          Maximum value of the iris range allowed to be used by the algorithm.
        • ExposureTime [float]
          The fixed exposure time used by the image sensor (μs).
        • Gain [float]
          The fixed gain used by the image sensor (dB).
        • Iris [float]
          The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris.
      • Focus - optional; [FocusConfiguration]
        Focus configuration.
        • AutoFocusMode [AutoFocusMode]
          Enum Value Enum Description
          AUTO —
          MANUAL —
        • DefaultSpeed [float]
        • NearLimit [float]
          Parameter to set autofocus near limit (unit: meter).
        • FarLimit [float]
          Parameter to set autofocus far limit (unit: meter). If set to 0.0, infinity will be used.
      • IrCutFilter - optional; [IrCutFilterMode]
        Infrared Cutoff Filter settings.
        Enum Value Enum Description
        ON —
        OFF —
        AUTO —
      • Sharpness - optional; [float]
        Sharpness of the Video image.
      • WideDynamicRange - optional; [WideDynamicRange]
        WDR settings.
        • Mode [WideDynamicMode]
          White dynamic range (on/off)
          Enum Value Enum Description
          OFF —
          ON —
        • Level [float]
          Optional level parameter (unitless)
      • WhiteBalance - optional; [WhiteBalance]
        White balance settings.
        • Mode [WhiteBalanceMode]
          Auto whitebalancing mode (auto/manual).
          Enum Value Enum Description
          AUTO —
          MANUAL —
        • CrGain [float]
          Rgain (unitless).
        • CbGain [float]
          Bgain (unitless).
      • Extension - optional; [ImagingSettingsExtension]
    • Extension - optional; [VideoSourceExtension]
      • Imaging - optional; [ImagingSettings20]
        Optional configuration of the image sensor. To be used if imaging service 2.00 is supported.
        • BacklightCompensation - optional; [BacklightCompensation20]
          Enabled/disabled BLC mode (on/off).
          • Mode [BacklightCompensationMode]
            Backlight compensation mode (on/off).
            Enum Value Enum Description
            OFF Backlight compensation is disabled.
            ON Backlight compensation is enabled.
          • Level - optional; [float]
            Optional level parameter (unit unspecified).
        • Brightness - optional; [float]
          Image brightness (unit unspecified).
        • ColorSaturation - optional; [float]
          Color saturation of the image (unit unspecified).
        • Contrast - optional; [float]
          Contrast of the image (unit unspecified).
        • Exposure - optional; [Exposure20]
          Exposure mode of the device.
          • Mode [ExposureMode]
            Exposure Mode
            • Auto - Enabled the exposure algorithm on the device.
            • Manual - Disabled exposure algorithm on the device.
            Enum Value Enum Description
            AUTO —
            MANUAL —
          • Priority - optional; [ExposurePriority]
            The exposure priority mode (low noise/framerate).
            Enum Value Enum Description
            LowNoise —
            FrameRate —
          • Window - optional; [Rectangle]
            Rectangular exposure mask.
            • bottom - required; [float]
            • top - required; [float]
            • right - required; [float]
            • left - required; [float]
          • MinExposureTime - optional; [float]
            Minimum value of exposure time range allowed to be used by the algorithm.
          • MaxExposureTime - optional; [float]
            Maximum value of exposure time range allowed to be used by the algorithm.
          • MinGain - optional; [float]
            Minimum value of the sensor gain range that is allowed to be used by the algorithm.
          • MaxGain - optional; [float]
            Maximum value of the sensor gain range that is allowed to be used by the algorithm.
          • MinIris - optional; [float]
            Minimum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation.
          • MaxIris - optional; [float]
            Maximum value of the iris range allowed to be used by the algorithm. 0dB maps to a fully opened iris and positive values map to higher attenuation.
          • ExposureTime - optional; [float]
            The fixed exposure time used by the image sensor (μs).
          • Gain - optional; [float]
            The fixed gain used by the image sensor (dB).
          • Iris - optional; [float]
            The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris and positive values map to higher attenuation.
        • Focus - optional; [FocusConfiguration20]
          Focus configuration.
          • AFMode - optional; [StringAttrList]
            Zero or more modes as defined in enumeration tt:AFModes.
          • AutoFocusMode [AutoFocusMode]
            Mode of auto focus.
            • AUTO - The device automatically adjusts focus.
            • MANUAL - The device does not automatically adjust focus.
            Note: for devices supporting both manual and auto operation at the same time manual operation may be supported even if the Mode parameter is set to Auto.
            Enum Value Enum Description
            AUTO —
            MANUAL —
          • DefaultSpeed - optional; [float]
          • NearLimit - optional; [float]
            Parameter to set autofocus near limit (unit: meter).
          • FarLimit - optional; [float]
            Parameter to set autofocus far limit (unit: meter).
          • Extension - optional; [FocusConfiguration20Extension]
        • IrCutFilter - optional; [IrCutFilterMode]
          Infrared Cutoff Filter settings.
          Enum Value Enum Description
          ON —
          OFF —
          AUTO —
        • Sharpness - optional; [float]
          Sharpness of the Video image.
        • WideDynamicRange - optional; [WideDynamicRange20]
          WDR settings.
          • Mode [WideDynamicMode]
            Wide dynamic range mode (on/off).
            Enum Value Enum Description
            OFF —
            ON —
          • Level - optional; [float]
            Optional level parameter (unit unspecified).
        • WhiteBalance - optional; [WhiteBalance20]
          White balance settings.
          • Mode [WhiteBalanceMode]
            'AUTO' or 'MANUAL'
            Enum Value Enum Description
            AUTO —
            MANUAL —
          • CrGain - optional; [float]
            Rgain (unitless).
          • CbGain - optional; [float]
            Bgain (unitless).
          • Extension - optional; [WhiteBalance20Extension]
        • Extension - optional; [ImagingSettingsExtension20]
          • ImageStabilization - optional; [ImageStabilization]
            Optional element to configure Image Stabilization feature.
            • Mode [ImageStabilizationMode]
              Parameter to enable/disable Image Stabilization feature.
              Enum Value Enum Description
              OFF —
              ON —
              AUTO —
              Extended —
            • Level - optional; [float]
              Optional level parameter (unit unspecified)
            • Extension - optional; [ImageStabilizationExtension]
          • Extension - optional; [ImagingSettingsExtension202]
            • IrCutFilterAutoAdjustment - optional, unbounded; [IrCutFilterAutoAdjustment]
              An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter.
              • BoundaryType [string]
                Specifies which boundaries to automatically toggle Ir cut filter following parameters are applied to. Its options shall be chosen from tt:IrCutFilterAutoBoundaryType.
              • BoundaryOffset - optional; [float]
                Adjusts boundary exposure level for toggling Ir cut filter to on/off specified with unitless normalized value from +1.0 to -1.0. Zero is default and -1.0 is the darkest adjustment (Unitless).
              • ResponseTime - optional; [duration]
                Delay time of toggling Ir cut filter to on/off after crossing of the boundary exposure levels.
              • Extension - optional; [IrCutFilterAutoAdjustmentExtension]
            • Extension - optional; [ImagingSettingsExtension203]
              • ToneCompensation - optional; [ToneCompensation]
                Optional element to configure Image Contrast Compensation.
                • Mode [string]
                  Parameter to enable/disable or automatic ToneCompensation feature. Its options shall be chosen from tt:ToneCompensationMode Type.
                • Level - optional; [float]
                  Optional level parameter specified with unitless normalized value from 0.0 to +1.0.
                • Extension - optional; [ToneCompensationExtension]
              • Defogging - optional; [Defogging]
                Optional element to configure Image Defogging.
                • Mode [string]
                  Parameter to enable/disable or automatic Defogging feature. Its options shall be chosen from tt:DefoggingMode Type.
                • Level - optional; [float]
                  Optional level parameter specified with unitless normalized value from 0.0 to +1.0.
                • Extension - optional; [DefoggingExtension]
              • NoiseReduction - optional; [NoiseReduction]
                Optional element to configure Image Noise Reduction.
                • Level [float]
                  Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction.
              • Extension - optional; [ImagingSettingsExtension204]
      • Extension - optional; [VideoSourceExtension2]

GetAudioSources 

GetAudioSources()

This command lists all available physical audio inputs of the device.

Output
  • AudioSources - optional, unbounded; [AudioSource]
    List of existing Audio Sources
    • Channels [int]
      number of available audio channels. (1: mono, 2: stereo)

GetAudioOutputs 

GetAudioOutputs()

This command lists all available physical audio outputs of the device.

Output
  • AudioOutputs - optional, unbounded; [AudioOutput]
    List of existing Audio Outputs

CreateProfile 

CreateProfile(Name, Token=None)

This operation creates a new empty media profile.

The media profile shall be created in the device and shall be persistent (remain after reboot). A created profile shall be deletable and a device shall set the "fixed" attribute to false in the returned Profile.

Input
  • Name [Name]
    friendly name of the profile to be created
    Maximum length: 64
  • Token - optional; [ReferenceToken]
    Optional token, specifying the unique identifier of the new profile.
    A device supports at least a token length of 12 characters and characters "A-Z" | "a-z" | "0-9" | "-.".
    Maximum length: 64
Output
  • Profile [Profile]
    returns the new created profile
    • token - required; [ReferenceToken]
      Unique identifier of the profile.
    • fixed - optional; [boolean]
      A value of true signals that the profile cannot be deleted. Default is false.
    • Name [Name]
      User readable name of the profile.
      Maximum length: 64
    • VideoSourceConfiguration - optional; [VideoSourceConfiguration]
      Optional 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.
    • AudioSourceConfiguration - optional; [AudioSourceConfiguration]
      Optional 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
    • VideoEncoderConfiguration - optional; [VideoEncoderConfiguration]
      Optional configuration of the Video encoder.
      • GuaranteedFrameRate - optional; [boolean]
        A value of true indicates that frame rate is a fixed value rather than an upper limit, and that the video encoder shall prioritize frame rate over all other adaptable configuration values such as bitrate. Default is false.
      • 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.

      • Encoding [VideoEncoding]
        Used video codec, either Jpeg, H.264 or Mpeg4
        Enum Value Enum Description
        JPEG —
        MPEG4 —
        H264 —
      • Resolution [VideoResolution]
        Configured video resolution
        • 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.
      • Quality [float]
        Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality
      • RateControl - optional; [VideoRateControl]
        Optional element to configure rate control related parameters.
        • FrameRateLimit [int]
          Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor.
        • EncodingInterval [int]
          Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)
        • BitrateLimit [int]
          The maximum output bitrate in kbps.
      • MPEG4 - optional; [Mpeg4Configuration]
        Optional element to configure Mpeg4 related parameters.
        • GovLength [int]
          Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
        • Mpeg4Profile [Mpeg4Profile]
          the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)
          Enum Value Enum Description
          SP —
          ASP —
      • H264 - optional; [H264Configuration]
        Optional element to configure H.264 related parameters.
        • GovLength [int]
          Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
        • H264Profile [H264Profile]
          the H.264 profile, either baseline, main, extended or high
          Enum Value Enum Description
          Baseline —
          Main —
          Extended —
          High —
      • 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 video stream
    • AudioEncoderConfiguration - optional; [AudioEncoderConfiguration]
      Optional configuration of the Audio encoder.
      • 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.

      • 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
    • VideoAnalyticsConfiguration - optional; [VideoAnalyticsConfiguration]
      Optional configuration of the video analytics module and rule engine.
      • 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.

      • AnalyticsEngineConfiguration [AnalyticsEngineConfiguration]
        • AnalyticsModule - optional, unbounded; [Config]
          • Name - required; [string]
            Name of the configuration.
          • Type - required; [QName]
            The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
          • Parameters [ItemList]
            List of configuration parameters as defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • SimpleItem - optional, unbounded; [complexType]
              Value name pair as defined by the corresponding description.
              • Name - required; [string]
                Item name.
              • Value - required; [anySimpleType]
                Item value. The type is defined in the corresponding description.
            • ElementItem - optional, unbounded; [complexType]
              Complex value structure.
              • Name - required; [string]
                Item name.
            • Extension - optional; [ItemListExtension]
        • Extension - optional; [AnalyticsEngineConfigurationExtension]
      • RuleEngineConfiguration [RuleEngineConfiguration]
        • Rule - optional, unbounded; [Config]
          • Name - required; [string]
            Name of the configuration.
          • Type - required; [QName]
            The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
          • Parameters [ItemList]
            List of configuration parameters as defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • SimpleItem - optional, unbounded; [complexType]
              Value name pair as defined by the corresponding description.
              • Name - required; [string]
                Item name.
              • Value - required; [anySimpleType]
                Item value. The type is defined in the corresponding description.
            • ElementItem - optional, unbounded; [complexType]
              Complex value structure.
              • Name - required; [string]
                Item name.
            • Extension - optional; [ItemListExtension]
        • Extension - optional; [RuleEngineConfigurationExtension]
    • PTZConfiguration - optional; [PTZConfiguration]
      Optional configuration of the pan tilt zoom unit.
      • MoveRamp - optional; [int]
        The optional acceleration ramp used by the device when moving.
      • PresetRamp - optional; [int]
        The optional acceleration ramp used by the device when recalling presets.
      • PresetTourRamp - optional; [int]
        The optional acceleration ramp used by the device when executing PresetTours.
      • 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.

      • NodeToken [ReferenceToken]
        A mandatory reference to the PTZ Node that the PTZ Configuration belongs to.
        Maximum length: 64
      • DefaultAbsolutePantTiltPositionSpace - optional; [anyURI]
        If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default.
      • DefaultAbsoluteZoomPositionSpace - optional; [anyURI]
        If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default.
      • DefaultRelativePanTiltTranslationSpace - optional; [anyURI]
        If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default.
      • DefaultRelativeZoomTranslationSpace - optional; [anyURI]
        If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default.
      • DefaultContinuousPanTiltVelocitySpace - optional; [anyURI]
        If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default.
      • DefaultContinuousZoomVelocitySpace - optional; [anyURI]
        If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default.
      • DefaultPTZSpeed - optional; [PTZSpeed]
        If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds.
        • PanTilt - optional; [Vector2D]
          Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
          • x - required; [float]
          • y - required; [float]
          • space - optional; [anyURI]
            Pan/tilt coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
        • Zoom - optional; [Vector1D]
          A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
          • x - required; [float]
          • space - optional; [anyURI]
            Zoom coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
      • DefaultPTZTimeout - optional; [duration]
        If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops.
      • PanTiltLimits - optional; [PanTiltLimits]
        The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to -INF or +INF.
        • Range [Space2DDescription]
          A range of pan tilt limits.
          • URI [anyURI]
            A URI of coordinate systems.
          • XRange [FloatRange]
            A range of x-axis.
            • Min [float]
            • Max [float]
          • YRange [FloatRange]
            A range of y-axis.
            • Min [float]
            • Max [float]
      • ZoomLimits - optional; [ZoomLimits]
        The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF.
        • Range [Space1DDescription]
          A range of zoom limit
          • URI [anyURI]
            A URI of coordinate systems.
          • XRange [FloatRange]
            A range of x-axis.
            • Min [float]
            • Max [float]
      • Extension - optional; [PTZConfigurationExtension]
        • PTControlDirection - optional; [PTControlDirection]
          Optional element to configure PT Control Direction related features.
          • EFlip - optional; [EFlip]
            Optional element to configure related parameters for E-Flip.
            • Mode [EFlipMode]
              Parameter to enable/disable E-Flip feature.
              Enum Value Enum Description
              OFF —
              ON —
              Extended —
          • Reverse - optional; [Reverse]
            Optional element to configure related parameters for reversing of PT Control Direction.
            • Mode [ReverseMode]
              Parameter to enable/disable Reverse feature.
              Enum Value Enum Description
              OFF —
              ON —
              AUTO —
              Extended —
          • Extension - optional; [PTControlDirectionExtension]
        • Extension - optional; [PTZConfigurationExtension2]
    • MetadataConfiguration - optional; [MetadataConfiguration]
      Optional configuration of the metadata stream.
      • CompressionType - optional; [string]
        Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType.
      • GeoLocation - optional; [boolean]
        Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target.
      • ShapePolygon - optional; [boolean]
        Optional parameter to configure if the generated metadata stream should contain shape information as polygon.
      • SecureStreamingProtocolAlgorithm - optional; [string]
        The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms
      • 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.

      • PTZStatus - optional; [PTZFilter]
        Optional element to configure which PTZ related data is to include in the metadata stream.
        • Status [boolean]
          True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN).
        • Position [boolean]
          True if the metadata stream shall contain the PTZ position.
        • FieldOfView - optional; [boolean]
          True if the metadata stream shall contain the field-of-view information.
      • Events - optional; [EventSubscription]
        Optional element to configure the streaming of events. A client might be interested in receiving all, none or some of the events produced by the device:
        • To get all events: Include the Events element but do not include a filter.
        • To get no events: Do not include the Events element.
        • To get only some events: Include the Events element and include a filter in the element.
        • Filter - optional; [FilterType]
        • SubscriptionPolicy - optional; [complexType]
      • Analytics - optional; [boolean]
        Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)
      • 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 (when using Media2 Service, this value is deprecated and ignored)
      • AnalyticsEngineConfiguration - optional; [AnalyticsEngineConfiguration]
        Indication which AnalyticsModules shall output metadata. Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration.
        • AnalyticsModule - optional, unbounded; [Config]
          • Name - required; [string]
            Name of the configuration.
          • Type - required; [QName]
            The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
          • Parameters [ItemList]
            List of configuration parameters as defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • SimpleItem - optional, unbounded; [complexType]
              Value name pair as defined by the corresponding description.
              • Name - required; [string]
                Item name.
              • Value - required; [anySimpleType]
                Item value. The type is defined in the corresponding description.
            • ElementItem - optional, unbounded; [complexType]
              Complex value structure.
              • Name - required; [string]
                Item name.
            • Extension - optional; [ItemListExtension]
        • Extension - optional; [AnalyticsEngineConfigurationExtension]
      • SensorData - optional; [SensorDataFilter]
        Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:
        • To get all sensor data: Include the SensorData element but do not include any filter criteria.
        • To get no sensor data: Do not include the SensorData element.
        • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
        • SensorID - optional, unbounded; [string]
          List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them).
        • Type - optional, unbounded; [string]
          List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them).
      • Extension - optional; [MetadataConfigurationExtension]
    • Extension - optional; [ProfileExtension]
      Extensions defined in ONVIF 2.0
      • AudioOutputConfiguration - optional; [AudioOutputConfiguration]
        Optional 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.
      • AudioDecoderConfiguration - optional; [AudioDecoderConfiguration]
        Optional configuration of the Audio decoder.
        • 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.

      • Extension - optional; [ProfileExtension2]

GetProfile 

GetProfile(ProfileToken)

If the profile token is already known, a profile can be fetched through the GetProfile command.

Input
  • ProfileToken [ReferenceToken]
    This command requests a specific profile.
    Maximum length: 64
Output
  • Profile [Profile]
    Returns the requested media profile.
    • token - required; [ReferenceToken]
      Unique identifier of the profile.
    • fixed - optional; [boolean]
      A value of true signals that the profile cannot be deleted. Default is false.
    • Name [Name]
      User readable name of the profile.
      Maximum length: 64
    • VideoSourceConfiguration - optional; [VideoSourceConfiguration]
      Optional 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.
    • AudioSourceConfiguration - optional; [AudioSourceConfiguration]
      Optional 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
    • VideoEncoderConfiguration - optional; [VideoEncoderConfiguration]
      Optional configuration of the Video encoder.
      • GuaranteedFrameRate - optional; [boolean]
        A value of true indicates that frame rate is a fixed value rather than an upper limit, and that the video encoder shall prioritize frame rate over all other adaptable configuration values such as bitrate. Default is false.
      • 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.

      • Encoding [VideoEncoding]
        Used video codec, either Jpeg, H.264 or Mpeg4
        Enum Value Enum Description
        JPEG —
        MPEG4 —
        H264 —
      • Resolution [VideoResolution]
        Configured video resolution
        • 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.
      • Quality [float]
        Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality
      • RateControl - optional; [VideoRateControl]
        Optional element to configure rate control related parameters.
        • FrameRateLimit [int]
          Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor.
        • EncodingInterval [int]
          Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)
        • BitrateLimit [int]
          The maximum output bitrate in kbps.
      • MPEG4 - optional; [Mpeg4Configuration]
        Optional element to configure Mpeg4 related parameters.
        • GovLength [int]
          Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
        • Mpeg4Profile [Mpeg4Profile]
          the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)
          Enum Value Enum Description
          SP —
          ASP —
      • H264 - optional; [H264Configuration]
        Optional element to configure H.264 related parameters.
        • GovLength [int]
          Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
        • H264Profile [H264Profile]
          the H.264 profile, either baseline, main, extended or high
          Enum Value Enum Description
          Baseline —
          Main —
          Extended —
          High —
      • 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 video stream
    • AudioEncoderConfiguration - optional; [AudioEncoderConfiguration]
      Optional configuration of the Audio encoder.
      • 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.

      • 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
    • VideoAnalyticsConfiguration - optional; [VideoAnalyticsConfiguration]
      Optional configuration of the video analytics module and rule engine.
      • 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.

      • AnalyticsEngineConfiguration [AnalyticsEngineConfiguration]
        • AnalyticsModule - optional, unbounded; [Config]
          • Name - required; [string]
            Name of the configuration.
          • Type - required; [QName]
            The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
          • Parameters [ItemList]
            List of configuration parameters as defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • SimpleItem - optional, unbounded; [complexType]
              Value name pair as defined by the corresponding description.
              • Name - required; [string]
                Item name.
              • Value - required; [anySimpleType]
                Item value. The type is defined in the corresponding description.
            • ElementItem - optional, unbounded; [complexType]
              Complex value structure.
              • Name - required; [string]
                Item name.
            • Extension - optional; [ItemListExtension]
        • Extension - optional; [AnalyticsEngineConfigurationExtension]
      • RuleEngineConfiguration [RuleEngineConfiguration]
        • Rule - optional, unbounded; [Config]
          • Name - required; [string]
            Name of the configuration.
          • Type - required; [QName]
            The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
          • Parameters [ItemList]
            List of configuration parameters as defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • SimpleItem - optional, unbounded; [complexType]
              Value name pair as defined by the corresponding description.
              • Name - required; [string]
                Item name.
              • Value - required; [anySimpleType]
                Item value. The type is defined in the corresponding description.
            • ElementItem - optional, unbounded; [complexType]
              Complex value structure.
              • Name - required; [string]
                Item name.
            • Extension - optional; [ItemListExtension]
        • Extension - optional; [RuleEngineConfigurationExtension]
    • PTZConfiguration - optional; [PTZConfiguration]
      Optional configuration of the pan tilt zoom unit.
      • MoveRamp - optional; [int]
        The optional acceleration ramp used by the device when moving.
      • PresetRamp - optional; [int]
        The optional acceleration ramp used by the device when recalling presets.
      • PresetTourRamp - optional; [int]
        The optional acceleration ramp used by the device when executing PresetTours.
      • 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.

      • NodeToken [ReferenceToken]
        A mandatory reference to the PTZ Node that the PTZ Configuration belongs to.
        Maximum length: 64
      • DefaultAbsolutePantTiltPositionSpace - optional; [anyURI]
        If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default.
      • DefaultAbsoluteZoomPositionSpace - optional; [anyURI]
        If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default.
      • DefaultRelativePanTiltTranslationSpace - optional; [anyURI]
        If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default.
      • DefaultRelativeZoomTranslationSpace - optional; [anyURI]
        If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default.
      • DefaultContinuousPanTiltVelocitySpace - optional; [anyURI]
        If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default.
      • DefaultContinuousZoomVelocitySpace - optional; [anyURI]
        If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default.
      • DefaultPTZSpeed - optional; [PTZSpeed]
        If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds.
        • PanTilt - optional; [Vector2D]
          Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
          • x - required; [float]
          • y - required; [float]
          • space - optional; [anyURI]
            Pan/tilt coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
        • Zoom - optional; [Vector1D]
          A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
          • x - required; [float]
          • space - optional; [anyURI]
            Zoom coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
      • DefaultPTZTimeout - optional; [duration]
        If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops.
      • PanTiltLimits - optional; [PanTiltLimits]
        The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to -INF or +INF.
        • Range [Space2DDescription]
          A range of pan tilt limits.
          • URI [anyURI]
            A URI of coordinate systems.
          • XRange [FloatRange]
            A range of x-axis.
            • Min [float]
            • Max [float]
          • YRange [FloatRange]
            A range of y-axis.
            • Min [float]
            • Max [float]
      • ZoomLimits - optional; [ZoomLimits]
        The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF.
        • Range [Space1DDescription]
          A range of zoom limit
          • URI [anyURI]
            A URI of coordinate systems.
          • XRange [FloatRange]
            A range of x-axis.
            • Min [float]
            • Max [float]
      • Extension - optional; [PTZConfigurationExtension]
        • PTControlDirection - optional; [PTControlDirection]
          Optional element to configure PT Control Direction related features.
          • EFlip - optional; [EFlip]
            Optional element to configure related parameters for E-Flip.
            • Mode [EFlipMode]
              Parameter to enable/disable E-Flip feature.
              Enum Value Enum Description
              OFF —
              ON —
              Extended —
          • Reverse - optional; [Reverse]
            Optional element to configure related parameters for reversing of PT Control Direction.
            • Mode [ReverseMode]
              Parameter to enable/disable Reverse feature.
              Enum Value Enum Description
              OFF —
              ON —
              AUTO —
              Extended —
          • Extension - optional; [PTControlDirectionExtension]
        • Extension - optional; [PTZConfigurationExtension2]
    • MetadataConfiguration - optional; [MetadataConfiguration]
      Optional configuration of the metadata stream.
      • CompressionType - optional; [string]
        Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType.
      • GeoLocation - optional; [boolean]
        Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target.
      • ShapePolygon - optional; [boolean]
        Optional parameter to configure if the generated metadata stream should contain shape information as polygon.
      • SecureStreamingProtocolAlgorithm - optional; [string]
        The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms
      • 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.

      • PTZStatus - optional; [PTZFilter]
        Optional element to configure which PTZ related data is to include in the metadata stream.
        • Status [boolean]
          True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN).
        • Position [boolean]
          True if the metadata stream shall contain the PTZ position.
        • FieldOfView - optional; [boolean]
          True if the metadata stream shall contain the field-of-view information.
      • Events - optional; [EventSubscription]
        Optional element to configure the streaming of events. A client might be interested in receiving all, none or some of the events produced by the device:
        • To get all events: Include the Events element but do not include a filter.
        • To get no events: Do not include the Events element.
        • To get only some events: Include the Events element and include a filter in the element.
        • Filter - optional; [FilterType]
        • SubscriptionPolicy - optional; [complexType]
      • Analytics - optional; [boolean]
        Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)
      • 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 (when using Media2 Service, this value is deprecated and ignored)
      • AnalyticsEngineConfiguration - optional; [AnalyticsEngineConfiguration]
        Indication which AnalyticsModules shall output metadata. Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration.
        • AnalyticsModule - optional, unbounded; [Config]
          • Name - required; [string]
            Name of the configuration.
          • Type - required; [QName]
            The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
          • Parameters [ItemList]
            List of configuration parameters as defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • SimpleItem - optional, unbounded; [complexType]
              Value name pair as defined by the corresponding description.
              • Name - required; [string]
                Item name.
              • Value - required; [anySimpleType]
                Item value. The type is defined in the corresponding description.
            • ElementItem - optional, unbounded; [complexType]
              Complex value structure.
              • Name - required; [string]
                Item name.
            • Extension - optional; [ItemListExtension]
        • Extension - optional; [AnalyticsEngineConfigurationExtension]
      • SensorData - optional; [SensorDataFilter]
        Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:
        • To get all sensor data: Include the SensorData element but do not include any filter criteria.
        • To get no sensor data: Do not include the SensorData element.
        • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
        • SensorID - optional, unbounded; [string]
          List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them).
        • Type - optional, unbounded; [string]
          List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them).
      • Extension - optional; [MetadataConfigurationExtension]
    • Extension - optional; [ProfileExtension]
      Extensions defined in ONVIF 2.0
      • AudioOutputConfiguration - optional; [AudioOutputConfiguration]
        Optional 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.
      • AudioDecoderConfiguration - optional; [AudioDecoderConfiguration]
        Optional configuration of the Audio decoder.
        • 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.

      • Extension - optional; [ProfileExtension2]

GetProfiles 

GetProfiles()

Any endpoint can ask for the existing media profiles of a device using the GetProfiles command.

Pre-configured or dynamically configured profiles can be retrieved using this command. This command lists all configured profiles in a device. The client does not need to know the media profile in order to use the command.

Output
  • Profiles - optional, unbounded; [Profile]
    lists all profiles that exist in the media service
    • token - required; [ReferenceToken]
      Unique identifier of the profile.
    • fixed - optional; [boolean]
      A value of true signals that the profile cannot be deleted. Default is false.
    • Name [Name]
      User readable name of the profile.
      Maximum length: 64
    • VideoSourceConfiguration - optional; [VideoSourceConfiguration]
      Optional 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.
    • AudioSourceConfiguration - optional; [AudioSourceConfiguration]
      Optional 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
    • VideoEncoderConfiguration - optional; [VideoEncoderConfiguration]
      Optional configuration of the Video encoder.
      • GuaranteedFrameRate - optional; [boolean]
        A value of true indicates that frame rate is a fixed value rather than an upper limit, and that the video encoder shall prioritize frame rate over all other adaptable configuration values such as bitrate. Default is false.
      • 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.

      • Encoding [VideoEncoding]
        Used video codec, either Jpeg, H.264 or Mpeg4
        Enum Value Enum Description
        JPEG —
        MPEG4 —
        H264 —
      • Resolution [VideoResolution]
        Configured video resolution
        • 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.
      • Quality [float]
        Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality
      • RateControl - optional; [VideoRateControl]
        Optional element to configure rate control related parameters.
        • FrameRateLimit [int]
          Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor.
        • EncodingInterval [int]
          Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)
        • BitrateLimit [int]
          The maximum output bitrate in kbps.
      • MPEG4 - optional; [Mpeg4Configuration]
        Optional element to configure Mpeg4 related parameters.
        • GovLength [int]
          Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
        • Mpeg4Profile [Mpeg4Profile]
          the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)
          Enum Value Enum Description
          SP —
          ASP —
      • H264 - optional; [H264Configuration]
        Optional element to configure H.264 related parameters.
        • GovLength [int]
          Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
        • H264Profile [H264Profile]
          the H.264 profile, either baseline, main, extended or high
          Enum Value Enum Description
          Baseline —
          Main —
          Extended —
          High —
      • 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 video stream
    • AudioEncoderConfiguration - optional; [AudioEncoderConfiguration]
      Optional configuration of the Audio encoder.
      • 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.

      • 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
    • VideoAnalyticsConfiguration - optional; [VideoAnalyticsConfiguration]
      Optional configuration of the video analytics module and rule engine.
      • 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.

      • AnalyticsEngineConfiguration [AnalyticsEngineConfiguration]
        • AnalyticsModule - optional, unbounded; [Config]
          • Name - required; [string]
            Name of the configuration.
          • Type - required; [QName]
            The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
          • Parameters [ItemList]
            List of configuration parameters as defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • SimpleItem - optional, unbounded; [complexType]
              Value name pair as defined by the corresponding description.
              • Name - required; [string]
                Item name.
              • Value - required; [anySimpleType]
                Item value. The type is defined in the corresponding description.
            • ElementItem - optional, unbounded; [complexType]
              Complex value structure.
              • Name - required; [string]
                Item name.
            • Extension - optional; [ItemListExtension]
        • Extension - optional; [AnalyticsEngineConfigurationExtension]
      • RuleEngineConfiguration [RuleEngineConfiguration]
        • Rule - optional, unbounded; [Config]
          • Name - required; [string]
            Name of the configuration.
          • Type - required; [QName]
            The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
          • Parameters [ItemList]
            List of configuration parameters as defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • SimpleItem - optional, unbounded; [complexType]
              Value name pair as defined by the corresponding description.
              • Name - required; [string]
                Item name.
              • Value - required; [anySimpleType]
                Item value. The type is defined in the corresponding description.
            • ElementItem - optional, unbounded; [complexType]
              Complex value structure.
              • Name - required; [string]
                Item name.
            • Extension - optional; [ItemListExtension]
        • Extension - optional; [RuleEngineConfigurationExtension]
    • PTZConfiguration - optional; [PTZConfiguration]
      Optional configuration of the pan tilt zoom unit.
      • MoveRamp - optional; [int]
        The optional acceleration ramp used by the device when moving.
      • PresetRamp - optional; [int]
        The optional acceleration ramp used by the device when recalling presets.
      • PresetTourRamp - optional; [int]
        The optional acceleration ramp used by the device when executing PresetTours.
      • 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.

      • NodeToken [ReferenceToken]
        A mandatory reference to the PTZ Node that the PTZ Configuration belongs to.
        Maximum length: 64
      • DefaultAbsolutePantTiltPositionSpace - optional; [anyURI]
        If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default.
      • DefaultAbsoluteZoomPositionSpace - optional; [anyURI]
        If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default.
      • DefaultRelativePanTiltTranslationSpace - optional; [anyURI]
        If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default.
      • DefaultRelativeZoomTranslationSpace - optional; [anyURI]
        If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default.
      • DefaultContinuousPanTiltVelocitySpace - optional; [anyURI]
        If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default.
      • DefaultContinuousZoomVelocitySpace - optional; [anyURI]
        If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default.
      • DefaultPTZSpeed - optional; [PTZSpeed]
        If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds.
        • PanTilt - optional; [Vector2D]
          Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
          • x - required; [float]
          • y - required; [float]
          • space - optional; [anyURI]
            Pan/tilt coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
        • Zoom - optional; [Vector1D]
          A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
          • x - required; [float]
          • space - optional; [anyURI]
            Zoom coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
      • DefaultPTZTimeout - optional; [duration]
        If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops.
      • PanTiltLimits - optional; [PanTiltLimits]
        The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to -INF or +INF.
        • Range [Space2DDescription]
          A range of pan tilt limits.
          • URI [anyURI]
            A URI of coordinate systems.
          • XRange [FloatRange]
            A range of x-axis.
            • Min [float]
            • Max [float]
          • YRange [FloatRange]
            A range of y-axis.
            • Min [float]
            • Max [float]
      • ZoomLimits - optional; [ZoomLimits]
        The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF.
        • Range [Space1DDescription]
          A range of zoom limit
          • URI [anyURI]
            A URI of coordinate systems.
          • XRange [FloatRange]
            A range of x-axis.
            • Min [float]
            • Max [float]
      • Extension - optional; [PTZConfigurationExtension]
        • PTControlDirection - optional; [PTControlDirection]
          Optional element to configure PT Control Direction related features.
          • EFlip - optional; [EFlip]
            Optional element to configure related parameters for E-Flip.
            • Mode [EFlipMode]
              Parameter to enable/disable E-Flip feature.
              Enum Value Enum Description
              OFF —
              ON —
              Extended —
          • Reverse - optional; [Reverse]
            Optional element to configure related parameters for reversing of PT Control Direction.
            • Mode [ReverseMode]
              Parameter to enable/disable Reverse feature.
              Enum Value Enum Description
              OFF —
              ON —
              AUTO —
              Extended —
          • Extension - optional; [PTControlDirectionExtension]
        • Extension - optional; [PTZConfigurationExtension2]
    • MetadataConfiguration - optional; [MetadataConfiguration]
      Optional configuration of the metadata stream.
      • CompressionType - optional; [string]
        Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType.
      • GeoLocation - optional; [boolean]
        Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target.
      • ShapePolygon - optional; [boolean]
        Optional parameter to configure if the generated metadata stream should contain shape information as polygon.
      • SecureStreamingProtocolAlgorithm - optional; [string]
        The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms
      • 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.

      • PTZStatus - optional; [PTZFilter]
        Optional element to configure which PTZ related data is to include in the metadata stream.
        • Status [boolean]
          True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN).
        • Position [boolean]
          True if the metadata stream shall contain the PTZ position.
        • FieldOfView - optional; [boolean]
          True if the metadata stream shall contain the field-of-view information.
      • Events - optional; [EventSubscription]
        Optional element to configure the streaming of events. A client might be interested in receiving all, none or some of the events produced by the device:
        • To get all events: Include the Events element but do not include a filter.
        • To get no events: Do not include the Events element.
        • To get only some events: Include the Events element and include a filter in the element.
        • Filter - optional; [FilterType]
        • SubscriptionPolicy - optional; [complexType]
      • Analytics - optional; [boolean]
        Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)
      • 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 (when using Media2 Service, this value is deprecated and ignored)
      • AnalyticsEngineConfiguration - optional; [AnalyticsEngineConfiguration]
        Indication which AnalyticsModules shall output metadata. Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration.
        • AnalyticsModule - optional, unbounded; [Config]
          • Name - required; [string]
            Name of the configuration.
          • Type - required; [QName]
            The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
          • Parameters [ItemList]
            List of configuration parameters as defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
            • Name - required; [string]
              Item name.
            • SimpleItem - optional, unbounded; [complexType]
              Value name pair as defined by the corresponding description.
              • Name - required; [string]
                Item name.
              • Value - required; [anySimpleType]
                Item value. The type is defined in the corresponding description.
            • ElementItem - optional, unbounded; [complexType]
              Complex value structure.
              • Name - required; [string]
                Item name.
            • Extension - optional; [ItemListExtension]
        • Extension - optional; [AnalyticsEngineConfigurationExtension]
      • SensorData - optional; [SensorDataFilter]
        Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:
        • To get all sensor data: Include the SensorData element but do not include any filter criteria.
        • To get no sensor data: Do not include the SensorData element.
        • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
        • SensorID - optional, unbounded; [string]
          List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them).
        • Type - optional, unbounded; [string]
          List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them).
      • Extension - optional; [MetadataConfigurationExtension]
    • Extension - optional; [ProfileExtension]
      Extensions defined in ONVIF 2.0
      • AudioOutputConfiguration - optional; [AudioOutputConfiguration]
        Optional 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.
      • AudioDecoderConfiguration - optional; [AudioDecoderConfiguration]
        Optional configuration of the Audio decoder.
        • 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.

      • Extension - optional; [ProfileExtension2]

AddVideoEncoderConfiguration 

AddVideoEncoderConfiguration(
    ProfileToken, ConfigurationToken
)

This operation adds a VideoEncoderConfiguration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent. A device shall support adding a compatible VideoEncoderConfiguration to a Profile containing a VideoSourceConfiguration and shall support streaming video data of such a profile.

Input
  • ProfileToken [ReferenceToken]
    Reference to the profile where the configuration should be added
    Maximum length: 64
  • ConfigurationToken [ReferenceToken]
    Contains a reference to the VideoEncoderConfiguration to add
    Maximum length: 64

AddVideoSourceConfiguration 

AddVideoSourceConfiguration(
    ProfileToken, ConfigurationToken
)

This operation adds a VideoSourceConfiguration to an existing media profile.

If such a configuration exists in the media profile, it will be replaced. The change shall be persistent.

Input
  • ProfileToken [ReferenceToken]
    Reference to the profile where the configuration should be added
    Maximum length: 64
  • ConfigurationToken [ReferenceToken]
    Contains a reference to the VideoSourceConfiguration to add
    Maximum length: 64

AddAudioEncoderConfiguration 

AddAudioEncoderConfiguration(
    ProfileToken, ConfigurationToken
)

This operation adds an AudioEncoderConfiguration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent. A device shall support adding a compatible AudioEncoderConfiguration to a profile containing an AudioSourceConfiguration and shall support streaming audio data of such a profile.

Input
  • ProfileToken [ReferenceToken]
    Reference to the profile where the configuration should be added
    Maximum length: 64
  • ConfigurationToken [ReferenceToken]
    Contains a reference to the AudioEncoderConfiguration to add
    Maximum length: 64

AddAudioSourceConfiguration 

AddAudioSourceConfiguration(
    ProfileToken, ConfigurationToken
)

This operation adds an AudioSourceConfiguration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent.

Input
  • ProfileToken [ReferenceToken]
    Reference to the profile where the configuration should be added
    Maximum length: 64
  • ConfigurationToken [ReferenceToken]
    Contains a reference to the AudioSourceConfiguration to add
    Maximum length: 64

AddPTZConfiguration 

AddPTZConfiguration(ProfileToken, ConfigurationToken)

This operation adds a PTZConfiguration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent. Adding a PTZConfiguration to a media profile means that streams using that media profile can contain PTZ status (in the metadata), and that the media profile can be used for controlling PTZ movement.

Input
  • ProfileToken [ReferenceToken]
    Reference to the profile where the configuration should be added
    Maximum length: 64
  • ConfigurationToken [ReferenceToken]
    Contains a reference to the PTZConfiguration to add
    Maximum length: 64

AddVideoAnalyticsConfiguration 

AddVideoAnalyticsConfiguration(
    ProfileToken, ConfigurationToken
)

This operation adds a VideoAnalytics configuration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent. Adding a VideoAnalyticsConfiguration to a media profile means that streams using that media profile can contain video analytics data (in the metadata) as defined by the submitted configuration reference. A profile containing only a video analytics configuration but no video source configuration is incomplete. Therefore, a client should first add a video source configuration to a profile before adding a video analytics configuration. The device can deny adding of a video analytics configuration before a video source configuration.

Input
  • ProfileToken [ReferenceToken]
    Reference to the profile where the configuration should be added
    Maximum length: 64
  • ConfigurationToken [ReferenceToken]
    Contains a reference to the VideoAnalyticsConfiguration to add
    Maximum length: 64

AddMetadataConfiguration 

AddMetadataConfiguration(ProfileToken, ConfigurationToken)

This operation adds a Metadata configuration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent. Adding a MetadataConfiguration to a Profile means that streams using that profile contain metadata. Metadata can consist of events, PTZ status, and/or video analytics data.

Input
  • ProfileToken [ReferenceToken]
    Reference to the profile where the configuration should be added
    Maximum length: 64
  • ConfigurationToken [ReferenceToken]
    Contains a reference to the MetadataConfiguration to add
    Maximum length: 64

AddAudioOutputConfiguration 

AddAudioOutputConfiguration(
    ProfileToken, ConfigurationToken
)

This operation adds an AudioOutputConfiguration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent.

Input
  • ProfileToken [ReferenceToken]
    Reference to the profile where the configuration should be added
    Maximum length: 64
  • ConfigurationToken [ReferenceToken]
    Contains a reference to the AudioOutputConfiguration to add
    Maximum length: 64

AddAudioDecoderConfiguration 

AddAudioDecoderConfiguration(
    ProfileToken, ConfigurationToken
)

This operation adds an AudioDecoderConfiguration to an existing media profile.

If a configuration exists in the media profile, it shall be replaced. The change shall be persistent.

Input
  • ProfileToken [ReferenceToken]
    This element contains a reference to the profile where the configuration should be added.
    Maximum length: 64
  • ConfigurationToken [ReferenceToken]
    This element contains a reference to the AudioDecoderConfiguration to add.
    Maximum length: 64

RemoveVideoEncoderConfiguration 

RemoveVideoEncoderConfiguration(ProfileToken)

This operation removes a VideoEncoderConfiguration from an existing media profile.

If the media profile does not contain a VideoEncoderConfiguration, the operation has no effect. The removal shall be persistent.

Input
  • ProfileToken [ReferenceToken]
    Contains a reference to the media profile from which the VideoEncoderConfiguration shall be removed.
    Maximum length: 64

RemoveVideoSourceConfiguration 

RemoveVideoSourceConfiguration(ProfileToken)

This operation removes a VideoSourceConfiguration from an existing media profile.

If the media profile does not contain a VideoSourceConfiguration, the operation has no effect. The removal shall be persistent. Video source configurations should only be removed after removing a VideoEncoderConfiguration from the media profile.

Input
  • ProfileToken [ReferenceToken]
    Contains a reference to the media profile from which the VideoSourceConfiguration shall be removed.
    Maximum length: 64

RemoveAudioEncoderConfiguration 

RemoveAudioEncoderConfiguration(ProfileToken)

This operation removes an AudioEncoderConfiguration from an existing media profile.

If the media profile does not contain an AudioEncoderConfiguration, the operation has no effect. The removal shall be persistent.

Input
  • ProfileToken [ReferenceToken]
    Contains a reference to the media profile from which the AudioEncoderConfiguration shall be removed.
    Maximum length: 64

RemoveAudioSourceConfiguration 

RemoveAudioSourceConfiguration(ProfileToken)

This operation removes an AudioSourceConfiguration from an existing media profile.

If the media profile does not contain an AudioSourceConfiguration, the operation has no effect. The removal shall be persistent. Audio source configurations should only be removed after removing an AudioEncoderConfiguration from the media profile.

Input
  • ProfileToken [ReferenceToken]
    Contains a reference to the media profile from which the AudioSourceConfiguration shall be removed.
    Maximum length: 64

RemovePTZConfiguration 

RemovePTZConfiguration(ProfileToken)

This operation removes a PTZConfiguration from an existing media profile.

If the media profile does not contain a PTZConfiguration, the operation has no effect. The removal shall be persistent.

Input
  • ProfileToken [ReferenceToken]
    Contains a reference to the media profile from which the PTZConfiguration shall be removed.
    Maximum length: 64

RemoveVideoAnalyticsConfiguration 

RemoveVideoAnalyticsConfiguration(ProfileToken)

This operation removes a VideoAnalyticsConfiguration from an existing media profile.

If the media profile does not contain a VideoAnalyticsConfiguration, the operation has no effect. The removal shall be persistent.

Input
  • ProfileToken [ReferenceToken]
    Contains a reference to the media profile from which the VideoAnalyticsConfiguration shall be removed.
    Maximum length: 64

RemoveMetadataConfiguration 

RemoveMetadataConfiguration(ProfileToken)

This operation removes a MetadataConfiguration from an existing media profile.

If the media profile does not contain a MetadataConfiguration, the operation has no effect. The removal shall be persistent.

Input
  • ProfileToken [ReferenceToken]
    Contains a reference to the media profile from which the MetadataConfiguration shall be removed.
    Maximum length: 64

RemoveAudioOutputConfiguration 

RemoveAudioOutputConfiguration(ProfileToken)

This operation removes an AudioOutputConfiguration from an existing media profile.

If the media profile does not contain an AudioOutputConfiguration, the operation has no effect. The removal shall be persistent.

Input
  • ProfileToken [ReferenceToken]
    Contains a reference to the media profile from which the AudioOutputConfiguration shall be removed.
    Maximum length: 64

RemoveAudioDecoderConfiguration 

RemoveAudioDecoderConfiguration(ProfileToken)

This operation removes an AudioDecoderConfiguration from an existing media profile.

If the media profile does not contain an AudioDecoderConfiguration, the operation has no effect. The removal shall be persistent.

Input
  • ProfileToken [ReferenceToken]
    This element contains a reference to the media profile from which the AudioDecoderConfiguration shall be removed.
    Maximum length: 64

DeleteProfile 

DeleteProfile(ProfileToken)

This operation deletes a profile.

This change shall always be persistent. Deletion of a profile is only possible for non-fixed profiles

Input
  • ProfileToken [ReferenceToken]
    This element contains a reference to the profile that should be deleted.
    Maximum length: 64

GetVideoSourceConfigurations 

GetVideoSourceConfigurations()

This operation lists all existing video source configurations for a device.

The client need not know anything about the video source configurations in order to use the command.

Output
  • Configurations - optional, unbounded; [VideoSourceConfiguration]
    This element contains a list of video source configurations.
    • 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.

GetVideoEncoderConfigurations 

GetVideoEncoderConfigurations()

This operation lists all existing video encoder configurations of a device.

This command lists all configured video encoder configurations in a device. The client need not know anything apriori about the video encoder configurations in order to use the command.

Output
  • Configurations - optional, unbounded; [VideoEncoderConfiguration]
    This element contains a list of video encoder configurations.
    • GuaranteedFrameRate - optional; [boolean]
      A value of true indicates that frame rate is a fixed value rather than an upper limit, and that the video encoder shall prioritize frame rate over all other adaptable configuration values such as bitrate. Default is false.
    • 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.

    • Encoding [VideoEncoding]
      Used video codec, either Jpeg, H.264 or Mpeg4
      Enum Value Enum Description
      JPEG —
      MPEG4 —
      H264 —
    • Resolution [VideoResolution]
      Configured video resolution
      • 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.
    • Quality [float]
      Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality
    • RateControl - optional; [VideoRateControl]
      Optional element to configure rate control related parameters.
      • FrameRateLimit [int]
        Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor.
      • EncodingInterval [int]
        Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)
      • BitrateLimit [int]
        The maximum output bitrate in kbps.
    • MPEG4 - optional; [Mpeg4Configuration]
      Optional element to configure Mpeg4 related parameters.
      • GovLength [int]
        Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
      • Mpeg4Profile [Mpeg4Profile]
        the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)
        Enum Value Enum Description
        SP —
        ASP —
    • H264 - optional; [H264Configuration]
      Optional element to configure H.264 related parameters.
      • GovLength [int]
        Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
      • H264Profile [H264Profile]
        the H.264 profile, either baseline, main, extended or high
        Enum Value Enum Description
        Baseline —
        Main —
        Extended —
        High —
    • 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 video stream

GetAudioSourceConfigurations 

GetAudioSourceConfigurations()

This operation lists all existing audio source configurations of a device.

This command lists all audio source configurations in a device. The client need not know anything apriori about the audio source configurations in order to use the command.

Output
  • Configurations - optional, unbounded; [AudioSourceConfiguration]
    This element contains a list of audio source configurations.
    • 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

GetAudioEncoderConfigurations 

GetAudioEncoderConfigurations()

This operation lists all existing device audio encoder configurations.

The client need not know anything apriori about the audio encoder configurations in order to use the command.

Output
  • Configurations - optional, unbounded; [AudioEncoderConfiguration]
    This element contains a list of audio encoder configurations.
    • 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.

    • 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

GetVideoAnalyticsConfigurations 

GetVideoAnalyticsConfigurations()

This operation lists all video analytics configurations of a device.

This command lists all configured video analytics in a device. The client need not know anything apriori about the video analytics in order to use the command.

Output
  • Configurations - optional, unbounded; [VideoAnalyticsConfiguration]
    This element contains a list of VideoAnalytics configurations.
    • 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.

    • AnalyticsEngineConfiguration [AnalyticsEngineConfiguration]
      • AnalyticsModule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [AnalyticsEngineConfigurationExtension]
    • RuleEngineConfiguration [RuleEngineConfiguration]
      • Rule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [RuleEngineConfigurationExtension]

GetMetadataConfigurations 

GetMetadataConfigurations()

This operation lists all existing metadata configurations.

The client need not know anything apriori about the metadata in order to use the command.

Output
  • Configurations - optional, unbounded; [MetadataConfiguration]
    This element contains a list of metadata configurations
    • CompressionType - optional; [string]
      Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType.
    • GeoLocation - optional; [boolean]
      Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target.
    • ShapePolygon - optional; [boolean]
      Optional parameter to configure if the generated metadata stream should contain shape information as polygon.
    • SecureStreamingProtocolAlgorithm - optional; [string]
      The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms
    • 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.

    • PTZStatus - optional; [PTZFilter]
      Optional element to configure which PTZ related data is to include in the metadata stream.
      • Status [boolean]
        True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN).
      • Position [boolean]
        True if the metadata stream shall contain the PTZ position.
      • FieldOfView - optional; [boolean]
        True if the metadata stream shall contain the field-of-view information.
    • Events - optional; [EventSubscription]
      Optional element to configure the streaming of events. A client might be interested in receiving all, none or some of the events produced by the device:
      • To get all events: Include the Events element but do not include a filter.
      • To get no events: Do not include the Events element.
      • To get only some events: Include the Events element and include a filter in the element.
      • Filter - optional; [FilterType]
      • SubscriptionPolicy - optional; [complexType]
    • Analytics - optional; [boolean]
      Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)
    • 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 (when using Media2 Service, this value is deprecated and ignored)
    • AnalyticsEngineConfiguration - optional; [AnalyticsEngineConfiguration]
      Indication which AnalyticsModules shall output metadata. Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration.
      • AnalyticsModule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [AnalyticsEngineConfigurationExtension]
    • SensorData - optional; [SensorDataFilter]
      Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:
      • To get all sensor data: Include the SensorData element but do not include any filter criteria.
      • To get no sensor data: Do not include the SensorData element.
      • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
      • SensorID - optional, unbounded; [string]
        List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them).
      • Type - optional, unbounded; [string]
        List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them).
    • Extension - optional; [MetadataConfigurationExtension]

GetAudioOutputConfigurations 

GetAudioOutputConfigurations()

This command lists all existing AudioOutputConfigurations of a device.

The NVC need not know anything apriori about the audio configurations to use this command.

Output
  • Configurations - optional, unbounded; [AudioOutputConfiguration]
    This element contains a list of audio output configurations
    • 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.

GetAudioDecoderConfigurations 

GetAudioDecoderConfigurations()

This command lists all existing AudioDecoderConfigurations of a device.

The NVC need not know anything apriori about the audio decoder configurations in order to use this command.

Output
  • Configurations - optional, unbounded; [AudioDecoderConfiguration]
    This element contains a list of audio decoder configurations
    • 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.

GetVideoSourceConfiguration 

GetVideoSourceConfiguration(ConfigurationToken)

If the video source configuration token is already known, the video source configuration can be fetched through the GetVideoSourceConfiguration command.

Input
  • ConfigurationToken [ReferenceToken]
    Token of the requested video source configuration.
    Maximum length: 64
Output
  • Configuration [VideoSourceConfiguration]
    The requested video source configuration.
    • 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.

GetVideoEncoderConfiguration 

GetVideoEncoderConfiguration(ConfigurationToken)

If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command.

Input
  • ConfigurationToken [ReferenceToken]
    Token of the requested video encoder configuration.
    Maximum length: 64
Output
  • Configuration [VideoEncoderConfiguration]
    The requested video encoder configuration.
    • GuaranteedFrameRate - optional; [boolean]
      A value of true indicates that frame rate is a fixed value rather than an upper limit, and that the video encoder shall prioritize frame rate over all other adaptable configuration values such as bitrate. Default is false.
    • 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.

    • Encoding [VideoEncoding]
      Used video codec, either Jpeg, H.264 or Mpeg4
      Enum Value Enum Description
      JPEG —
      MPEG4 —
      H264 —
    • Resolution [VideoResolution]
      Configured video resolution
      • 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.
    • Quality [float]
      Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality
    • RateControl - optional; [VideoRateControl]
      Optional element to configure rate control related parameters.
      • FrameRateLimit [int]
        Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor.
      • EncodingInterval [int]
        Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)
      • BitrateLimit [int]
        The maximum output bitrate in kbps.
    • MPEG4 - optional; [Mpeg4Configuration]
      Optional element to configure Mpeg4 related parameters.
      • GovLength [int]
        Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
      • Mpeg4Profile [Mpeg4Profile]
        the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)
        Enum Value Enum Description
        SP —
        ASP —
    • H264 - optional; [H264Configuration]
      Optional element to configure H.264 related parameters.
      • GovLength [int]
        Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
      • H264Profile [H264Profile]
        the H.264 profile, either baseline, main, extended or high
        Enum Value Enum Description
        Baseline —
        Main —
        Extended —
        High —
    • 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 video stream

GetAudioSourceConfiguration 

GetAudioSourceConfiguration(ConfigurationToken)

The GetAudioSourceConfiguration command fetches the audio source configurations if the audio source configuration token is already known.

Input
  • ConfigurationToken [ReferenceToken]
    Token of the requested audio source configuration.
    Maximum length: 64
Output
  • Configuration [AudioSourceConfiguration]
    The requested audio source configuration.
    • 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

GetAudioEncoderConfiguration 

GetAudioEncoderConfiguration(ConfigurationToken)

The GetAudioEncoderConfiguration command fetches the encoder configuration if the audio encoder configuration token is known.

Input
  • ConfigurationToken [ReferenceToken]
    Token of the requested audio encoder configuration.
    Maximum length: 64
Output
  • Configuration [AudioEncoderConfiguration]
    The requested audio encoder configuration
    • 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.

    • 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

GetVideoAnalyticsConfiguration 

GetVideoAnalyticsConfiguration(ConfigurationToken)

The GetVideoAnalyticsConfiguration command fetches the video analytics configuration if the video analytics token is known.

Input
  • ConfigurationToken [ReferenceToken]
    Token of the requested video analytics configuration.
    Maximum length: 64
Output
  • Configuration [VideoAnalyticsConfiguration]
    The requested video analytics configuration.
    • 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.

    • AnalyticsEngineConfiguration [AnalyticsEngineConfiguration]
      • AnalyticsModule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [AnalyticsEngineConfigurationExtension]
    • RuleEngineConfiguration [RuleEngineConfiguration]
      • Rule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [RuleEngineConfigurationExtension]

GetMetadataConfiguration 

GetMetadataConfiguration(ConfigurationToken)

The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known.

Input
  • ConfigurationToken [ReferenceToken]
    Token of the requested metadata configuration.
    Maximum length: 64
Output
  • Configuration [MetadataConfiguration]
    The requested metadata configuration.
    • CompressionType - optional; [string]
      Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType.
    • GeoLocation - optional; [boolean]
      Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target.
    • ShapePolygon - optional; [boolean]
      Optional parameter to configure if the generated metadata stream should contain shape information as polygon.
    • SecureStreamingProtocolAlgorithm - optional; [string]
      The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms
    • 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.

    • PTZStatus - optional; [PTZFilter]
      Optional element to configure which PTZ related data is to include in the metadata stream.
      • Status [boolean]
        True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN).
      • Position [boolean]
        True if the metadata stream shall contain the PTZ position.
      • FieldOfView - optional; [boolean]
        True if the metadata stream shall contain the field-of-view information.
    • Events - optional; [EventSubscription]
      Optional element to configure the streaming of events. A client might be interested in receiving all, none or some of the events produced by the device:
      • To get all events: Include the Events element but do not include a filter.
      • To get no events: Do not include the Events element.
      • To get only some events: Include the Events element and include a filter in the element.
      • Filter - optional; [FilterType]
      • SubscriptionPolicy - optional; [complexType]
    • Analytics - optional; [boolean]
      Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)
    • 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 (when using Media2 Service, this value is deprecated and ignored)
    • AnalyticsEngineConfiguration - optional; [AnalyticsEngineConfiguration]
      Indication which AnalyticsModules shall output metadata. Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration.
      • AnalyticsModule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [AnalyticsEngineConfigurationExtension]
    • SensorData - optional; [SensorDataFilter]
      Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:
      • To get all sensor data: Include the SensorData element but do not include any filter criteria.
      • To get no sensor data: Do not include the SensorData element.
      • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
      • SensorID - optional, unbounded; [string]
        List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them).
      • Type - optional, unbounded; [string]
        List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them).
    • Extension - optional; [MetadataConfigurationExtension]

GetAudioOutputConfiguration 

GetAudioOutputConfiguration(ConfigurationToken)

If the audio output configuration token is already known, the output configuration can be fetched through the GetAudioOutputConfiguration command.

Input
  • ConfigurationToken [ReferenceToken]
    Token of the requested audio output configuration.
    Maximum length: 64
Output
  • Configuration [AudioOutputConfiguration]
    The requested audio output configuration.
    • 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.

GetAudioDecoderConfiguration 

GetAudioDecoderConfiguration(ConfigurationToken)

If the audio decoder configuration token is already known, the decoder configuration can be fetched through the GetAudioDecoderConfiguration command.

Input
  • ConfigurationToken [ReferenceToken]
    Token of the requested audio decoder configuration.
    Maximum length: 64
Output
  • Configuration [AudioDecoderConfiguration]
    The requested audio decoder configuration
    • 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.

GetCompatibleVideoEncoderConfigurations 

GetCompatibleVideoEncoderConfigurations(ProfileToken)

This operation lists all the video encoder configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddVideoEncoderConfiguration command on the media profile. The result will vary depending on the capabilities, configurations and settings in the device.

Input
  • ProfileToken [ReferenceToken]
    Contains the token of an existing media profile the configurations shall be compatible with.
    Maximum length: 64
Output
  • Configurations - optional, unbounded; [VideoEncoderConfiguration]
    Contains a list of video encoder configurations that are compatible with the specified media profile.
    • GuaranteedFrameRate - optional; [boolean]
      A value of true indicates that frame rate is a fixed value rather than an upper limit, and that the video encoder shall prioritize frame rate over all other adaptable configuration values such as bitrate. Default is false.
    • 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.

    • Encoding [VideoEncoding]
      Used video codec, either Jpeg, H.264 or Mpeg4
      Enum Value Enum Description
      JPEG —
      MPEG4 —
      H264 —
    • Resolution [VideoResolution]
      Configured video resolution
      • 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.
    • Quality [float]
      Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality
    • RateControl - optional; [VideoRateControl]
      Optional element to configure rate control related parameters.
      • FrameRateLimit [int]
        Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor.
      • EncodingInterval [int]
        Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)
      • BitrateLimit [int]
        The maximum output bitrate in kbps.
    • MPEG4 - optional; [Mpeg4Configuration]
      Optional element to configure Mpeg4 related parameters.
      • GovLength [int]
        Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
      • Mpeg4Profile [Mpeg4Profile]
        the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)
        Enum Value Enum Description
        SP —
        ASP —
    • H264 - optional; [H264Configuration]
      Optional element to configure H.264 related parameters.
      • GovLength [int]
        Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
      • H264Profile [H264Profile]
        the H.264 profile, either baseline, main, extended or high
        Enum Value Enum Description
        Baseline —
        Main —
        Extended —
        High —
    • 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 video stream

GetCompatibleVideoSourceConfigurations 

GetCompatibleVideoSourceConfigurations(ProfileToken)

This operation requests all the video source configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddVideoSourceConfiguration command on the media profile. The result will vary depending on the capabilities, configurations and settings in the device.

Input
  • ProfileToken [ReferenceToken]
    Contains the token of an existing media profile the configurations shall be compatible with.
    Maximum length: 64
Output
  • Configurations - optional, unbounded; [VideoSourceConfiguration]
    Contains a list of video source configurations that are compatible with the specified media profile.
    • 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.

GetCompatibleAudioEncoderConfigurations 

GetCompatibleAudioEncoderConfigurations(ProfileToken)

This operation requests all audio encoder configurations of a device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddAudioSourceConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.

Input
  • ProfileToken [ReferenceToken]
    Contains the token of an existing media profile the configurations shall be compatible with.
    Maximum length: 64
Output
  • Configurations - optional, unbounded; [AudioEncoderConfiguration]
    Contains a list of audio encoder configurations that are compatible with the specified media profile.
    • 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.

    • 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

GetCompatibleAudioSourceConfigurations 

GetCompatibleAudioSourceConfigurations(ProfileToken)

This operation requests all audio source configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddAudioEncoderConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.

Input
  • ProfileToken [ReferenceToken]
    Contains the token of an existing media profile the configurations shall be compatible with.
    Maximum length: 64
Output
  • Configurations - optional, unbounded; [AudioSourceConfiguration]
    Contains a list of audio source configurations that are compatible with the specified media profile.
    • 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

GetCompatibleVideoAnalyticsConfigurations 

GetCompatibleVideoAnalyticsConfigurations(ProfileToken)

This operation requests all video analytic configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddVideoAnalyticsConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.

Input
  • ProfileToken [ReferenceToken]
    Contains the token of an existing media profile the configurations shall be compatible with.
    Maximum length: 64
Output
  • Configurations - optional, unbounded; [VideoAnalyticsConfiguration]
    Contains a list of video analytics configurations that are compatible with the specified media profile.
    • 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.

    • AnalyticsEngineConfiguration [AnalyticsEngineConfiguration]
      • AnalyticsModule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [AnalyticsEngineConfigurationExtension]
    • RuleEngineConfiguration [RuleEngineConfiguration]
      • Rule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [RuleEngineConfigurationExtension]

GetCompatibleMetadataConfigurations 

GetCompatibleMetadataConfigurations(ProfileToken)

This operation requests all the metadata configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddMetadataConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.

Input
  • ProfileToken [ReferenceToken]
    Contains the token of an existing media profile the configurations shall be compatible with.
    Maximum length: 64
Output
  • Configurations - optional, unbounded; [MetadataConfiguration]
    Contains a list of metadata configurations that are compatible with the specified media profile.
    • CompressionType - optional; [string]
      Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType.
    • GeoLocation - optional; [boolean]
      Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target.
    • ShapePolygon - optional; [boolean]
      Optional parameter to configure if the generated metadata stream should contain shape information as polygon.
    • SecureStreamingProtocolAlgorithm - optional; [string]
      The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms
    • 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.

    • PTZStatus - optional; [PTZFilter]
      Optional element to configure which PTZ related data is to include in the metadata stream.
      • Status [boolean]
        True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN).
      • Position [boolean]
        True if the metadata stream shall contain the PTZ position.
      • FieldOfView - optional; [boolean]
        True if the metadata stream shall contain the field-of-view information.
    • Events - optional; [EventSubscription]
      Optional element to configure the streaming of events. A client might be interested in receiving all, none or some of the events produced by the device:
      • To get all events: Include the Events element but do not include a filter.
      • To get no events: Do not include the Events element.
      • To get only some events: Include the Events element and include a filter in the element.
      • Filter - optional; [FilterType]
      • SubscriptionPolicy - optional; [complexType]
    • Analytics - optional; [boolean]
      Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)
    • 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 (when using Media2 Service, this value is deprecated and ignored)
    • AnalyticsEngineConfiguration - optional; [AnalyticsEngineConfiguration]
      Indication which AnalyticsModules shall output metadata. Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration.
      • AnalyticsModule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [AnalyticsEngineConfigurationExtension]
    • SensorData - optional; [SensorDataFilter]
      Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:
      • To get all sensor data: Include the SensorData element but do not include any filter criteria.
      • To get no sensor data: Do not include the SensorData element.
      • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
      • SensorID - optional, unbounded; [string]
        List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them).
      • Type - optional, unbounded; [string]
        List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them).
    • Extension - optional; [MetadataConfigurationExtension]

GetCompatibleAudioOutputConfigurations 

GetCompatibleAudioOutputConfigurations(ProfileToken)

This command lists all audio output configurations of a device that are compatible with a certain media profile.

Each returned configuration shall be a valid input for the AddAudioOutputConfiguration command.

Input
  • ProfileToken [ReferenceToken]
    Contains the token of an existing media profile the configurations shall be compatible with.
    Maximum length: 64
Output
  • Configurations - optional, unbounded; [AudioOutputConfiguration]
    Contains a list of audio output configurations that are compatible with the specified media profile.
    • 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.

GetCompatibleAudioDecoderConfigurations 

GetCompatibleAudioDecoderConfigurations(ProfileToken)

This operation lists all the audio decoder configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddAudioDecoderConfiguration command on the media profile.

Input
  • ProfileToken [ReferenceToken]
    Contains the token of an existing media profile the configurations shall be compatible with.
    Maximum length: 64
Output
  • Configurations - optional, unbounded; [AudioDecoderConfiguration]
    Contains a list of audio decoder configurations that are compatible with the specified media profile.
    • 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.

SetVideoSourceConfiguration 

SetVideoSourceConfiguration(
    Configuration, ForcePersistence
)

This operation modifies a video source configuration.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream. NVC methods for changing a running stream are out of scope for this specification.

Input
  • Configuration [VideoSourceConfiguration]
    Contains the modified video source configuration. The configuration shall exist in the device.
    • 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 is obsolete and should always be assumed to be true.

SetVideoEncoderConfiguration 

SetVideoEncoderConfiguration(
    Configuration, ForcePersistence
)

This operation modifies a video encoder configuration.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Changes in the Multicast settings shall always be persistent. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream. NVC methods for changing a running stream are out of scope for this specification.

SessionTimeout is provided as a hint for keeping rtsp session by a device. If necessary the device may adapt parameter values for SessionTimeout elements without returning an error. For the time between keep alive calls the client shall adhere to the timeout value signaled via RTSP.

Input
  • Configuration [VideoEncoderConfiguration]
    Contains the modified video encoder configuration. The configuration shall exist in the device.
    • GuaranteedFrameRate - optional; [boolean]
      A value of true indicates that frame rate is a fixed value rather than an upper limit, and that the video encoder shall prioritize frame rate over all other adaptable configuration values such as bitrate. Default is false.
    • 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.

    • Encoding [VideoEncoding]
      Used video codec, either Jpeg, H.264 or Mpeg4
      Enum Value Enum Description
      JPEG —
      MPEG4 —
      H264 —
    • Resolution [VideoResolution]
      Configured video resolution
      • 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.
    • Quality [float]
      Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality
    • RateControl - optional; [VideoRateControl]
      Optional element to configure rate control related parameters.
      • FrameRateLimit [int]
        Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor.
      • EncodingInterval [int]
        Interval at which images are encoded and transmitted. (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)
      • BitrateLimit [int]
        The maximum output bitrate in kbps.
    • MPEG4 - optional; [Mpeg4Configuration]
      Optional element to configure Mpeg4 related parameters.
      • GovLength [int]
        Determines the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
      • Mpeg4Profile [Mpeg4Profile]
        the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP)
        Enum Value Enum Description
        SP —
        ASP —
    • H264 - optional; [H264Configuration]
      Optional element to configure H.264 related parameters.
      • GovLength [int]
        Group of Video frames length. Determines typically the interval in which the I-Frames will be coded. An entry of 1 indicates I-Frames are continuously generated. An entry of 2 indicates that every 2nd image is an I-Frame, and 3 only every 3rd frame, etc. The frames in between are coded as P or B Frames.
      • H264Profile [H264Profile]
        the H.264 profile, either baseline, main, extended or high
        Enum Value Enum Description
        Baseline —
        Main —
        Extended —
        High —
    • 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 video stream
  • ForcePersistence [boolean]
    The ForcePersistence element is obsolete and should always be assumed to be true.

SetAudioSourceConfiguration 

SetAudioSourceConfiguration(
    Configuration, ForcePersistence
)

This operation modifies an audio source configuration.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream NVC methods for changing a running stream are out of scope for this specification.

Input
  • Configuration [AudioSourceConfiguration]
    Contains the modified audio source configuration. The configuration shall exist in the device.
    • 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 is obsolete and should always be assumed to be true.

SetAudioEncoderConfiguration 

SetAudioEncoderConfiguration(
    Configuration, ForcePersistence
)

This operation modifies an audio encoder configuration.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected streams. NVC methods for changing a running stream are out of scope for this specification.

Input
  • Configuration [AudioEncoderConfiguration]
    Contains the modified audio encoder configuration. The configuration shall exist in the device.
    • 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.

    • 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
  • ForcePersistence [boolean]
    The ForcePersistence element is obsolete and should always be assumed to be true.

SetVideoAnalyticsConfiguration 

SetVideoAnalyticsConfiguration(
    Configuration, ForcePersistence
)

A video analytics configuration is modified using this command.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device or not. Running streams using this configuration shall be immediately updated according to the new settings. Otherwise inconsistencies can occur between the scene description processed by the rule engine and the notifications produced by analytics engine and rule engine which reference the very same video analytics configuration token.

Input
  • Configuration [VideoAnalyticsConfiguration]
    Contains the modified video analytics configuration. The configuration shall exist in the device.
    • 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.

    • AnalyticsEngineConfiguration [AnalyticsEngineConfiguration]
      • AnalyticsModule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [AnalyticsEngineConfigurationExtension]
    • RuleEngineConfiguration [RuleEngineConfiguration]
      • Rule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [RuleEngineConfigurationExtension]
  • ForcePersistence [boolean]
    The ForcePersistence element is obsolete and should always be assumed to be true.

SetMetadataConfiguration 

SetMetadataConfiguration(Configuration, ForcePersistence)

This operation modifies a metadata configuration.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Changes in the Multicast settings shall always be persistent. Running streams using this configuration may be updated immediately according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected streams. NVC methods for changing a running stream are out of scope for this specification.

Input
  • Configuration [MetadataConfiguration]
    Contains the modified metadata configuration. The configuration shall exist in the device.
    • CompressionType - optional; [string]
      Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType.
    • GeoLocation - optional; [boolean]
      Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target.
    • ShapePolygon - optional; [boolean]
      Optional parameter to configure if the generated metadata stream should contain shape information as polygon.
    • SecureStreamingProtocolAlgorithm - optional; [string]
      The cryptographic algorithm used as defined by tt:SrtpSecurityAlgorithms
    • 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.

    • PTZStatus - optional; [PTZFilter]
      Optional element to configure which PTZ related data is to include in the metadata stream.
      • Status [boolean]
        True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN).
      • Position [boolean]
        True if the metadata stream shall contain the PTZ position.
      • FieldOfView - optional; [boolean]
        True if the metadata stream shall contain the field-of-view information.
    • Events - optional; [EventSubscription]
      Optional element to configure the streaming of events. A client might be interested in receiving all, none or some of the events produced by the device:
      • To get all events: Include the Events element but do not include a filter.
      • To get no events: Do not include the Events element.
      • To get only some events: Include the Events element and include a filter in the element.
      • Filter - optional; [FilterType]
      • SubscriptionPolicy - optional; [complexType]
    • Analytics - optional; [boolean]
      Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.)
    • 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 (when using Media2 Service, this value is deprecated and ignored)
    • AnalyticsEngineConfiguration - optional; [AnalyticsEngineConfiguration]
      Indication which AnalyticsModules shall output metadata. Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration.
      • AnalyticsModule - optional, unbounded; [Config]
        • Name - required; [string]
          Name of the configuration.
        • Type - required; [QName]
          The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
        • Parameters [ItemList]
          List of configuration parameters as defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
          • Name - required; [string]
            Item name.
          • SimpleItem - optional, unbounded; [complexType]
            Value name pair as defined by the corresponding description.
            • Name - required; [string]
              Item name.
            • Value - required; [anySimpleType]
              Item value. The type is defined in the corresponding description.
          • ElementItem - optional, unbounded; [complexType]
            Complex value structure.
            • Name - required; [string]
              Item name.
          • Extension - optional; [ItemListExtension]
      • Extension - optional; [AnalyticsEngineConfigurationExtension]
    • SensorData - optional; [SensorDataFilter]
      Optional element to configure which sensor data is to include in the metadata stream. A client might be interested in receiving all, none or some of the sensor data produced by the device:
      • To get all sensor data: Include the SensorData element but do not include any filter criteria.
      • To get no sensor data: Do not include the SensorData element.
      • To get only some sensor data: Include the SensorData element and specify filter criteria (SensorID list, Type list, etc.).
      • SensorID - optional, unbounded; [string]
        List of SensorID values to include in the metadata stream. If not specified or empty, all sensor IDs are included (unless other filters exclude them).
      • Type - optional, unbounded; [string]
        List of sensor Type values to include in the metadata stream. If not specified or empty, all sensor types are included (unless other filters exclude them).
    • Extension - optional; [MetadataConfigurationExtension]
  • ForcePersistence [boolean]
    The ForcePersistence element is obsolete and should always be assumed to be true.

SetAudioOutputConfiguration 

SetAudioOutputConfiguration(
    Configuration, ForcePersistence
)

This operation modifies an audio output configuration.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device.

Input
  • Configuration [AudioOutputConfiguration]
    Contains the modified audio output configuration. The configuration shall exist in the device.
    • 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 is obsolete and should always be assumed to be true.

SetAudioDecoderConfiguration 

SetAudioDecoderConfiguration(
    Configuration, ForcePersistence
)

This operation modifies an audio decoder configuration.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device.

Input
  • Configuration [AudioDecoderConfiguration]
    Contains the modified audio decoder configuration. The configuration shall exist in the device.
    • 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.

  • ForcePersistence [boolean]
    The ForcePersistence element is obsolete and should always be assumed to be true.

GetVideoSourceConfigurationOptions 

GetVideoSourceConfigurationOptions(
    ConfigurationToken=None, ProfileToken=None
)

This operation returns the available options (supported values and ranges for video source configuration parameters) when the video source parameters are reconfigured If a video source configuration is specified, the options shall concern that particular configuration.

If a media profile is specified, the options shall be compatible with that media profile.

Input
  • ConfigurationToken - optional; [ReferenceToken]
    Optional video source configurationToken that specifies an existing configuration that the options are intended for.
    Maximum length: 64
  • ProfileToken - optional; [ReferenceToken]
    Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
    Maximum length: 64
Output
  • Options [VideoSourceConfigurationOptions]
    This message contains the video source configuration options. If a video source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device.
    • 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 —

GetVideoEncoderConfigurationOptions 

GetVideoEncoderConfigurationOptions(
    ConfigurationToken=None, ProfileToken=None
)

This operation returns the available options (supported values and ranges for video encoder configuration parameters) when the video encoder parameters are reconfigured.

For JPEG, MPEG4 and H264 extension elements have been defined that provide additional information. A device must provide the XxxOption information for all encodings supported and should additionally provide the corresponding XxxOption2 information.

This response contains the available video encoder configuration options. If a video encoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device.

Input
  • ConfigurationToken - optional; [ReferenceToken]
    Optional video encoder configuration token that specifies an existing configuration that the options are intended for.
    Maximum length: 64
  • ProfileToken - optional; [ReferenceToken]
    Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
    Maximum length: 64
Output
  • Options [VideoEncoderConfigurationOptions]
    • GuaranteedFrameRateSupported - optional; [boolean]
      Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoderConfiguration element.
    • QualityRange [IntRange]
      Range of the quality values. A high value means higher quality.
      • Min [int]
      • Max [int]
    • JPEG - optional; [JpegOptions]
      Optional JPEG encoder settings ranges (See also Extension element).
      • ResolutionsAvailable - unbounded; [VideoResolution]
        List of supported image sizes.
        • 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.
      • FrameRateRange [IntRange]
        Supported frame rate in fps (frames per second).
        • Min [int]
        • Max [int]
      • EncodingIntervalRange [IntRange]
        Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of "1" means that all frames are encoded.
        • Min [int]
        • Max [int]
    • MPEG4 - optional; [Mpeg4Options]
      Optional MPEG-4 encoder settings ranges (See also Extension element).
      • ResolutionsAvailable - unbounded; [VideoResolution]
        List of supported image sizes.
        • 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.
      • GovLengthRange [IntRange]
        Supported group of Video frames length. This value typically corresponds to the I-Frame distance.
        • Min [int]
        • Max [int]
      • FrameRateRange [IntRange]
        Supported frame rate in fps (frames per second).
        • Min [int]
        • Max [int]
      • EncodingIntervalRange [IntRange]
        Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of "1" means that all frames are encoded.
        • Min [int]
        • Max [int]
      • Mpeg4ProfilesSupported - unbounded; [Mpeg4Profile]
        List of supported MPEG-4 profiles.
        Enum Value Enum Description
        SP —
        ASP —
    • H264 - optional; [H264Options]
      Optional H.264 encoder settings ranges (See also Extension element).
      • ResolutionsAvailable - unbounded; [VideoResolution]
        List of supported image sizes.
        • 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.
      • GovLengthRange [IntRange]
        Supported group of Video frames length. This value typically corresponds to the I-Frame distance.
        • Min [int]
        • Max [int]
      • FrameRateRange [IntRange]
        Supported frame rate in fps (frames per second).
        • Min [int]
        • Max [int]
      • EncodingIntervalRange [IntRange]
        Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of "1" means that all frames are encoded.
        • Min [int]
        • Max [int]
      • H264ProfilesSupported - unbounded; [H264Profile]
        List of supported H.264 profiles.
        Enum Value Enum Description
        Baseline —
        Main —
        Extended —
        High —
    • Extension - optional; [VideoEncoderOptionsExtension]
      • JPEG - optional; [JpegOptions2]
        Optional JPEG encoder settings ranges.
        • ResolutionsAvailable - unbounded; [VideoResolution]
          List of supported image sizes.
          • 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.
        • FrameRateRange [IntRange]
          Supported frame rate in fps (frames per second).
          • Min [int]
          • Max [int]
        • EncodingIntervalRange [IntRange]
          Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of "1" means that all frames are encoded.
          • Min [int]
          • Max [int]
        • BitrateRange [IntRange]
          Supported range of encoded bitrate in kbps.
          • Min [int]
          • Max [int]
      • MPEG4 - optional; [Mpeg4Options2]
        Optional MPEG-4 encoder settings ranges.
        • ResolutionsAvailable - unbounded; [VideoResolution]
          List of supported image sizes.
          • 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.
        • GovLengthRange [IntRange]
          Supported group of Video frames length. This value typically corresponds to the I-Frame distance.
          • Min [int]
          • Max [int]
        • FrameRateRange [IntRange]
          Supported frame rate in fps (frames per second).
          • Min [int]
          • Max [int]
        • EncodingIntervalRange [IntRange]
          Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of "1" means that all frames are encoded.
          • Min [int]
          • Max [int]
        • Mpeg4ProfilesSupported - unbounded; [Mpeg4Profile]
          List of supported MPEG-4 profiles.
          Enum Value Enum Description
          SP —
          ASP —
        • BitrateRange [IntRange]
          Supported range of encoded bitrate in kbps.
          • Min [int]
          • Max [int]
      • H264 - optional; [H264Options2]
        Optional H.264 encoder settings ranges.
        • ResolutionsAvailable - unbounded; [VideoResolution]
          List of supported image sizes.
          • 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.
        • GovLengthRange [IntRange]
          Supported group of Video frames length. This value typically corresponds to the I-Frame distance.
          • Min [int]
          • Max [int]
        • FrameRateRange [IntRange]
          Supported frame rate in fps (frames per second).
          • Min [int]
          • Max [int]
        • EncodingIntervalRange [IntRange]
          Supported encoding interval range. The encoding interval corresponds to the number of frames divided by the encoded frames. An encoding interval value of "1" means that all frames are encoded.
          • Min [int]
          • Max [int]
        • H264ProfilesSupported - unbounded; [H264Profile]
          List of supported H.264 profiles.
          Enum Value Enum Description
          Baseline —
          Main —
          Extended —
          High —
        • BitrateRange [IntRange]
          Supported range of encoded bitrate in kbps.
          • Min [int]
          • Max [int]
      • Extension - optional; [VideoEncoderOptionsExtension2]

GetAudioSourceConfigurationOptions 

GetAudioSourceConfigurationOptions(
    ConfigurationToken=None, ProfileToken=None
)

This operation returns the available options (supported values and ranges for audio source configuration parameters) when the audio source parameters are reconfigured.

If an audio source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile.

Input
  • ConfigurationToken - optional; [ReferenceToken]
    Optional audio source configuration token that specifies an existing configuration that the options are intended for.
    Maximum length: 64
  • ProfileToken - optional; [ReferenceToken]
    Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
    Maximum length: 64
Output
  • Options [AudioSourceConfigurationOptions]
    This message contains the audio source configuration options. If a audio source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device.
    • InputTokensAvailable - unbounded; [ReferenceToken]
      Tokens of the audio source the configuration can be used for.
      Maximum length: 64
    • Extension - optional; [AudioSourceOptionsExtension]

GetAudioEncoderConfigurationOptions 

GetAudioEncoderConfigurationOptions(
    ConfigurationToken=None, ProfileToken=None
)

This operation returns the available options (supported values and ranges for audio encoder configuration parameters) when the audio encoder parameters are reconfigured.

Input
  • ConfigurationToken - optional; [ReferenceToken]
    Optional audio encoder configuration token that specifies an existing configuration that the options are intended for.
    Maximum length: 64
  • ProfileToken - optional; [ReferenceToken]
    Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
    Maximum length: 64
Output
  • Options [AudioEncoderConfigurationOptions]
    This message contains the audio encoder configuration options. If a audio encoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device.
    • 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]

GetMetadataConfigurationOptions 

GetMetadataConfigurationOptions(
    ConfigurationToken=None, ProfileToken=None
)

This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration.

Input
  • ConfigurationToken - optional; [ReferenceToken]
    Optional metadata configuration token that specifies an existing configuration that the options are intended for.
    Maximum length: 64
  • ProfileToken - optional; [ReferenceToken]
    Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
    Maximum length: 64
Output
  • Options [MetadataConfigurationOptions]
    This message contains the metadata configuration options. If a metadata configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device.
    • GeoLocation - optional; [boolean]
      True if the device is able to stream the Geo Located positions of each target.
    • MaxContentFilterSize - optional; [int]
      A device signalling support for content filtering shall support expressions with the provided expression size.
    • SecureStreamingProtocolAlgorithms - optional; [StringAttrList]
      If secure RTSP streaming is supported, this shall return the list of supported cryptographic algorithms as defined by tt:SrtpSecurityAlgorithms.
    • PTZStatusFilterOptions [PTZStatusFilterOptions]
      • PanTiltStatusSupported [boolean]
        True if the device is able to stream pan or tilt status information.
      • ZoomStatusSupported [boolean]
        True if the device is able to stream zoom status information.
      • PanTiltPositionSupported - optional; [boolean]
        True if the device is able to stream the pan or tilt position.
      • ZoomPositionSupported - optional; [boolean]
        True if the device is able to stream zoom position information.
      • Extension - optional; [PTZStatusFilterOptionsExtension]
      • FieldOfViewSupported - optional; [boolean]
        True if the device is able to stream the field-of-view information.
    • SensorDataFilterOptions - optional; [SensorDataFilterOptions]
      Optional element indicating the sensor data filtering capabilities of the device.
      • SensorIDFilterSupported [boolean]
        True if the device supports filtering sensor data by SensorID.
      • TypeFilterSupported [boolean]
        True if the device supports filtering sensor data by Type.
    • Extension - optional; [MetadataConfigurationOptionsExtension]
      • CompressionType - optional, unbounded; [string]
        List of supported metadata compression type. Its options shall be chosen from tt:MetadataCompressionType.
      • Extension - optional; [MetadataConfigurationOptionsExtension2]

GetAudioOutputConfigurationOptions 

GetAudioOutputConfigurationOptions(
    ConfigurationToken=None, ProfileToken=None
)

This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output.

Input
  • ConfigurationToken - optional; [ReferenceToken]
    Optional audio output configuration token that specifies an existing configuration that the options are intended for.
    Maximum length: 64
  • ProfileToken - optional; [ReferenceToken]
    Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
    Maximum length: 64
Output
  • Options [AudioOutputConfigurationOptions]
    This message contains the audio output configuration options. If a audio output configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device.
    • 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.

GetAudioDecoderConfigurationOptions 

GetAudioDecoderConfigurationOptions(
    ConfigurationToken=None, ProfileToken=None
)

This command list the audio decoding capabilities for a given profile and configuration of a device.

Input
  • ConfigurationToken - optional; [ReferenceToken]
    Optional audio decoder configuration token that specifies an existing configuration that the options are intended for.
    Maximum length: 64
  • ProfileToken - optional; [ReferenceToken]
    Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
    Maximum length: 64
Output
  • Options [AudioDecoderConfigurationOptions]
    This message contains the audio decoder configuration options. If a audio decoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device.
    • 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]

GetGuaranteedNumberOfVideoEncoderInstances 

GetGuaranteedNumberOfVideoEncoderInstances(
    ConfigurationToken,
)

The GetGuaranteedNumberOfVideoEncoderInstances command can be used to request the minimum number of guaranteed video encoder instances (applications) per Video Source Configuration.

Input
  • ConfigurationToken [ReferenceToken]
    Token of the video source configuration
    Maximum length: 64
Output
  • TotalNumber [int]
    The minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration. The device is able to deliver the TotalNumber of streams
  • JPEG - optional; [int]
    If a device limits the number of instances for respective Video Codecs the response contains the information how many Jpeg streams can be set up at the same time per VideoSource.
  • H264 - optional; [int]
    If a device limits the number of instances for respective Video Codecs the response contains the information how many H264 streams can be set up at the same time per VideoSource.
  • MPEG4 - optional; [int]
    If a device limits the number of instances for respective Video Codecs the response contains the information how many Mpeg4 streams can be set up at the same time per VideoSource.

GetStreamUri 

GetStreamUri(StreamSetup, ProfileToken)

This operation requests a URI that can be used to initiate a live media stream using RTSP as the control protocol.

The returned URI shall remain valid indefinitely even if the profile is changed. The ValidUntilConnect, ValidUntilReboot and Timeout Parameter shall be set accordingly (ValidUntilConnect=false, ValidUntilReboot=false, timeout=PT0S).

The correct syntax for the StreamSetup element for these media stream setups defined in 5.1.1 of the streaming specification are as follows:

  1. RTP unicast over UDP: StreamType = "RTP_unicast", TransportProtocol = "UDP"
  2. RTP over RTSP over HTTP over TCP: StreamType = "RTP_unicast", TransportProtocol = "HTTP"
  3. RTP over RTSP over TCP: StreamType = "RTP_unicast", TransportProtocol = "RTSP"

If a multicast stream is requested at least one of VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration shall have a valid multicast setting.

For full compatibility with other ONVIF services a device should not generate Uris longer than 128 octets.

Input
  • StreamSetup [StreamSetup]
    Stream Setup that should be used with the uri.
    • Stream [StreamType]
      Defines if a multicast or unicast stream is requested.
      Enum Value Enum Description
      RTP-Unicast —
      RTP-Multicast —
    • Transport [Transport]
      • Protocol [TransportProtocol]
        Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP.
        Enum Value Enum Description
        UDP —
        TCP This value is deprecated.
        RTSP —
        HTTP —
      • Tunnel - optional; [complexType]
        Deprecated: optional element to describe further tunnel options.
  • ProfileToken [ReferenceToken]
    The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream.
    Maximum length: 64
Output
  • MediaUri [MediaUri]
    • Uri [anyURI]
      Stable Uri to be used for requesting the media stream.
    • InvalidAfterConnect [boolean]
      Indicates if the Uri is only valid until the connection is established. The value shall be set to "false".
    • InvalidAfterReboot [boolean]
      Indicates if the Uri is invalid after a reboot of the device. The value shall be set to "false".
    • Timeout [duration]
      Duration how long the Uri is valid. This parameter shall be set to PT0S to indicate that this stream URI is indefinitely valid even if the profile changes.

StartMulticastStreaming 

StartMulticastStreaming(ProfileToken)

This command starts multicast streaming using a specified media profile of a device.

Streaming continues until StopMulticastStreaming is called for the same Profile. The streaming shall continue after a reboot of the device until a StopMulticastStreaming request is received. The multicast address, port and TTL are configured in the VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration respectively.

Input
  • ProfileToken [ReferenceToken]
    Contains the token of the Profile that is used to define the multicast stream.
    Maximum length: 64

StopMulticastStreaming 

StopMulticastStreaming(ProfileToken)

This command stop multicast streaming using a specified media profile of a device.

Input
  • ProfileToken [ReferenceToken]
    Contains the token of the Profile that is used to define the multicast stream.
    Maximum length: 64

SetSynchronizationPoint 

SetSynchronizationPoint(ProfileToken)

Synchronization points allow clients to decode and correctly use all data after the synchronization point.

For example, if a video stream is configured with a large I-frame distance and a client loses a single packet, the client does not display video until the next I-frame is transmitted. In such cases, the client can request a Synchronization Point which enforces the device to add an I-Frame as soon as possible. Clients can request Synchronization Points for profiles. The device shall add synchronization points for all streams associated with this profile. Similarly, a synchronization point is used to get an update on full PTZ or event status through the metadata stream. If a video stream is associated with the profile, an I-frame shall be added to this video stream. If a PTZ metadata stream is associated to the profile, the PTZ position shall be repeated within the metadata stream.

Input
  • ProfileToken [ReferenceToken]
    Contains a Profile reference for which a Synchronization Point is requested.
    Maximum length: 64

GetSnapshotUri 

GetSnapshotUri(ProfileToken)

A client uses the GetSnapshotUri command to obtain a JPEG snapshot from the device.

The returned URI shall remain valid indefinitely even if the profile is changed. The ValidUntilConnect, ValidUntilReboot and Timeout Parameter shall be set accordingly (ValidUntilConnect=false, ValidUntilReboot=false, timeout=PT0S). The URI can be used for acquiring a JPEG image through an HTTP GET operation. The image encoding will always be JPEG regardless of the encoding setting in the media profile. The Jpeg settings (like resolution or quality) may be taken from the profile if suitable. The provided image will be updated automatically and independent from calls to GetSnapshotUri.

Input
  • ProfileToken [ReferenceToken]
    The ProfileToken element indicates the media profile to use and will define the source and dimensions of the snapshot.
    Maximum length: 64
Output
  • MediaUri [MediaUri]
    • Uri [anyURI]
      Stable Uri to be used for requesting the media stream.
    • InvalidAfterConnect [boolean]
      Indicates if the Uri is only valid until the connection is established. The value shall be set to "false".
    • InvalidAfterReboot [boolean]
      Indicates if the Uri is invalid after a reboot of the device. The value shall be set to "false".
    • Timeout [duration]
      Duration how long the Uri is valid. This parameter shall be set to PT0S to indicate that this stream URI is indefinitely valid even if the profile changes.

GetVideoSourceModes 

GetVideoSourceModes(VideoSourceToken)

A device returns the information for current video source mode and settable video source modes of specified video source.

A device that indicates a capability of VideoSourceModes shall support this command.

Input
  • VideoSourceToken [ReferenceToken]
    Contains a video source reference for which a video source mode is requested.
    Maximum length: 64
Output
  • VideoSourceModes - unbounded; [VideoSourceMode]
    Return the information for specified video source mode.
    • token - required; [ReferenceToken]
      Indicate token for video source mode.
    • Enabled - optional; [boolean]
      Indication of whether this mode is active. If active this value is true. In case of non-indication, it means as false. The value of true shall be had by only one video source mode.
    • MaxFramerate [float]
      Max frame rate in frames per second for this video source mode.
    • MaxResolution [VideoResolution]
      Max horizontal and vertical resolution for this video source mode.
      • 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.
    • Encodings [StringList]
      Indication which encodings are supported for this video source. The list may contain one or more enumeration values of tt:VideoEncoding.
    • Reboot [boolean]
      After setting the mode if a device starts to reboot this value is true. If a device change the mode without rebooting this value is false. If true, configured parameters may not be guaranteed by the device after rebooting.
    • Description - optional; [Description]
      Informative description of this video source mode. This field should be described in English.
    • Extension - optional; [VideoSourceModeExtension]

SetVideoSourceMode 

SetVideoSourceMode(VideoSourceToken, VideoSourceModeToken)

SetVideoSourceMode changes the media profile structure relating to video source for the specified video source mode.

A device that indicates a capability of VideoSourceModes shall support this command. The behavior after changing the mode is not defined in this specification.

Input
  • VideoSourceToken [ReferenceToken]
    Contains a video source reference for which a video source mode is requested.
    Maximum length: 64
  • VideoSourceModeToken [ReferenceToken]
    Indicate video source mode.
    Maximum length: 64
Output
  • Reboot [boolean]
    The response contains information about rebooting after returning response. When Reboot is set true, a device will reboot automatically after setting mode.

GetOSDs 

GetOSDs(ConfigurationToken=None)

Get the OSDs.

Input
  • ConfigurationToken - optional; [ReferenceToken]
    Token of the Video Source Configuration, which has OSDs associated with are requested. If token not exist, request all available OSDs.
    Maximum length: 64
Output
  • OSDs - optional, unbounded; [OSDConfiguration]
    This element contains a list of requested OSDs.
    • VideoSourceConfigurationToken [OSDReference]
      Reference to the video source configuration.
    • Type [OSDType]
      Type of OSD.
      Enum Value Enum Description
      Text —
      Image —
      Extended —
    • Position [OSDPosConfiguration]
      Position configuration of OSD.
      • Type [string]
        For OSD position type, following are the pre-defined:
        • UpperLeft
        • UpperRight
        • LowerLeft
        • LowerRight
        • Custom
      • Pos - optional; [Vector]
        • x - required; [float]
        • y - required; [float]
      • Extension - optional; [OSDPosConfigurationExtension]
    • TextString - optional; [OSDTextConfiguration]
      Text configuration of OSD. It shall be present when the value of Type field is Text.
      • IsPersistentText - optional; [boolean]
        This flag is applicable for Type Plain and defaults to true. When set to false the PlainText content will not be persistent across device reboots.
      • Type [string]
        The following OSD Text Type are defined:
        • Plain - The Plain type means the OSD is shown as a text string which defined in the "PlainText" item.
        • Date - The Date type means the OSD is shown as a date, format of which should be present in the "DateFormat" item.
        • Time - The Time type means the OSD is shown as a time, format of which should be present in the "TimeFormat" item.
        • DateAndTime - The DateAndTime type means the OSD is shown as date and time, format of which should be present in the "DateFormat" and the "TimeFormat" item.
      • DateFormat - optional; [string]
        List of supported OSD date formats. This element shall be present when the value of Type field has Date or DateAndTime. The following DateFormat are defined:
        • M/d/yyyy - e.g. 3/6/2013
        • MM/dd/yyyy - e.g. 03/06/2013
        • dd/MM/yyyy - e.g. 06/03/2013
        • yyyy/MM/dd - e.g. 2013/03/06
        • yyyy-MM-dd - e.g. 2013-06-03
        • dddd, MMMM dd, yyyy - e.g. Wednesday, March 06, 2013
        • MMMM dd, yyyy - e.g. March 06, 2013
        • dd MMMM, yyyy - e.g. 06 March, 2013
      • TimeFormat - optional; [string]
        List of supported OSD time formats. This element shall be present when the value of Type field has Time or DateAndTime. The following TimeFormat are defined:
        • h:mm:ss tt - e.g. 2:14:21 PM
        • hh:mm:ss tt - e.g. 02:14:21 PM
        • H:mm:ss - e.g. 14:14:21
        • HH:mm:ss - e.g. 14:14:21
      • FontSize - optional; [int]
        Font size of the text in pt.
      • FontColor - optional; [OSDColor]
        Font color of the text.
        • Transparent - optional; [int]
        • Color [Color]
          • X - required; [float]
          • Y - required; [float]
          • Z - required; [float]
          • Colorspace - optional; [anyURI]
            Acceptable values:
            • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr
              • X attribute = Y value
              • Y attribute = Cb value
              • Z attribute = Cr value
            • http://www.onvif.org/ver10/colorspace/RGB - RGB
              • X attribute = R value
              • Y attribute = G value
              • Z attribute = B value
            If the Colorspace attribute is absent and not defined on higher level, YCbCr is implied. Deprecated values:
            • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
            • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
            • http://www.onvif.org/ver10/colorspace/HSV - HSV
          • Likelihood - optional; [float]
            Likelihood that the color is correct.
      • BackgroundColor - optional; [OSDColor]
        Background color of the text.
        • Transparent - optional; [int]
        • Color [Color]
          • X - required; [float]
          • Y - required; [float]
          • Z - required; [float]
          • Colorspace - optional; [anyURI]
            Acceptable values:
            • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr
              • X attribute = Y value
              • Y attribute = Cb value
              • Z attribute = Cr value
            • http://www.onvif.org/ver10/colorspace/RGB - RGB
              • X attribute = R value
              • Y attribute = G value
              • Z attribute = B value
            If the Colorspace attribute is absent and not defined on higher level, YCbCr is implied. Deprecated values:
            • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
            • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
            • http://www.onvif.org/ver10/colorspace/HSV - HSV
          • Likelihood - optional; [float]
            Likelihood that the color is correct.
      • PlainText - optional; [string]
        The content of text to be displayed.
      • Extension - optional; [OSDTextConfigurationExtension]
    • Image - optional; [OSDImgConfiguration]
      Image configuration of OSD. It shall be present when the value of Type field is Image
      • ImgPath [anyURI]
        The URI of the image which to be displayed.
      • Extension - optional; [OSDImgConfigurationExtension]
    • Extension - optional; [OSDConfigurationExtension]

GetOSD 

GetOSD(OSDToken)

Get the OSD.

Input
  • OSDToken [ReferenceToken]
    The GetOSD command fetches the OSD configuration if the OSD token is known.
    Maximum length: 64
Output
  • OSD [OSDConfiguration]
    The requested OSD configuration.
    • VideoSourceConfigurationToken [OSDReference]
      Reference to the video source configuration.
    • Type [OSDType]
      Type of OSD.
      Enum Value Enum Description
      Text —
      Image —
      Extended —
    • Position [OSDPosConfiguration]
      Position configuration of OSD.
      • Type [string]
        For OSD position type, following are the pre-defined:
        • UpperLeft
        • UpperRight
        • LowerLeft
        • LowerRight
        • Custom
      • Pos - optional; [Vector]
        • x - required; [float]
        • y - required; [float]
      • Extension - optional; [OSDPosConfigurationExtension]
    • TextString - optional; [OSDTextConfiguration]
      Text configuration of OSD. It shall be present when the value of Type field is Text.
      • IsPersistentText - optional; [boolean]
        This flag is applicable for Type Plain and defaults to true. When set to false the PlainText content will not be persistent across device reboots.
      • Type [string]
        The following OSD Text Type are defined:
        • Plain - The Plain type means the OSD is shown as a text string which defined in the "PlainText" item.
        • Date - The Date type means the OSD is shown as a date, format of which should be present in the "DateFormat" item.
        • Time - The Time type means the OSD is shown as a time, format of which should be present in the "TimeFormat" item.
        • DateAndTime - The DateAndTime type means the OSD is shown as date and time, format of which should be present in the "DateFormat" and the "TimeFormat" item.
      • DateFormat - optional; [string]
        List of supported OSD date formats. This element shall be present when the value of Type field has Date or DateAndTime. The following DateFormat are defined:
        • M/d/yyyy - e.g. 3/6/2013
        • MM/dd/yyyy - e.g. 03/06/2013
        • dd/MM/yyyy - e.g. 06/03/2013
        • yyyy/MM/dd - e.g. 2013/03/06
        • yyyy-MM-dd - e.g. 2013-06-03
        • dddd, MMMM dd, yyyy - e.g. Wednesday, March 06, 2013
        • MMMM dd, yyyy - e.g. March 06, 2013
        • dd MMMM, yyyy - e.g. 06 March, 2013
      • TimeFormat - optional; [string]
        List of supported OSD time formats. This element shall be present when the value of Type field has Time or DateAndTime. The following TimeFormat are defined:
        • h:mm:ss tt - e.g. 2:14:21 PM
        • hh:mm:ss tt - e.g. 02:14:21 PM
        • H:mm:ss - e.g. 14:14:21
        • HH:mm:ss - e.g. 14:14:21
      • FontSize - optional; [int]
        Font size of the text in pt.
      • FontColor - optional; [OSDColor]
        Font color of the text.
        • Transparent - optional; [int]
        • Color [Color]
          • X - required; [float]
          • Y - required; [float]
          • Z - required; [float]
          • Colorspace - optional; [anyURI]
            Acceptable values:
            • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr
              • X attribute = Y value
              • Y attribute = Cb value
              • Z attribute = Cr value
            • http://www.onvif.org/ver10/colorspace/RGB - RGB
              • X attribute = R value
              • Y attribute = G value
              • Z attribute = B value
            If the Colorspace attribute is absent and not defined on higher level, YCbCr is implied. Deprecated values:
            • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
            • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
            • http://www.onvif.org/ver10/colorspace/HSV - HSV
          • Likelihood - optional; [float]
            Likelihood that the color is correct.
      • BackgroundColor - optional; [OSDColor]
        Background color of the text.
        • Transparent - optional; [int]
        • Color [Color]
          • X - required; [float]
          • Y - required; [float]
          • Z - required; [float]
          • Colorspace - optional; [anyURI]
            Acceptable values:
            • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr
              • X attribute = Y value
              • Y attribute = Cb value
              • Z attribute = Cr value
            • http://www.onvif.org/ver10/colorspace/RGB - RGB
              • X attribute = R value
              • Y attribute = G value
              • Z attribute = B value
            If the Colorspace attribute is absent and not defined on higher level, YCbCr is implied. Deprecated values:
            • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
            • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
            • http://www.onvif.org/ver10/colorspace/HSV - HSV
          • Likelihood - optional; [float]
            Likelihood that the color is correct.
      • PlainText - optional; [string]
        The content of text to be displayed.
      • Extension - optional; [OSDTextConfigurationExtension]
    • Image - optional; [OSDImgConfiguration]
      Image configuration of OSD. It shall be present when the value of Type field is Image
      • ImgPath [anyURI]
        The URI of the image which to be displayed.
      • Extension - optional; [OSDImgConfigurationExtension]
    • Extension - optional; [OSDConfigurationExtension]

GetOSDOptions 

GetOSDOptions(ConfigurationToken)

Get the OSD Options.

Input
  • ConfigurationToken [ReferenceToken]
    Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with.
    Maximum length: 64
Output
  • OSDOptions [OSDConfigurationOptions]
    • MaximumNumberOfOSDs [MaximumNumberOfOSDs]
      The maximum number of OSD configurations supported for the specified video source configuration. If the configuration does not support OSDs, this value shall be zero and the Type and PositionOption elements are ignored. If a device limits the number of instances by OSDType, it shall indicate the supported number for each type via the related attribute.
      • Total - required; [int]
      • Image - optional; [int]
      • PlainText - optional; [int]
      • Date - optional; [int]
      • Time - optional; [int]
      • DateAndTime - optional; [int]
    • Type - unbounded; [OSDType]
      List supported type of OSD configuration. When a device indicates the supported number for each types in MaximumNumberOfOSDs, related type shall be presented. A device shall return Option element relating to listed type.
      Enum Value Enum Description
      Text —
      Image —
      Extended —
    • PositionOption - unbounded; [string]
      List available OSD position type. Following are the pre-defined:
      • UpperLeft
      • UpperRight
      • LowerLeft
      • LowerRight
      • Custom
    • TextOption - optional; [OSDTextOptions]
      Option of the OSD text configuration. This element shall be returned if the device is signaling the support for Text.
      • Type - unbounded; [string]
        List of supported OSD text type. When a device indicates the supported number relating to Text type in MaximumNumberOfOSDs, the type shall be presented.
      • FontSizeRange - optional; [IntRange]
        Range of the font size value.
        • Min [int]
        • Max [int]
      • DateFormat - optional, unbounded; [string]
        List of supported date format.
      • TimeFormat - optional, unbounded; [string]
        List of supported time format.
      • FontColor - optional; [OSDColorOptions]
        List of supported font color.
        • Color - optional; [ColorOptions]
          Optional list of supported colors.
          • ColorList - unbounded; [Color]
            List the supported color.
            • X - required; [float]
            • Y - required; [float]
            • Z - required; [float]
            • Colorspace - optional; [anyURI]
              Acceptable values:
              • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr
                • X attribute = Y value
                • Y attribute = Cb value
                • Z attribute = Cr value
              • http://www.onvif.org/ver10/colorspace/RGB - RGB
                • X attribute = R value
                • Y attribute = G value
                • Z attribute = B value
              If the Colorspace attribute is absent and not defined on higher level, YCbCr is implied. Deprecated values:
              • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
              • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
              • http://www.onvif.org/ver10/colorspace/HSV - HSV
            • Likelihood - optional; [float]
              Likelihood that the color is correct.
          • ColorspaceRange - unbounded; [ColorspaceRange]
            Define the range of color supported.
            • X [FloatRange]
              • Min [float]
              • Max [float]
            • Y [FloatRange]
              • Min [float]
              • Max [float]
            • Z [FloatRange]
              • Min [float]
              • Max [float]
            • Colorspace [anyURI]
              Acceptable values are the same as in tt:Color.
        • Transparent - optional; [IntRange]
          Range of the transparent level. Larger means more transparent.
          • Min [int]
          • Max [int]
        • Extension - optional; [OSDColorOptionsExtension]
      • BackgroundColor - optional; [OSDColorOptions]
        List of supported background color.
        • Color - optional; [ColorOptions]
          Optional list of supported colors.
          • ColorList - unbounded; [Color]
            List the supported color.
            • X - required; [float]
            • Y - required; [float]
            • Z - required; [float]
            • Colorspace - optional; [anyURI]
              Acceptable values:
              • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr
                • X attribute = Y value
                • Y attribute = Cb value
                • Z attribute = Cr value
              • http://www.onvif.org/ver10/colorspace/RGB - RGB
                • X attribute = R value
                • Y attribute = G value
                • Z attribute = B value
              If the Colorspace attribute is absent and not defined on higher level, YCbCr is implied. Deprecated values:
              • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
              • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
              • http://www.onvif.org/ver10/colorspace/HSV - HSV
            • Likelihood - optional; [float]
              Likelihood that the color is correct.
          • ColorspaceRange - unbounded; [ColorspaceRange]
            Define the range of color supported.
            • X [FloatRange]
              • Min [float]
              • Max [float]
            • Y [FloatRange]
              • Min [float]
              • Max [float]
            • Z [FloatRange]
              • Min [float]
              • Max [float]
            • Colorspace [anyURI]
              Acceptable values are the same as in tt:Color.
        • Transparent - optional; [IntRange]
          Range of the transparent level. Larger means more transparent.
          • Min [int]
          • Max [int]
        • Extension - optional; [OSDColorOptionsExtension]
      • Extension - optional; [OSDTextOptionsExtension]
    • ImageOption - optional; [OSDImgOptions]
      Option of the OSD image configuration. This element shall be returned if the device is signaling the support for Image.
      • FormatsSupported - optional; [StringAttrList]
        List of supported image MIME types, such as "image/png".
      • MaxSize - optional; [int]
        The maximum size (in bytes) of the image that can be uploaded.
      • MaxWidth - optional; [int]
        The maximum width (in pixels) of the image that can be uploaded.
      • MaxHeight - optional; [int]
        The maximum height (in pixels) of the image that can be uploaded.
      • ImagePath - unbounded; [anyURI]
        List of available image URIs.
      • Extension - optional; [OSDImgOptionsExtension]
    • Extension - optional; [OSDConfigurationOptionsExtension]

SetOSD 

SetOSD(OSD)

Set the OSD.

Input
  • OSD [OSDConfiguration]
    Contains the modified OSD configuration.
    • VideoSourceConfigurationToken [OSDReference]
      Reference to the video source configuration.
    • Type [OSDType]
      Type of OSD.
      Enum Value Enum Description
      Text —
      Image —
      Extended —
    • Position [OSDPosConfiguration]
      Position configuration of OSD.
      • Type [string]
        For OSD position type, following are the pre-defined:
        • UpperLeft
        • UpperRight
        • LowerLeft
        • LowerRight
        • Custom
      • Pos - optional; [Vector]
        • x - required; [float]
        • y - required; [float]
      • Extension - optional; [OSDPosConfigurationExtension]
    • TextString - optional; [OSDTextConfiguration]
      Text configuration of OSD. It shall be present when the value of Type field is Text.
      • IsPersistentText - optional; [boolean]
        This flag is applicable for Type Plain and defaults to true. When set to false the PlainText content will not be persistent across device reboots.
      • Type [string]
        The following OSD Text Type are defined:
        • Plain - The Plain type means the OSD is shown as a text string which defined in the "PlainText" item.
        • Date - The Date type means the OSD is shown as a date, format of which should be present in the "DateFormat" item.
        • Time - The Time type means the OSD is shown as a time, format of which should be present in the "TimeFormat" item.
        • DateAndTime - The DateAndTime type means the OSD is shown as date and time, format of which should be present in the "DateFormat" and the "TimeFormat" item.
      • DateFormat - optional; [string]
        List of supported OSD date formats. This element shall be present when the value of Type field has Date or DateAndTime. The following DateFormat are defined:
        • M/d/yyyy - e.g. 3/6/2013
        • MM/dd/yyyy - e.g. 03/06/2013
        • dd/MM/yyyy - e.g. 06/03/2013
        • yyyy/MM/dd - e.g. 2013/03/06
        • yyyy-MM-dd - e.g. 2013-06-03
        • dddd, MMMM dd, yyyy - e.g. Wednesday, March 06, 2013
        • MMMM dd, yyyy - e.g. March 06, 2013
        • dd MMMM, yyyy - e.g. 06 March, 2013
      • TimeFormat - optional; [string]
        List of supported OSD time formats. This element shall be present when the value of Type field has Time or DateAndTime. The following TimeFormat are defined:
        • h:mm:ss tt - e.g. 2:14:21 PM
        • hh:mm:ss tt - e.g. 02:14:21 PM
        • H:mm:ss - e.g. 14:14:21
        • HH:mm:ss - e.g. 14:14:21
      • FontSize - optional; [int]
        Font size of the text in pt.
      • FontColor - optional; [OSDColor]
        Font color of the text.
        • Transparent - optional; [int]
        • Color [Color]
          • X - required; [float]
          • Y - required; [float]
          • Z - required; [float]
          • Colorspace - optional; [anyURI]
            Acceptable values:
            • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr
              • X attribute = Y value
              • Y attribute = Cb value
              • Z attribute = Cr value
            • http://www.onvif.org/ver10/colorspace/RGB - RGB
              • X attribute = R value
              • Y attribute = G value
              • Z attribute = B value
            If the Colorspace attribute is absent and not defined on higher level, YCbCr is implied. Deprecated values:
            • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
            • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
            • http://www.onvif.org/ver10/colorspace/HSV - HSV
          • Likelihood - optional; [float]
            Likelihood that the color is correct.
      • BackgroundColor - optional; [OSDColor]
        Background color of the text.
        • Transparent - optional; [int]
        • Color [Color]
          • X - required; [float]
          • Y - required; [float]
          • Z - required; [float]
          • Colorspace - optional; [anyURI]
            Acceptable values:
            • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr
              • X attribute = Y value
              • Y attribute = Cb value
              • Z attribute = Cr value
            • http://www.onvif.org/ver10/colorspace/RGB - RGB
              • X attribute = R value
              • Y attribute = G value
              • Z attribute = B value
            If the Colorspace attribute is absent and not defined on higher level, YCbCr is implied. Deprecated values:
            • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
            • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
            • http://www.onvif.org/ver10/colorspace/HSV - HSV
          • Likelihood - optional; [float]
            Likelihood that the color is correct.
      • PlainText - optional; [string]
        The content of text to be displayed.
      • Extension - optional; [OSDTextConfigurationExtension]
    • Image - optional; [OSDImgConfiguration]
      Image configuration of OSD. It shall be present when the value of Type field is Image
      • ImgPath [anyURI]
        The URI of the image which to be displayed.
      • Extension - optional; [OSDImgConfigurationExtension]
    • Extension - optional; [OSDConfigurationExtension]

CreateOSD 

CreateOSD(OSD)

Create the OSD.

Input
  • OSD [OSDConfiguration]
    Contain the initial OSD configuration for create.
    • VideoSourceConfigurationToken [OSDReference]
      Reference to the video source configuration.
    • Type [OSDType]
      Type of OSD.
      Enum Value Enum Description
      Text —
      Image —
      Extended —
    • Position [OSDPosConfiguration]
      Position configuration of OSD.
      • Type [string]
        For OSD position type, following are the pre-defined:
        • UpperLeft
        • UpperRight
        • LowerLeft
        • LowerRight
        • Custom
      • Pos - optional; [Vector]
        • x - required; [float]
        • y - required; [float]
      • Extension - optional; [OSDPosConfigurationExtension]
    • TextString - optional; [OSDTextConfiguration]
      Text configuration of OSD. It shall be present when the value of Type field is Text.
      • IsPersistentText - optional; [boolean]
        This flag is applicable for Type Plain and defaults to true. When set to false the PlainText content will not be persistent across device reboots.
      • Type [string]
        The following OSD Text Type are defined:
        • Plain - The Plain type means the OSD is shown as a text string which defined in the "PlainText" item.
        • Date - The Date type means the OSD is shown as a date, format of which should be present in the "DateFormat" item.
        • Time - The Time type means the OSD is shown as a time, format of which should be present in the "TimeFormat" item.
        • DateAndTime - The DateAndTime type means the OSD is shown as date and time, format of which should be present in the "DateFormat" and the "TimeFormat" item.
      • DateFormat - optional; [string]
        List of supported OSD date formats. This element shall be present when the value of Type field has Date or DateAndTime. The following DateFormat are defined:
        • M/d/yyyy - e.g. 3/6/2013
        • MM/dd/yyyy - e.g. 03/06/2013
        • dd/MM/yyyy - e.g. 06/03/2013
        • yyyy/MM/dd - e.g. 2013/03/06
        • yyyy-MM-dd - e.g. 2013-06-03
        • dddd, MMMM dd, yyyy - e.g. Wednesday, March 06, 2013
        • MMMM dd, yyyy - e.g. March 06, 2013
        • dd MMMM, yyyy - e.g. 06 March, 2013
      • TimeFormat - optional; [string]
        List of supported OSD time formats. This element shall be present when the value of Type field has Time or DateAndTime. The following TimeFormat are defined:
        • h:mm:ss tt - e.g. 2:14:21 PM
        • hh:mm:ss tt - e.g. 02:14:21 PM
        • H:mm:ss - e.g. 14:14:21
        • HH:mm:ss - e.g. 14:14:21
      • FontSize - optional; [int]
        Font size of the text in pt.
      • FontColor - optional; [OSDColor]
        Font color of the text.
        • Transparent - optional; [int]
        • Color [Color]
          • X - required; [float]
          • Y - required; [float]
          • Z - required; [float]
          • Colorspace - optional; [anyURI]
            Acceptable values:
            • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr
              • X attribute = Y value
              • Y attribute = Cb value
              • Z attribute = Cr value
            • http://www.onvif.org/ver10/colorspace/RGB - RGB
              • X attribute = R value
              • Y attribute = G value
              • Z attribute = B value
            If the Colorspace attribute is absent and not defined on higher level, YCbCr is implied. Deprecated values:
            • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
            • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
            • http://www.onvif.org/ver10/colorspace/HSV - HSV
          • Likelihood - optional; [float]
            Likelihood that the color is correct.
      • BackgroundColor - optional; [OSDColor]
        Background color of the text.
        • Transparent - optional; [int]
        • Color [Color]
          • X - required; [float]
          • Y - required; [float]
          • Z - required; [float]
          • Colorspace - optional; [anyURI]
            Acceptable values:
            • http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr
              • X attribute = Y value
              • Y attribute = Cb value
              • Z attribute = Cr value
            • http://www.onvif.org/ver10/colorspace/RGB - RGB
              • X attribute = R value
              • Y attribute = G value
              • Z attribute = B value
            If the Colorspace attribute is absent and not defined on higher level, YCbCr is implied. Deprecated values:
            • http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV
            • http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)
            • http://www.onvif.org/ver10/colorspace/HSV - HSV
          • Likelihood - optional; [float]
            Likelihood that the color is correct.
      • PlainText - optional; [string]
        The content of text to be displayed.
      • Extension - optional; [OSDTextConfigurationExtension]
    • Image - optional; [OSDImgConfiguration]
      Image configuration of OSD. It shall be present when the value of Type field is Image
      • ImgPath [anyURI]
        The URI of the image which to be displayed.
      • Extension - optional; [OSDImgConfigurationExtension]
    • Extension - optional; [OSDConfigurationExtension]
Output
  • OSDToken [ReferenceToken]
    Returns Token of the newly created OSD
    Maximum length: 64

DeleteOSD 

DeleteOSD(OSDToken)

Delete the OSD.

Input
  • OSDToken [ReferenceToken]
    This element contains a reference to the OSD configuration that should be deleted.
    Maximum length: 64