Media2

Media2 service implementation.

Media2

Bases: ONVIFService

0.0.1 2.6.1

Media2 service client.

Property	Details
First introduced	ONVIF 2.6.1 (December 2015)
Binding name	`Media2Binding` (`ver20/media/wsdl/media.wsdl`)
Operations	media.wsdl
Spec	Media2
Data Format	Streaming

GetServiceCapabilities

GetServiceCapabilities()

Returns the capabilities of the media service.

The result is returned in a typed answer.

Output

Capabilities [Capabilities2]

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.
- Mask - optional; [boolean]
  
  Indicates if Masking is supported.
- SourceMask - optional; [boolean]
  
  Indicates that privacy masks are only supported at the video source level and not the video source configuration level. If this is true any addition, deletion or change of a privacy mask done for one video source configuration will automatically be applied by the device to a corresponding privacy mask for all other video source configuration associated with the same video source.
- WebRTC - optional; [int]
  
  Indicates number of supported WebRTC configurations.
- WebRTC_codecs - optional; [StringList]
  
  List of supported video and audio media types as defined by IANA. E.g. "video/H264 audio/opus".
- ProfileCapabilities [ProfileCapabilities]
  
  Media profile capabilities.
  - MaximumNumberOfProfiles - optional; [int]
    
    Maximum number of profiles supported.
  - ConfigurationsSupported - optional; [StringAttrList]
    
    The configurations supported by the device as defined by tr2:ConfigurationEnumeration. The enumeration value "All" shall not be included in this list.
- StreamingCapabilities [StreamingCapabilities]
  
  Streaming capabilities.
  - RTSPStreaming - optional; [boolean]
    
    Indicates support for live media streaming via RTSP.
  - RTPMulticast - optional; [boolean]
    
    Indicates support for RTP multicast.
  - RTP_RTSP_TCP - optional; [boolean]
    
    Indicates support for RTP/RTSP/TCP.
  - NonAggregateControl - optional; [boolean]
    
    Indicates support for non aggregate RTSP control.
  - RTSPWebSocketUri - optional; [anyURI]
    
    If streaming over WebSocket is supported, this shall return the RTSP WebSocket URI as described in Streaming Specification Section 5.1.1.5.
  - AutoStartMulticast - optional; [boolean]
    
    Indicates support for non-RTSP controlled multicast streaming.
  - SecureRTSPStreaming - optional; [boolean]
    
    Indicates support for live media streaming via RTSPS and SRTP.
- AudioClipCapabilities - optional; [AudioClipCapabilities]
  
  Audio clip capabilities.
  - MaxAudioClipLimit - optional; [int]
    
    Indicates the maximum number of audio clips that can be uploaded to the device.
  - MaxAudioClipSize - optional; [float]
    
    Indicates the maximum size of the audio clip that can be uploaded, in KB.
  - SupportedAudioClipFormat - optional; [StringAttrList]
    
    Enumerates the supported audio clip formats. See tr2: SupportedAudioClipFormat.
  - TTSCapabilities - optional; [TTSCapabilities]
    
    Indicates device has TTS capability.
    
    MaxContentLength - optional; [int]
    
    Indicates the maximum length of content of a text for device to convert to an audio clip.
    
    TTSLanguage - optional; [StringAttrList]
    
    List of supported languages. Uses ISO 639-1 alpha-2 language codes, such as"en" for English. See Codes for the Representation of Names of Languages. Optionally combined with ISO 3166-1 alpha-2 country codes using the "language-country" format to specify regional variations, such as"en-US" for American English. For country codes, see ISO 3166-1 Country Codes.
    
    TTSVoiceType - optional; [StringAttrList]
    
    List of supported voice types. See tr2: TTSVoiceType.
- MulticastAudioDecoderCapabilities - optional; [MulticastAudioDecoderCapabilities]
  
  MulticastAudioDecoder capabilities.
  - MulticastAudioDecoder - optional; [boolean]
    
    Indicates support for multicast audio decoder.
  - SRTP - optional; [boolean]
    
    Indicates whether the SRTP is supported in MulticastAudioDecoder or not.
  - IPv6 - optional; [boolean]
    
    Indicates whether the IPv6 is supported in MulticastAudioDecoder or not.

CreateProfile

CreateProfile(Name, Configuration=None)

This operation creates a new media profile.

A created profile created via this method may be deleted via the DeleteProfile method. Optionally Configurations can be assigned to the profile on creation.

For details regarding profile assignment check also the method AddConfiguration.

Input

Name [Name]

friendly name of the profile to be created

Maximum length: 64
Configuration - optional, unbounded; [ConfigurationRef]

Optional set of configurations to be assigned to the profile. List entries with tr2:ConfigurationEnumeration value "All" shall be ignored.
- Type [string]
  
  Type of the configuration as defined by tr2:ConfigurationEnumeration.
- Token - optional; [ReferenceToken]
  
  Reference token of an existing configuration. Token shall be included in the AddConfiguration request along with the type. Token shall be included in the CreateProfile request when Configuration elements are included and type is selected. Token is optional for RemoveConfiguration request. If no token is provided in RemoveConfiguration request, device shall remove the configuration of the type included in the profile.
  
  Maximum length: 64

Output

Token [ReferenceToken]

Token assigned by the device for the newly created profile.

Maximum length: 64

GetProfiles

GetProfiles(Token=None, Type=None)

Retrieve the profile with the specified token or all defined media profiles.

If no Type is provided the returned profiles shall contain no configuration information.
If a single Type with value 'All' is provided the returned profiles shall include all associated configurations.
Otherwise the requested list of configurations shall for each profile include the configurations present as Type.

Input

Token - optional; [ReferenceToken]

Optional token of the requested profile.

Maximum length: 64
Type - optional, unbounded; [string]

The types shall be provided as defined by tr2:ConfigurationEnumeration.

Output

Profiles - optional, unbounded; [MediaProfile]

Lists all profiles that exist in the media service. The response provides the requested types of Configurations as far as available. If a profile doesn't contain a type no error shall be provided.

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

Configurations - optional; [ConfigurationSet]

The configurations assigned to the profile.

