Skip to content

AnalyticsDevice

AnalyticsDevice service implementation.

AnalyticsDevice

Bases: ONVIFService

0.0.1 2.0

The AnalyticsDevice service (AnalyticsDeviceBinding) aka 'Video Analytics Device' has been marked as obsolete since ONVIF 18.12.

Its functionality has largely been merged into the Analytics service and, in some cases Media/Media2.

This class is kept here only for backward compatibility with older devices (pre-2019) that may still expose an AnalyticsDevice XAddr.

In modern ONVIF-compliant devices, you should prefer using the Analytics or Media/Media2 services. If the device does not list AnalyticsDevice in GetServices response, then this service is not available on the device and calling this class will result in SOAP faults.

Property Details
First introduced ONVIF 2.0 (November 2010)
Deprecated ONVIF 18.12 (December 2018)
Binding name AnalyticsDeviceBinding (ver10/analyticsdevice.wsdl)
Successor Analytics Service (ver20/analytics/wsdl/analytics.wsdl)
Operations analyticsdevice.wsdl
Spec Video Analytics Device

GetServiceCapabilities 

GetServiceCapabilities()

Returns the capabilities of the analytics device service.

The result is returned in a typed answer.

Output
  • Capabilities [Capabilities]
    The capabilities for the analytics device service is returned in the Capabilities element.

DeleteAnalyticsEngineControl 

DeleteAnalyticsEngineControl(ConfigurationToken)

DeleteAnalyticsEngineControl shall delete a control object .

Input
  • ConfigurationToken [ReferenceToken]
    Token of the Analytics Engine Control configuration to be deleted.
    Maximum length: 64

CreateAnalyticsEngineControl 

CreateAnalyticsEngineControl(Configuration)

CreateAnalyticsEngineControl shall create a new control object.

Input
  • Configuration [AnalyticsEngineControl]
    Settings of the Analytics Engine Control configuration to be created. Mode shall be set to "idle".
    • 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.

    • EngineToken [ReferenceToken]
      Token of the analytics engine (AnalyticsEngine) being controlled.
      Maximum length: 64
    • EngineConfigToken [ReferenceToken]
      Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect.
      Maximum length: 64
    • InputToken - unbounded; [ReferenceToken]
      Tokens of the input (AnalyticsEngineInput) configuration applied.
      Maximum length: 64
    • ReceiverToken - unbounded; [ReferenceToken]
      Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken.
      Maximum length: 64
    • Multicast - optional; [MulticastConfiguration]
      • 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.
    • Subscription [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]
    • Mode [ModeOfOperation]
      Enum Value Enum Description
      Idle —
      Active —
      Unknown This case should never happen.
Output
  • Configuration - unbounded; [AnalyticsEngineInput]
    Configuration containing token generated.
    • 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.

    • SourceIdentification [SourceIdentification]
      • Name [string]
      • Token - unbounded; [ReferenceToken]
        Maximum length: 64
      • Extension - optional; [SourceIdentificationExtension]
    • VideoInput [VideoEncoderConfiguration]
      • 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
    • MetadataInput [MetadataInput]
      • MetadataConfig - 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; [MetadataInputExtension]

SetAnalyticsEngineControl 

SetAnalyticsEngineControl(Configuration, ForcePersistence)

This command modifies the AnalyticsEngineControl configuration.

Input
  • Configuration [AnalyticsEngineControl]
    Contains the modified Analytics Engine Control 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.

    • EngineToken [ReferenceToken]
      Token of the analytics engine (AnalyticsEngine) being controlled.
      Maximum length: 64
    • EngineConfigToken [ReferenceToken]
      Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect.
      Maximum length: 64
    • InputToken - unbounded; [ReferenceToken]
      Tokens of the input (AnalyticsEngineInput) configuration applied.
      Maximum length: 64
    • ReceiverToken - unbounded; [ReferenceToken]
      Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken.
      Maximum length: 64
    • Multicast - optional; [MulticastConfiguration]
      • 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.
    • Subscription [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]
    • Mode [ModeOfOperation]
      Enum Value Enum Description
      Idle —
      Active —
      Unknown This case should never happen.
  • ForcePersistence [boolean]