VideoSource - 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.

AudioSource - 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
VideoEncoder - optional; [VideoEncoder2Configuration]

Optional configuration of the Video encoder.
- GovLength - optional; [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.
- AnchorFrameDistance - optional; [int]
  
  Distance between anchor frames of type I-Frame and P-Frame. '1' indicates no B-Frames, '2' indicates that every 2nd frame is encoded as B-Frame, '3' indicates a structure like IBBPBBP..., etc.
- Profile - optional; [string]
  
  The encoder profile as defined in tt:VideoEncodingProfiles.
- 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.
- Signed - optional; [boolean]
  
  Indicates if this stream will be signed according to the Media Signing Specification.
- SecureStreamingProtocolAlgorithm - optional; [string]
  
  Defines the cryptographic algorithm to use 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.
- Encoding [string]
  
  Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and IANA Media Types.
- Resolution [VideoResolution2]
  
  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.
- RateControl - optional; [VideoRateControl2]
  
  Optional element to configure rate control related parameters.
  - ConstantBitRate - optional; [boolean]
    
    Enforce constant bitrate.
  - FrameRateLimit [float]
    
    Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations.
  - BitrateLimit [int]
    
    the maximum output bitrate in kbps
  - AverageBitRate - optional; [int]
    
    The target average output bitrate in kbps. If this parameter is set to 0, AverageBitRate shall be ignored.
- Multicast - optional; [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.
- Quality [float]
  
  Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality
AudioEncoder - optional; [AudioEncoder2Configuration]

Optional configuration of the Audio encoder.
- SecureStreamingProtocolAlgorithm - optional; [string]
  
  Defines the cryptographic algorithm to use 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.
- Encoding [string]
  
  Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types.
- Multicast - optional; [MulticastConfiguration]
  
  Optional multicast configuration of the audio stream.
  - 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.
- Bitrate [int]
  
  The output bitrate in kbps.
- SampleRate [int]
  
  The output sample rate in kHz.
Analytics - optional; [VideoAnalyticsConfiguration]

Optional configuration of the 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]
PTZ - 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]
Metadata - 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]
AudioOutput - 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.
AudioDecoder - 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.

Receiver - optional; [ReceiverConfiguration]

Optional configuration of the Receiver.

token - optional; [ReferenceToken]

Mode [ReceiverMode]

The following connection modes are defined:

Enum Value	Enum Description
`AutoConnect`	The receiver connects on demand, as required by consumers of the media streams.
`AlwaysConnect`	The receiver attempts to maintain a persistent connection to the configured endpoint.
`NeverConnect`	The receiver does not attempt to connect.
`Unknown`	This case should never happen.

MediaUri [anyURI]

Details of the URI to which the receiver should connect.
StreamSetup [StreamSetup]

Stream connection parameters.
- 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.

AddConfiguration

AddConfiguration(
    ProfileToken, Name=None, Configuration=None
)

This operation adds one or more Configurations to an existing media profile.

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

Note that OSD elements must be added via the CreateOSD command.

Input

ProfileToken [ReferenceToken]

Reference to the profile where the configuration should be added

Maximum length: 64
Name - optional; [Name]

Optional item. If present updates the Name property of the profile.

Maximum length: 64
Configuration - optional, unbounded; [ConfigurationRef]

List of configurations to be added. The types shall be provided in the order defined by tr2:ConfigurationEnumeration. List entries with tr2:ConfigurationEnumeration value "All" shall be ignored.
- Type [string]
  
  Type of the configuration as defined by tr2:ConfigurationEnumeration.
- Token - optional; [ReferenceToken]
  
  Reference token of an existing configuration. Token shall be included in the AddConfiguration request along with the type. Token shall be included in the CreateProfile request when Configuration elements are included and type is selected. Token is optional for RemoveConfiguration request. If no token is provided in RemoveConfiguration request, device shall remove the configuration of the type included in the profile.
  
  Maximum length: 64

RemoveConfiguration

RemoveConfiguration(ProfileToken, Configuration)

This operation removes the listed configurations from an existing media profile.

If the media profile does not contain one of the listed configurations that item shall be ignored.

Input

ProfileToken [ReferenceToken]

This element contains a reference to the media profile from which the configuration shall be removed.

Maximum length: 64
Configuration - unbounded; [ConfigurationRef]

List of configurations to be removed. The types shall be provided in the order defined by tr2:ConfigurationEnumeration. Tokens appearing in the configuration list shall be ignored. Presence of the "All" type shall result in an empty profile.
- Type [string]
  
  Type of the configuration as defined by tr2:ConfigurationEnumeration.
- Token - optional; [ReferenceToken]
  
  Reference token of an existing configuration. Token shall be included in the AddConfiguration request along with the type. Token shall be included in the CreateProfile request when Configuration elements are included and type is selected. Token is optional for RemoveConfiguration request. If no token is provided in RemoveConfiguration request, device shall remove the configuration of the type included in the profile.
  
  Maximum length: 64

DeleteProfile

DeleteProfile(Token)

This operation deletes a profile.

Deletion of a profile is only possible for non-fixed profiles

Input

Token [ReferenceToken]

This element contains a reference to the profile that should be deleted.

Maximum length: 64

GetVideoSourceConfigurations

GetVideoSourceConfigurations(
    ConfigurationToken=None, ProfileToken=None
)

By default this operation lists all existing video source configurations for a device.

Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.

Input

ConfigurationToken - optional; [ReferenceToken]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations shall be compatible with.

Maximum length: 64

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(
    ConfigurationToken=None, ProfileToken=None
)

By default this operation lists all existing video encoder configurations for a device.

Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.

Input

ConfigurationToken - optional; [ReferenceToken]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations shall be compatible with.

Maximum length: 64

Output

Configurations - optional, unbounded; [VideoEncoder2Configuration]

This element contains a list of video encoder configurations.
- GovLength - optional; [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.
- AnchorFrameDistance - optional; [int]
  
  Distance between anchor frames of type I-Frame and P-Frame. '1' indicates no B-Frames, '2' indicates that every 2nd frame is encoded as B-Frame, '3' indicates a structure like IBBPBBP..., etc.
- Profile - optional; [string]
  
  The encoder profile as defined in tt:VideoEncodingProfiles.
- 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.
- Signed - optional; [boolean]
  
  Indicates if this stream will be signed according to the Media Signing Specification.
- SecureStreamingProtocolAlgorithm - optional; [string]
  
  Defines the cryptographic algorithm to use 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.
- Encoding [string]
  
  Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and IANA Media Types.
- Resolution [VideoResolution2]
  
  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.
- RateControl - optional; [VideoRateControl2]
  
  Optional element to configure rate control related parameters.
  - ConstantBitRate - optional; [boolean]
    
    Enforce constant bitrate.
  - FrameRateLimit [float]
    
    Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations.
  - BitrateLimit [int]
    
    the maximum output bitrate in kbps
  - AverageBitRate - optional; [int]
    
    The target average output bitrate in kbps. If this parameter is set to 0, AverageBitRate shall be ignored.
- Multicast - optional; [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.
- Quality [float]
  
  Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality

GetAudioSourceConfigurations

GetAudioSourceConfigurations(
    ConfigurationToken=None, ProfileToken=None
)

By default this operation lists all existing audio source configurations for a device.

Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.

Input

ConfigurationToken - optional; [ReferenceToken]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations shall be compatible with.

Maximum length: 64

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(
    ConfigurationToken=None, ProfileToken=None
)

By default this operation lists all existing audio encoder configurations for a device.

Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.

Input

ConfigurationToken - optional; [ReferenceToken]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations shall be compatible with.

Maximum length: 64

Output

Configurations - optional, unbounded; [AudioEncoder2Configuration]

This element contains a list of audio encoder configurations.
- SecureStreamingProtocolAlgorithm - optional; [string]
  
  Defines the cryptographic algorithm to use 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.
- Encoding [string]
  
  Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types.
- Multicast - optional; [MulticastConfiguration]
  
  Optional multicast configuration of the audio stream.
  - 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.
- Bitrate [int]
  
  The output bitrate in kbps.
- SampleRate [int]
  
  The output sample rate in kHz.

GetAnalyticsConfigurations

GetAnalyticsConfigurations(
    ConfigurationToken=None, ProfileToken=None
)

By default this operation lists all existing video analytics configurations for a device.

Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.

Input

ConfigurationToken - optional; [ReferenceToken]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations shall be compatible with.

Maximum length: 64

Output

Configurations - optional, unbounded; [VideoAnalyticsConfiguration]

This element contains a list of Analytics 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(
    ConfigurationToken=None, ProfileToken=None
)

By default this operation lists all existing metadata configurations for a device.

Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.

Input

ConfigurationToken - optional; [ReferenceToken]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations shall be compatible with.

Maximum length: 64

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(
    ConfigurationToken=None, ProfileToken=None
)

By default this operation lists all existing audio output configurations for a device.

Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.

Input

ConfigurationToken - optional; [ReferenceToken]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations shall be compatible with.

Maximum length: 64

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(
    ConfigurationToken=None, ProfileToken=None
)

By default this operation lists all existing audio decoder configurations for a device.

Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned.

Input

ConfigurationToken - optional; [ReferenceToken]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations shall be compatible with.

Maximum length: 64

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.

SetVideoSourceConfiguration

SetVideoSourceConfiguration(Configuration)

This operation modifies a video source configuration.

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.

SetVideoEncoderConfiguration

SetVideoEncoderConfiguration(Configuration)

This operation modifies a video encoder configuration.

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 [VideoEncoder2Configuration]

Contains the modified video encoder configuration. The configuration shall exist in the device.
- GovLength - optional; [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.
- AnchorFrameDistance - optional; [int]
  
  Distance between anchor frames of type I-Frame and P-Frame. '1' indicates no B-Frames, '2' indicates that every 2nd frame is encoded as B-Frame, '3' indicates a structure like IBBPBBP..., etc.
- Profile - optional; [string]
  
  The encoder profile as defined in tt:VideoEncodingProfiles.
- 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.
- Signed - optional; [boolean]
  
  Indicates if this stream will be signed according to the Media Signing Specification.
- SecureStreamingProtocolAlgorithm - optional; [string]
  
  Defines the cryptographic algorithm to use 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.
- Encoding [string]
  
  Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and IANA Media Types.
- Resolution [VideoResolution2]
  
  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.
- RateControl - optional; [VideoRateControl2]
  
  Optional element to configure rate control related parameters.
  - ConstantBitRate - optional; [boolean]
    
    Enforce constant bitrate.
  - FrameRateLimit [float]
    
    Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations.
  - BitrateLimit [int]
    
    the maximum output bitrate in kbps
  - AverageBitRate - optional; [int]
    
    The target average output bitrate in kbps. If this parameter is set to 0, AverageBitRate shall be ignored.
- Multicast - optional; [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.
- Quality [float]
  
  Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality

SetAudioSourceConfiguration

SetAudioSourceConfiguration(Configuration)

This operation modifies an audio source configuration.

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

SetAudioEncoderConfiguration

SetAudioEncoderConfiguration(Configuration)

This operation modifies an audio encoder configuration.

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 [AudioEncoder2Configuration]

Contains the modified audio encoder configuration. The configuration shall exist in the device.
- SecureStreamingProtocolAlgorithm - optional; [string]
  
  Defines the cryptographic algorithm to use 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.
- Encoding [string]
  
  Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types.
- Multicast - optional; [MulticastConfiguration]
  
  Optional multicast configuration of the audio stream.
  - 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.
- Bitrate [int]
  
  The output bitrate in kbps.
- SampleRate [int]
  
  The output sample rate in kHz.

SetMetadataConfiguration

SetMetadataConfiguration(Configuration)

This operation modifies a metadata configuration.

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]

SetAudioOutputConfiguration

SetAudioOutputConfiguration(Configuration)

This operation modifies an audio output configuration.

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.

SetAudioDecoderConfiguration

SetAudioDecoderConfiguration(Configuration)

This operation modifies an audio decoder configuration.

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.

SetEQPreset

SetEQPreset(Configuration)

Set Audio EQPreset using the legacy ONVIF operation name.

This operation is retained for compatibility with devices implementing the ONVIF 25.12 operation name before it was renamed in later specifications.

Compatible with ONVIF >=25.12 and <26.12.

SetEQPresetConfiguration

SetEQPresetConfiguration(Configuration)

0.4.3

This command is to configure Audio EQPreset.

Input

Configuration [EQPreset]

Contains the modified EQ Preset configuration.
- 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.

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]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations 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.

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]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations shall be compatible with.

Maximum length: 64

Output

Options - unbounded; [VideoEncoder2ConfigurationOptions]
- GovLengthRange - optional; [IntList]
  
  Exactly two values, which define the Lower and Upper bounds for the supported group of Video frames length. These values typically correspond to the I-Frame distance.
- MaxAnchorFrameDistance - optional; [int]
  
  Signals support for B-Frames. Upper bound for the supported anchor frame distance (must be larger than one).
- FrameRatesSupported - optional; [FloatList]
  
  List of supported target frame rates in fps (frames per second). The list shall be sorted with highest values first.
- ProfilesSupported - optional; [StringAttrList]
  
  List of supported encoder profiles as defined in tt::VideoEncodingProfiles.
- ConstantBitRateSupported - optional; [boolean]
  
  Signal whether enforcing constant bitrate is supported.
- AverageBitRateSupported - optional; [boolean]
  
  Signal whether enforcing average bitrate is supported.
- GuaranteedFrameRateSupported - optional; [boolean]
  
  Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoder2Configuration element.
- SecureStreamingProtocolAlgorithms - optional; [StringAttrList]
  
  If secure RTSP streaming is supported, this shall return the list of supported cryptographic algorithms as defined by tt:SrtpSecurityAlgorithms.
- SigningSupported - optional; [boolean]
  
  Indicates the support for signing according to the Media Signing Specification.
- Encoding [string]
  
  Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and IANA Media Types.
- QualityRange [FloatRange]
  
  Range of the quality values. A high value means higher quality.
  - Min [float]
  - Max [float]
- ResolutionsAvailable - unbounded; [VideoResolution2]
  
  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.
- BitrateRange [IntRange]
  
  Supported range of encoded bitrate in kbps.
  - Min [int]
  - Max [int]

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]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations 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]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations shall be compatible with.