GetAnalyticsEngineControl 

GetAnalyticsEngineControl(ConfigurationToken)

The GetAnalyticsEngineControl command fetches the analytics engine control if the analytics engine control token is known.

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

    • EngineToken [ReferenceToken]
      Token of the analytics engine (AnalyticsEngine) being controlled.
      Maximum length: 64
    • EngineConfigToken [ReferenceToken]
      Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect.
      Maximum length: 64
    • InputToken - unbounded; [ReferenceToken]
      Tokens of the input (AnalyticsEngineInput) configuration applied.
      Maximum length: 64
    • ReceiverToken - unbounded; [ReferenceToken]
      Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken.
      Maximum length: 64
    • Multicast - optional; [MulticastConfiguration]
      • 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.
    • Subscription [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]
    • Mode [ModeOfOperation]
      Enum Value Enum Description
      Idle —
      Active —
      Unknown This case should never happen.

GetAnalyticsEngineControls 

GetAnalyticsEngineControls()

This operation lists all available analytics engine controls for the device.

Output
  • AnalyticsEngineControls - unbounded; [AnalyticsEngineControl]
    List of available AnalyticsEngineControl 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.

    • EngineToken [ReferenceToken]
      Token of the analytics engine (AnalyticsEngine) being controlled.
      Maximum length: 64
    • EngineConfigToken [ReferenceToken]
      Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect.
      Maximum length: 64
    • InputToken - unbounded; [ReferenceToken]
      Tokens of the input (AnalyticsEngineInput) configuration applied.
      Maximum length: 64
    • ReceiverToken - unbounded; [ReferenceToken]
      Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken.
      Maximum length: 64
    • Multicast - optional; [MulticastConfiguration]
      • 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.
    • Subscription [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]
    • Mode [ModeOfOperation]
      Enum Value Enum Description
      Idle —
      Active —
      Unknown This case should never happen.

GetAnalyticsEngine 

GetAnalyticsEngine(ConfigurationToken)

The GetAnalyticsEngine command fetches the analytics engine configuration if the token is known.

Input
  • ConfigurationToken [ReferenceToken]
    Token of the requested AnalyticsEngine configuration.
    Maximum length: 64
Output
  • Configuration [AnalyticsEngine]
    Configuration of the AnalyticsEngine.
    • 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 [AnalyticsDeviceEngineConfiguration]
      • EngineConfiguration - unbounded; [EngineConfiguration]
        • VideoAnalyticsConfiguration [VideoAnalyticsConfiguration]
          • 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]
        • AnalyticsEngineInputInfo [AnalyticsEngineInputInfo]
          • InputInfo - optional; [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; [AnalyticsEngineInputInfoExtension]
      • Extension - optional; [AnalyticsDeviceEngineConfigurationExtension]

GetAnalyticsEngines 

GetAnalyticsEngines()

This operation lists all available analytics engine configurations for the device.

Output
  • Configuration - unbounded; [AnalyticsEngine]
    List of available AnalyticsEngine 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 [AnalyticsDeviceEngineConfiguration]
      • EngineConfiguration - unbounded; [EngineConfiguration]
        • VideoAnalyticsConfiguration [VideoAnalyticsConfiguration]
          • 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]
        • AnalyticsEngineInputInfo [AnalyticsEngineInputInfo]
          • InputInfo - optional; [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; [AnalyticsEngineInputInfoExtension]
      • Extension - optional; [AnalyticsDeviceEngineConfigurationExtension]

SetVideoAnalyticsConfiguration 

SetVideoAnalyticsConfiguration(
    Configuration, ForcePersistence
)

A video analytics configuration is modified using this command.

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]

SetAnalyticsEngineInput 

SetAnalyticsEngineInput(Configuration, ForcePersistence)

This command modifies the analytics engine input configuration.

Input
  • Configuration [AnalyticsEngineInput]
    Contains the modified Analytics Engine Input 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.

    • SourceIdentification [SourceIdentification]
      • Name [string]
      • Token - unbounded; [ReferenceToken]
        Maximum length: 64
      • Extension - optional; [SourceIdentificationExtension]
    • VideoInput [VideoEncoderConfiguration]
      • 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
    • MetadataInput [MetadataInput]
      • MetadataConfig - 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; [MetadataInputExtension]
  • ForcePersistence [boolean]