Maximum length: 64

Output

Options - unbounded; [AudioEncoder2ConfigurationOptions]

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.
- SecureStreamingProtocolAlgorithms - optional; [StringAttrList]
  
  If secure RTSP streaming is supported, this shall return the list of supported cryptographic algorithms as defined by tt:SrtpSecurityAlgorithms.
- Encoding [string]
  
  Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types.
- 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]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations 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.

To retrieve the EQPresetList, a valid ConfigurationToken must be provided. If EQPreset is supported and isFrequencyDecibelEditable is signaled as true, the response shall include the FrequencyDecibelPair.

Input

ConfigurationToken - optional; [ReferenceToken]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations 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]

Token of the requested configuration.

Maximum length: 64
ProfileToken - optional; [ReferenceToken]

Contains the token of an existing media profile the configurations shall be compatible with.

Maximum length: 64

Output

Options - unbounded; [AudioEncoder2ConfigurationOptions]

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.
- SecureStreamingProtocolAlgorithms - optional; [StringAttrList]
  
  If secure RTSP streaming is supported, this shall return the list of supported cryptographic algorithms as defined by tt:SrtpSecurityAlgorithms.
- Encoding [string]
  
  Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types.
- 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]

GetVideoEncoderInstances

GetVideoEncoderInstances(ConfigurationToken)

The GetVideoEncoderInstances 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

Info [EncoderInstanceInfo]

The minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration.
- Codec - optional, unbounded; [EncoderInstance]
  
  If a device limits the number of instances for respective Video Codecs the response contains the information how many streams can be set up at the same time per VideoSource.
  - Encoding [string]
    
    Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and IANA Media Types.
  - Number [int]
    
    The minimum guaranteed number of encoder instances (applications) for the VideoSourceConfiguration.
- Total [int]
  
  The minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration. The device is able to deliver the Total number of streams

GetStreamUri

GetStreamUri(Protocol, 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.

Defined stream types are

RtspUnicast RTSP streaming RTP as UDP Unicast.
RtspMulticast RTSP streaming RTP as UDP Multicast.
RtspsUnicast Secure RTSP streaming with SRTP as UDP Unicast.
RtspsMulticast Secure RTSP streaming with SRTP as UDP Multicast.
RTSP RTSP streaming RTP over TCP.
RtspOverHttp Tunneling both the RTSP control channel and the RTP stream over HTTP or HTTPS.

If a multicast stream is requested at least one of VideoEncoder2Configuration, AudioEncoder2Configuration 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

Protocol [string]

Defines the network protocol for streaming as defined by tr2:TransportProtocol
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

Uri [anyURI]

Stable Uri to be used for requesting the media stream

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 stops 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 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

Uri [anyURI]

Stable Uri to be used for requesting snapshot images.

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]
  
  List of one or more encodings supported for this video source. For name definitions see tt:VideoEncodingMimeNames, and see IANA Media Types.
- 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.

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(OSDToken=None, ConfigurationToken=None)

This operation lists existing OSD configurations for the device.

If an OSD token is provided the device shall respond with the requested configuration or provide an error if it does not exist.
In case only a video source configuration token is provided the device shall respond with all configurations that exist for the video source configuration.
If no tokens are provided the device shall respond with all available OSD configurations.

Input

OSDToken - optional; [ReferenceToken]

The GetOSDs command fetches the OSD configuration if the OSD token is known.

Maximum length: 64
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]

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

GetMasks

GetMasks(Token=None, ConfigurationToken=None)

This operation lists existing Mask configurations for the device.

If an Mask token is provided the device shall respond with the requested configuration or provide an error if it does not exist.
In case only a video source configuration token is provided the device shall respond with all configurations that exist for the video source configuration.
If no tokens are provided the device shall respond with all available Mask configurations.

Input

Token - optional; [ReferenceToken]

Optional mask token of an existing mask.

Maximum length: 64
ConfigurationToken - optional; [ReferenceToken]

Optional token of a Video Source Configuration.

Maximum length: 64

Output

Masks - optional, unbounded; [Mask]

List of Mask configurations.
- token - optional; [ReferenceToken]
  
  Token of the mask.
- ConfigurationToken [ReferenceToken]
  
  Token of the VideoSourceConfiguration the Mask is associated with.
  
  Maximum length: 64
- Polygon [Polygon]
  
  Geometric representation of the mask area.
  - Point - unbounded; [Vector]
    
    x - required; [float]
    
    y - required; [float]
- Type [string]
  Type of masking as defined by tr2:MaskType:
  
  Color - The masked area is colored with color defined by the Color field.
  
  Pixelated - The masked area is filled in mosaic style to hide details.
  
  Blurred - The masked area is low pass filtered to hide details.
- Color - optional; [Color]
  
  Color of the masked area.
  - 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.
- Enabled [boolean]
  
  If set the mask will cover the image, otherwise it will be fully transparent.

GetMaskOptions

GetMaskOptions(ConfigurationToken)

Get the Mask 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

Options [MaskOptions]
- RectangleOnly - optional; [boolean]
  
  Information whether the polygon must have four points and a rectangular shape.
- SingleColorOnly - optional; [boolean]
  
  Indicates the device capability of change in color of privacy mask for one video source configuration will automatically be applied to all the privacy masks associated with the same video source configuration.
- MaxMasks [int]
  
  Maximum supported number of masks per VideoSourceConfiguration.
- MaxPoints [int]
  
  Maximum supported number of points per mask.
- Types - unbounded; [string]
  
  Information which types of tr2:MaskType are supported. Valid values are 'Color', 'Pixelated' and 'Blurred'.
- Color [ColorOptions]
  
  Colors supported.
  - 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.

SetMask

SetMask(Mask)

Set the Mask.

Input

Mask [Mask]

Mask to be updated.
- token - optional; [ReferenceToken]
  
  Token of the mask.
- ConfigurationToken [ReferenceToken]
  
  Token of the VideoSourceConfiguration the Mask is associated with.
  
  Maximum length: 64
- Polygon [Polygon]
  
  Geometric representation of the mask area.
  - Point - unbounded; [Vector]
    
    x - required; [float]
    
    y - required; [float]
- Type [string]
  Type of masking as defined by tr2:MaskType:
  
  Color - The masked area is colored with color defined by the Color field.
  
  Pixelated - The masked area is filled in mosaic style to hide details.
  
  Blurred - The masked area is low pass filtered to hide details.
- Color - optional; [Color]
  
  Color of the masked area.
  - 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.
- Enabled [boolean]
  
  If set the mask will cover the image, otherwise it will be fully transparent.

CreateMask

CreateMask(Mask)

Create the Mask.

Input

Mask [Mask]

Contain the initial mask configuration for create.
- token - optional; [ReferenceToken]
  
  Token of the mask.
- ConfigurationToken [ReferenceToken]
  
  Token of the VideoSourceConfiguration the Mask is associated with.
  
  Maximum length: 64
- Polygon [Polygon]
  
  Geometric representation of the mask area.
  - Point - unbounded; [Vector]
    
    x - required; [float]
    
    y - required; [float]
- Type [string]
  Type of masking as defined by tr2:MaskType:
  
  Color - The masked area is colored with color defined by the Color field.
  
  Pixelated - The masked area is filled in mosaic style to hide details.
  
  Blurred - The masked area is low pass filtered to hide details.
- Color - optional; [Color]
  
  Color of the masked area.
  - 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.
- Enabled [boolean]
  
  If set the mask will cover the image, otherwise it will be fully transparent.

Output

Token [ReferenceToken]

Returns Token of the newly created Mask

Maximum length: 64

DeleteMask

DeleteMask(Token)

Delete the Mask.

Input

Token [ReferenceToken]

This element contains a reference to the Mask configuration that should be deleted.

Maximum length: 64

GetWebRTCConfigurations

GetWebRTCConfigurations()

This operation gets the current WebRTC configuration for the device.

Output

WebRTCConfiguration - optional, unbounded; [WebRTCConfiguration]

Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with.
- SignalingServer [anyURI]
  
  The signaling server URI.
- CertPathValidationPolicyID - optional; [string]
  
  The CertPathValidationPolicyID for validating the signaling server certificate.
- AuthorizationServer [ReferenceToken]
  
  The Authorization Server to use for getting access tokens. This refers to an entity in the list of configured Authorization Servers in the [ONVIF Security Service Specification].
  
  Maximum length: 64
- DefaultProfile [ReferenceToken]
  
  The default media profile to use for streaming if no specific profile is specified when initializing a session.
  
  Maximum length: 64
- Enabled [boolean]
  
  Enables/disables the configuration.
- Connected - optional; [boolean]
  
  Indicates if the device is connected to the server. This parameter is read-only.
- Error - optional; [string]
  
  Optional user readable error information (readonly).

SetWebRTCConfigurations

SetWebRTCConfigurations(WebRTCConfiguration=None)

This operation sets the WebRTC configuration for the device.

Input

WebRTCConfiguration - optional, unbounded; [WebRTCConfiguration]

This message contains the WebRTC configurations to use for the device. If empty, existing WebRTC configurations are deleted.
- SignalingServer [anyURI]
  
  The signaling server URI.
- CertPathValidationPolicyID - optional; [string]
  
  The CertPathValidationPolicyID for validating the signaling server certificate.
- AuthorizationServer [ReferenceToken]
  
  The Authorization Server to use for getting access tokens. This refers to an entity in the list of configured Authorization Servers in the [ONVIF Security Service Specification].
  
  Maximum length: 64
- DefaultProfile [ReferenceToken]
  
  The default media profile to use for streaming if no specific profile is specified when initializing a session.
  
  Maximum length: 64
- Enabled [boolean]
  
  Enables/disables the configuration.
- Connected - optional; [boolean]
  
  Indicates if the device is connected to the server. This parameter is read-only.
- Error - optional; [string]
  
  Optional user readable error information (readonly).

GetAudioClips