GetAnalyticsEngineInput 

GetAnalyticsEngineInput(ConfigurationToken)

The GetAnalyticsEngineInput command fetches the input configuration if the analytics engine input configuration token is known.

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

    • SourceIdentification [SourceIdentification]
      • Name [string]
      • Token - unbounded; [ReferenceToken]
        Maximum length: 64
      • Extension - optional; [SourceIdentificationExtension]
    • VideoInput [VideoEncoderConfiguration]
      • 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
    • MetadataInput [MetadataInput]
      • MetadataConfig - 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; [MetadataInputExtension]

GetAnalyticsEngineInputs 

GetAnalyticsEngineInputs()

This operation lists all available analytics engine input configurations for the device.

Output
  • Configuration - unbounded; [AnalyticsEngineInput]
    List of available AnalyticsEngineInput 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.

    • SourceIdentification [SourceIdentification]
      • Name [string]
      • Token - unbounded; [ReferenceToken]
        Maximum length: 64
      • Extension - optional; [SourceIdentificationExtension]
    • VideoInput [VideoEncoderConfiguration]
      • 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
    • MetadataInput [MetadataInput]
      • MetadataConfig - 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; [MetadataInputExtension]

GetAnalyticsDeviceStreamUri 

GetAnalyticsDeviceStreamUri(
    StreamSetup, AnalyticsEngineControlToken
)

This operation requests a URI that can be used to initiate a live stream using RTSP as the control protocol if the token of the AnalyticsEngineControl is known.

Input
  • StreamSetup [StreamSetup]
    Configuration of the URI requested.
    • 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.
  • AnalyticsEngineControlToken [ReferenceToken]
    Token of the AnalyticsEngineControl whose URI is requested.
    Maximum length: 64
Output
  • Uri [anyURI]
    Streaming URI.

GetVideoAnalyticsConfiguration 

GetVideoAnalyticsConfiguration(ConfigurationToken)

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

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

CreateAnalyticsEngineInputs 

CreateAnalyticsEngineInputs(
    Configuration, ForcePersistence
)

This command generates one or more analytics engine input configurations.

Input
  • Configuration - unbounded; [AnalyticsEngineInput]
    Settings of the configurations to be created.
    • 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.

    • SourceIdentification [SourceIdentification]
      • Name [string]
      • Token - unbounded; [ReferenceToken]
        Maximum length: 64
      • Extension - optional; [SourceIdentificationExtension]
    • VideoInput [VideoEncoderConfiguration]
      • 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
    • MetadataInput [MetadataInput]
      • MetadataConfig - 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; [MetadataInputExtension]
  • ForcePersistence - unbounded; [boolean]
Output
  • Configuration - unbounded; [AnalyticsEngineInput]
    Configurations containing token generated.
    • 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.

    • SourceIdentification [SourceIdentification]
      • Name [string]
      • Token - unbounded; [ReferenceToken]
        Maximum length: 64
      • Extension - optional; [SourceIdentificationExtension]
    • VideoInput [VideoEncoderConfiguration]
      • 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
    • MetadataInput [MetadataInput]
      • MetadataConfig - 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; [MetadataInputExtension]

DeleteAnalyticsEngineInputs 

DeleteAnalyticsEngineInputs(ConfigurationToken)

This command deletes analytics engine input configurations if the tokens are known.

Input
  • ConfigurationToken - unbounded; [ReferenceToken]
    LIst of tokens of Analytics Engine Input configurations to be deleted.
    Maximum length: 64

GetAnalyticsState 

GetAnalyticsState(AnalyticsEngineControlToken)

GetAnalyticsState returns status information of the referenced AnalyticsEngineControl object.

Input
  • AnalyticsEngineControlToken [ReferenceToken]
    Token of the AnalyticsEngineControl whose state information is requested.
    Maximum length: 64
Output
  • State [AnalyticsStateInformation]
    Current status information.
    • AnalyticsEngineControlToken [ReferenceToken]
      Token of the control object whose status is requested.
      Maximum length: 64
    • State [AnalyticsState]
      • Error - optional; [string]
      • State [string]