GetAudioClips(Token=None)

This operation retrieves audio clip configurations from the device.

If an audio clip token is provided, the device shall return the audio clip configuration associated with that token. If no token is provided, the device shall return all audio clip configurations that exist on the device.

Input

Token - optional; [ReferenceToken]

Audio clip token.

Maximum length: 64

Output

AudioClipItem - optional, unbounded; [GetAudioClipsResponseItem]

List of audio clip items.
- Token [ReferenceToken]
  
  Unique token associated with the audio clip.
  
  Maximum length: 64
- Configuration [AudioClip]
  
  Configuration of the audio clip.
  - Enabled [boolean]
    
    Enables/disables the audio clip.
  - Name [string]
    
    Name of the audio clip.
  - AudioOutputToken - optional, unbounded; [ReferenceToken]
    
    Optional token list of physical audio outputs.
    
    Maximum length: 64
  - Type [string]
    
    Format of the audio clip. For definitions see tr2:SupportedAudioClipFormat parameter.
  - RepeatCycles [int]
    
    The number of times the audio clip can be repeated when it is played. A value of 0 means no repeat (i.e., the audio clip plays once and does not repeat). A value of 1 means the audio clip plays once and repeats once after the first play. A value of -1 means the audio clip repeats infinitely after the first play until it is stopped by the user.
  - RepeatInterval - optional; [int]
    
    Optional time interval, in seconds, between audio clips when the audio clip is repeated.
  - AudioOutputLevel - optional; [int]
    
    Optional level to control the volume of the audio clip when it is played.
  - ScheduleToken - optional; [ReferenceToken]
    
    Optional schedule token associated with the audio clip configuration. The audio clip shall be played when the configured schedule is triggered.
    
    Maximum length: 64

AddAudioClip

AddAudioClip(Configuration, Token=None)

This operation adds audio clip configuration to the device and provides audio clip upload URI to the client.

The response to the command includes an HTTP URL to which the audio clip may be uploaded within the expiry time. If the client is unable to upload the audio clip within the URL's expiry time, the associated audio clip configuration will be permanently removed from the device.

Input

Token - optional; [ReferenceToken]

Optional token associated with the audio clip.

Maximum length: 64
Configuration [AudioClip]

Audio clip configuration to add.
- Enabled [boolean]
  
  Enables/disables the audio clip.
- Name [string]
  
  Name of the audio clip.
- AudioOutputToken - optional, unbounded; [ReferenceToken]
  
  Optional token list of physical audio outputs.
  
  Maximum length: 64
- Type [string]
  
  Format of the audio clip. For definitions see tr2:SupportedAudioClipFormat parameter.
- RepeatCycles [int]
  
  The number of times the audio clip can be repeated when it is played. A value of 0 means no repeat (i.e., the audio clip plays once and does not repeat). A value of 1 means the audio clip plays once and repeats once after the first play. A value of -1 means the audio clip repeats infinitely after the first play until it is stopped by the user.
- RepeatInterval - optional; [int]
  
  Optional time interval, in seconds, between audio clips when the audio clip is repeated.
- AudioOutputLevel - optional; [int]
  
  Optional level to control the volume of the audio clip when it is played.
- ScheduleToken - optional; [ReferenceToken]
  
  Optional schedule token associated with the audio clip configuration. The audio clip shall be played when the configured schedule is triggered.
  
  Maximum length: 64

Output

Token [ReferenceToken]

Unique token of the audio clip to be uploaded.

Maximum length: 64
UploadUri [anyURI]

A URL to which the audio clip can be uploaded.
ExpiryTime [dateTime]

Expiry time by which the client should upload the audio clip to the device.

SetAudioClip

SetAudioClip(Token, Configuration)

This operation modifies the existing audio clip configuration on the device.

Input

Token [ReferenceToken]

Unique token associated with the audio clip.

Maximum length: 64
Configuration [AudioClip]

Audio clip configuration to modify.
- Enabled [boolean]
  
  Enables/disables the audio clip.
- Name [string]
  
  Name of the audio clip.
- AudioOutputToken - optional, unbounded; [ReferenceToken]
  
  Optional token list of physical audio outputs.
  
  Maximum length: 64
- Type [string]
  
  Format of the audio clip. For definitions see tr2:SupportedAudioClipFormat parameter.
- RepeatCycles [int]
  
  The number of times the audio clip can be repeated when it is played. A value of 0 means no repeat (i.e., the audio clip plays once and does not repeat). A value of 1 means the audio clip plays once and repeats once after the first play. A value of -1 means the audio clip repeats infinitely after the first play until it is stopped by the user.
- RepeatInterval - optional; [int]
  
  Optional time interval, in seconds, between audio clips when the audio clip is repeated.
- AudioOutputLevel - optional; [int]
  
  Optional level to control the volume of the audio clip when it is played.
- ScheduleToken - optional; [ReferenceToken]
  
  Optional schedule token associated with the audio clip configuration. The audio clip shall be played when the configured schedule is triggered.
  
  Maximum length: 64

DeleteAudioClip

DeleteAudioClip(Token)

This operation deletes the audio clip configuration and the associated audio clip on the device.

The audio clip should be de-associated from the event or schedule trigger if it was previously associated before this operation. This operation will fail if the device is playing the audio clip at the same time due to user operation, schedule, or event trigger.

Input

Token [ReferenceToken]

Token of the audio clip to be deleted from the device.

Maximum length: 64

PlayAudioClip

PlayAudioClip(
    Token, Play, AudioOutputToken=None, RepeatCycles=None
)

This operation plays or stops the ongoing audio clip on the device.

Input

Token [ReferenceToken]

Token of the audio clip to be played or stopped.

Maximum length: 64
AudioOutputToken - optional, unbounded; [ReferenceToken]

Optional token list of physical audio outputs. If the AudioOutputToken is not provided in the API request, the AudioOutputToken from the audio clip configuration will be used.

Maximum length: 64
Play [boolean]

If it is true, play the audio clip; if it is false, stop the ongoing audio clip.
RepeatCycles - optional; [int]

Optional RepeatCycles to be used for the current play operation. If RepeatCycles is not provided in the API request, the RepeatCycles specified in the audio clip configuration will be used for the current play operation.

AddTTSAudioClip

AddTTSAudioClip(
    Configuration, TTSConfiguration, Token=None
)

0.2.11

This operation sends a text and its configuration to device that supports TTS function, so that device could convert the text into an audio clip and play it according to audio clip Configuration and TTS Configuration.

Input

Token - optional; [ReferenceToken]

Optional token associated with the audio clip.

Maximum length: 64
Configuration [AudioClip]

Audio clip configuration to add.
- Enabled [boolean]
  
  Enables/disables the audio clip.
- Name [string]
  
  Name of the audio clip.
- AudioOutputToken - optional, unbounded; [ReferenceToken]
  
  Optional token list of physical audio outputs.
  
  Maximum length: 64
- Type [string]
  
  Format of the audio clip. For definitions see tr2:SupportedAudioClipFormat parameter.
- RepeatCycles [int]
  
  The number of times the audio clip can be repeated when it is played. A value of 0 means no repeat (i.e., the audio clip plays once and does not repeat). A value of 1 means the audio clip plays once and repeats once after the first play. A value of -1 means the audio clip repeats infinitely after the first play until it is stopped by the user.
- RepeatInterval - optional; [int]
  
  Optional time interval, in seconds, between audio clips when the audio clip is repeated.
- AudioOutputLevel - optional; [int]
  
  Optional level to control the volume of the audio clip when it is played.
- ScheduleToken - optional; [ReferenceToken]
  
  Optional schedule token associated with the audio clip configuration. The audio clip shall be played when the configured schedule is triggered.
  
  Maximum length: 64
TTSConfiguration [TTSAudio]

The configuration for the TTS audio clip to add.
- Content [string]
  
  Content of the audio clip.
- Language [string]
  
  The language that is supported by the device and used for TTS audio clip playback. Uses ISO 639-1 alpha-2 language codes for definition, such as"en" for English. See Codes for the Representation of Names of Languages. Optionally combined with ISO 3166-1 alpha-2 country codes using the "language-country" format to specify regional variations, such as"en-US" for American English. For country codes, see ISO 3166-1 Country Codes.
- VoiceType [string]
  
  The voice type that is supported by the device and used for TTS audio clip playback. See tr2: TTSVoiceType.

Output

Token [ReferenceToken]

Unique token assigned by device for the TTS audio clip.

Maximum length: 64

GetPlayingAudioClips

GetPlayingAudioClips()

This operation retrieves audio clips information which are playing currently in the device.

Output

PlayingAudioClips - optional, unbounded; [PlayingAudioClips]

List of audio clips currently playing in the device.
- Token [ReferenceToken]
  
  Unique token associated with the audio clip.
  
  Maximum length: 64
- Name [string]
  
  Name of the audio clip.
- AudioOutputToken - unbounded; [ReferenceToken]
  
  Token list of physical audio outputs.
  
  Maximum length: 64
- AudioOutputLevel [int]
  
  Output level to control the volume of the audio clip when it is played.
- RepeatsLeft [int]
  
  Number of repeat cycles left while playing the audio clip.

GetMulticastAudioDecoderConfigurationOptions

GetMulticastAudioDecoderConfigurationOptions(
    ConfigurationToken=None,
)

0.2.6

This operation gets the available options for the MulticastAudioDecoder configuration.

Input

ConfigurationToken - optional; [ReferenceToken]

This response contains the available MulticastAudioDecoderConfigurationOptions. If a multicast audio decoder configuration is specified, the options shall concern that particular configuration.

Maximum length: 64

Output

Options - unbounded; [MulticastAudioDecoderConfigurationOptions]
- SecureStreamingProtocolAlgorithms - optional; [StringList]
  
  An optional parameter specifies the list of supported cryptographic algorithms when SRTP support is signaled as 'true' in the GetServiceCapabilitiesResponse. Refer to tt:SrtpSecurityAlgorithms for the acceptable values.
- EncodingOptions [AudioDecoder2Options]
  
  Supported encoding options for the multicast audio decoder.
  - Encoding [string]
    
    Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and IANA Media Types.
  - 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]
  - RTPPayloadType - optional; [int]
    
    Optional element for specifying the RTP payload type, particularly when it is fixed for a specific audio encoding as defined in IANA RTP Payload Types.
- PriorityRange [IntRange]
  
  Specifies the priority range as an integer. This indicates the priority level for audio configuration.
  - Min [int]
  - Max [int]
- AudioOutputTokens - optional; [StringList]
  
  Optional list of physical Audio output tokens. This element is used when only certain audio outputs can be configured for this token.

GetMulticastAudioDecoderConfigurations

GetMulticastAudioDecoderConfigurations(
    ConfigurationToken=None,
)

0.2.6

This operation gets the list of multicast audio decoder configurations.

Input

ConfigurationToken - optional; [ReferenceToken]

Unique token of the multicast audio decoder configuration. If not passed, device shall respond with all configurations.

Maximum length: 64

Output

Configurations - optional, unbounded; [MulticastAudioDecoderConfiguration]

This message contains the list of multicast 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.
- Enable [boolean]
  
  Indicates whether the Multicast Audio Decoder is enabled or disabled.
- AudioOutputToken - optional, unbounded; [ReferenceToken]
  
  Token of the physical Audio output. This element is optional and can occur multiple times.
  
  Maximum length: 64
- Encoding [string]
  
  Specifies the encoding type according to IANA media types.
- Bitrate [int]
  
  The bitrate of the audio stream in bits per second.
- SamplingRate [int]
  
  The sampling rate of the audio stream in kHz.
- Multicast [MulticastReceiverConfiguration]
  
  Contains configuration details for multicast settings.
  - 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 port used for receiving. The RTP port number shall be even. If RTCP is supported, the corresponding RTCP stream shall be mapped to the next higher (odd) port number as defined in RFC 3550.
  - 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.
  - InterfaceToken - optional, unbounded; [ReferenceToken]
    
    Unique identifier of the network interface on the device. If not specified, all available interfaces will be used for listening.
    
    Maximum length: 64
  - SourceSpecificMulticast - optional; [IPAddress]
    
    When a source-specific multicast address is configured, the device will process multicast data only from the specified source, in accordance with SSM principles defined in RFC 4607.
    
    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
- RTPPayloadType [int]
  
  Defines the RTP payload type used for the audio stream. To ensure compatibility, it is recommended to use dynamic payload types (96 and above), as specified in RFC 3551. Standard payload types (0-95) should only be used for predefined audio formats matching the audio encoding as defined in IANA RTP Payload Types, as using them for non-standard media may lead to unexpected errors or interoperability issues.
- Priority [int]
  
  Indicates the priority level when multiple configurations are active. A higher value signifies a higher priority. If several configurations have the same priority value the order between those configurations is undefined.
- MediaFormatParameters - optional; [string]
  
  Optional media format parameters as specified in SDP, such as: a=fmtp:101 stereo=1; sprop-stereo=1.
- SRTPPreSharedParameters - optional; [SRTPPreShared]
  
  Optional configuration parameters for SRTP pre-shared key usage, applicable when SRTP is supported. When this configuration is present, RTP packets shall be encrypted. When this configuration is absent, RTP packets shall not be encrypted. On GetMulticastAudioDecoderConfiguration, this element shall be present only if encryption is enabled; it shall be absent if encryption is disabled.
  - SecureStreamingProtocolAlgorithm - optional; [string]
    
    Specifies the cryptographic algorithm when using SRTP, selecting from predefined values provided in the GetMulticastAudioDecoderConfigurationOptions response.
  - SRTPPSK [string]
    
    SRTP Pre-Shared Key (PSK) represented as a hexadecimal string. This includes both the SRTP master key, followed by the master salt. The sizes of the key and salt depend on the specified SecureStreamingProtocolAlgorithm. The SRTPPSK shall be returned as an empty string on a get method. In SetMulticastAudioDecoderConfiguration requests, if SRTPPreSharedParameters is present but SRTPPSK is empty, the device shall retain the previously configured pre-shared key. To update the PSK, a valid non-empty hexadecimal value must be provided.
  - ROCExtMapID [int]
    
    The RTP header extension ID (ExtMapID) used to identify the ROC extension, as defined in RFC 8285. Valid values are 1 to 14 for one-byte header extensions.

SetMulticastAudioDecoderConfiguration

SetMulticastAudioDecoderConfiguration(Configuration)

0.2.6

This operation sets the MulticastAudioDecoderConfiguration.

Input

Configuration [MulticastAudioDecoderConfiguration]

Contains the modified multicast 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.
- Enable [boolean]
  
  Indicates whether the Multicast Audio Decoder is enabled or disabled.
- AudioOutputToken - optional, unbounded; [ReferenceToken]
  
  Token of the physical Audio output. This element is optional and can occur multiple times.
  
  Maximum length: 64
- Encoding [string]
  
  Specifies the encoding type according to IANA media types.
- Bitrate [int]
  
  The bitrate of the audio stream in bits per second.
- SamplingRate [int]
  
  The sampling rate of the audio stream in kHz.
- Multicast [MulticastReceiverConfiguration]
  
  Contains configuration details for multicast settings.
  - 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 port used for receiving. The RTP port number shall be even. If RTCP is supported, the corresponding RTCP stream shall be mapped to the next higher (odd) port number as defined in RFC 3550.
  - 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.
  - InterfaceToken - optional, unbounded; [ReferenceToken]
    
    Unique identifier of the network interface on the device. If not specified, all available interfaces will be used for listening.
    
    Maximum length: 64
  - SourceSpecificMulticast - optional; [IPAddress]
    
    When a source-specific multicast address is configured, the device will process multicast data only from the specified source, in accordance with SSM principles defined in RFC 4607.
    
    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
- RTPPayloadType [int]
  
  Defines the RTP payload type used for the audio stream. To ensure compatibility, it is recommended to use dynamic payload types (96 and above), as specified in RFC 3551. Standard payload types (0-95) should only be used for predefined audio formats matching the audio encoding as defined in IANA RTP Payload Types, as using them for non-standard media may lead to unexpected errors or interoperability issues.
- Priority [int]
  
  Indicates the priority level when multiple configurations are active. A higher value signifies a higher priority. If several configurations have the same priority value the order between those configurations is undefined.
- MediaFormatParameters - optional; [string]
  
  Optional media format parameters as specified in SDP, such as: a=fmtp:101 stereo=1; sprop-stereo=1.
- SRTPPreSharedParameters - optional; [SRTPPreShared]
  
  Optional configuration parameters for SRTP pre-shared key usage, applicable when SRTP is supported. When this configuration is present, RTP packets shall be encrypted. When this configuration is absent, RTP packets shall not be encrypted. On GetMulticastAudioDecoderConfiguration, this element shall be present only if encryption is enabled; it shall be absent if encryption is disabled.
  - SecureStreamingProtocolAlgorithm - optional; [string]
    
    Specifies the cryptographic algorithm when using SRTP, selecting from predefined values provided in the GetMulticastAudioDecoderConfigurationOptions response.
  - SRTPPSK [string]
    
    SRTP Pre-Shared Key (PSK) represented as a hexadecimal string. This includes both the SRTP master key, followed by the master salt. The sizes of the key and salt depend on the specified SecureStreamingProtocolAlgorithm. The SRTPPSK shall be returned as an empty string on a get method. In SetMulticastAudioDecoderConfiguration requests, if SRTPPreSharedParameters is present but SRTPPSK is empty, the device shall retain the previously configured pre-shared key. To update the PSK, a valid non-empty hexadecimal value must be provided.
  - ROCExtMapID [int]
    
    The RTP header extension ID (ExtMapID) used to identify the ROC extension, as defined in RFC 8285. Valid values are 1 to 14 for one-byte header extensions.

Enum Value	Enum Description
`IPv4`	—
`IPv6`	—

Enum Value	Enum Description
`IPv4`	—
`IPv6`	—

Enum Value	Enum Description
`IPv4`	—
`IPv6`	—

Enum Value	Enum Description
`RTP-Unicast`	—
`RTP-Multicast`	—