Media2 25.06 ONVIF™ www.onvif.org June, 2025 2008-2025 ONVIF™ All rights reserved. Recipients of this document may copy, distribute, publish, or display this document so long as this copyright notice, license and disclaimer are retained with all copies of the document. No license is granted to modify this document. THIS DOCUMENT IS PROVIDED "AS IS," AND THE CORPORATION AND ITS MEMBERS AND THEIR AFFILIATES, MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THIS DOCUMENT ARE SUITABLE FOR ANY PURPOSE; OR THAT THE IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. IN NO EVENT WILL THE CORPORATION OR ITS MEMBERS OR THEIR AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT, WHETHER OR NOT (1) THE CORPORATION, MEMBERS OR THEIR AFFILIATES HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR (2) SUCH DAMAGES WERE REASONABLY FORESEEABLE, AND ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT.  THE FOREGOING DISCLAIMER AND LIMITATION ON LIABILITY DO NOT APPLY TO, INVALIDATE, OR LIMIT REPRESENTATIONS AND WARRANTIES MADE BY THE MEMBERS AND THEIR RESPECTIVE AFFILIATES TO THE CORPORATION AND OTHER MEMBERS IN CERTAIN WRITTEN POLICIES OF THE CORPORATION. 1.0 Dec-2015 Hans Busch First release 1.01 Mar-2016 Hans Busch CR 1767, 1819 16.06 Jun-2016 Hiroyuki Sano CR 1786, 1795, 1799, 1801, 1819, 1861, 1869 16.12 Dec-2016 Sujith Raman Steve Dillingham Hans Busch Hiroyuki Sano Added RTSP over WebSocket Added Scene Orientation Modes Added Privacy Mask CR 1873, 1875, 1931, 1951, 1983, 1986 17.06 Jun-2017 Hans Busch Hiroyuki Sano Update method layouts. Change Request 1843, 2018, 2037, 2064, 2082, 2105 17.12 Dec-2017 Sujith Raman Steve Wolf Hiroyuki Sano Added ViewMode Added OSD Image Upload Change Request 2152, 2159, 2176, 2187, 2197, 2203, 2207 18.06 Jun-2018 Hiroyuki Sano Change Request 2216, 2217, 2282 18.12 Dec-2018 Hiroyuki Sano Change Request 2295 19.06 Jun-2019 Steve Wolf Hiroyuki Sano Added Active Sessions Change Request 2479, 2512 19.12 Dec-2019 Hiroyuki Sano Dora Han Change Request 2489, 2557, 2573, 2603, 2636 Added Multitrack Streaming 20.06 Jun-2020 Michio Hirai Change Request 2571, 2604 20.12 Dec-2020 Hans Busch Support media service without video encoder. 21.06 Jun-2021 Sujith Raman Clarify system coordinates. 21.12 Dec-2021 Hans Busch, Rick Boer Add optional Receiver configuration to Media2. Fix inconsistency in Media2 NoProfile fault message. 22.12 Dec-2022 Hans Busch Add secure RTSPS streaming. 23.06 Jun-2023 Oksana Tuishkina Clarify signaling rotation in video source configuration. 24.06 Jun-2024 Fredrik Svensson Add WebRTC configuration. 24.12 Dec-2024 Fredrik Svensson, Björn Volker, Jean-François Lévesque Add media signing. Add recommendation to have LensDescription present when Fisheye view mode is present. 25.06 Jun-2025 Venki Aravapalli, Sujith Raman Add audio clip Management and EQ presets. This document defines the second generation web service interface for configuration of the so called media profiles. These include the selection of Video and Audio inputs as well as PTZ and Analytics modes and the configuration of Video and Audio encoders. Media streaming is out of scope of this document and covered by the ONVIF streaming specification. Web service usage is outside of the scope of this document. Please refer to the ONVIF core specification. IANA Media Type Reference < > ONVIF Core Specification <> ONVIF PTZ Service Specification <> ONVIF Streaming Specification <> ONVIF Media Signing Specification <> ONVIF WebRTC Specification <> ONVIF Security Service Specification <>

Configuration Entity A network video device media abstract component that produces or consumes a media stream on the network, i.e. video and/or audio stream. Digital PTZ Function that diminishes or crops an image to adjust the image position and ratio. GZIP GNU data format for lossless compression. Media Profile Maps a video and audio sources and outputs encoders as well as PTZ and analytics configurations. Metadata All streaming data except video and audio, including video analytics results, PTZ position data and other metadata (such as textual data from POS applications). Reference Token Token provided by the device to uniquely reference an instance of a physical IO, configuration or profile. Video Analytics Algorithms or programs used to analyze video data and to generate data describing object location and behaviour.

RTCP RTP Control Protocol RTP Realtime Transport Protocol RTSP Real Time Streaming Protocol TCP Transmission Control Protocol UDP User Datagram Protocol EXI Efficient XML Interchange Format

Media configurations are handled through the media service. Media configurations are used to determine the streaming properties of requested media streams as defined in this specification. The device provides media configuration through the media service. WSDL for this service is specified in http://www.onvif.org/ver20/media/wsdl/media.wsdll. Prefix Namespace URI env http://www.w3.org/2003/05/soap-envelope ter http://www.onvif.org/ver10/error xs http://www.w3.org/2001/XMLSchema tt http://www.onvif.org/ver10/schema tr2 http://www.onvif.org/ver20/media/wsdl tns1 http://www.onvif.org/ver10/topics

Real-time video and audio streaming configurations are controlled using media profiles. A media profile maps a video and/or audio source to a video and/or an audio encoder, PTZ and analytics configurations. An ONVIF compliant device supporting the media service presents different available profiles depending on its capabilities (the set of available profiles might change dynamically though).

A device may provide “ready to use” profiles for the most common media configurations that the device offers. The Profile contains a “fixed” attribute that indicates if a profile can be deleted or not. The fixed attribute does not signal that a profile is immutable. Hence it shall be possible to add or remove configurations to or from a fixed profile. Whether a profile is fixed or not is defined by the device. A profile consists of a set of interconnected configuration entities. Configurations are provided by the device and can be either static or created dynamically by the device. For example, the dynamic configurations can be created by the device depending on current available encoding resources. A configuration entity is one of the following: Video source configuration Audio source configuration Video encoder configuration Audio encoder configuration PTZ configuration Video analytics configuration Metadata configuration Audio output configuration Audio decoder configuration A profile consists of all or a subset of these configuration entities. Depending on the capabilities of the device, a particular configuration entity can be part of a profile or not. For example, a profile with an audio source and an audio encoder configuration can exist only in a device with audio support. An example of a complete profile configuration is illustrated in .

A media profile describes how and what to present to the client in a media stream as well as how to handle PTZ input and Analytics. The following commands manage Media Profiles: CreateProfile – Creates a new media profile. GetProfiles – Get one or all existing media profiles. DeleteProfile – Deletes a specific media profile. AddConfiguration – Adds or replaces configuration entities of a media profile. RemoveConfiguration – Removes one or more configuration entities from a media profile. The following commands manage Configuration Entities: Get< entity>ConfigurationOptions – Gets the valid property values for a specific configuration entity. Get<entity>Configurations – Gets one or more configuration entities. The client may request a specific configuration by providing the configuration token, it may specify a profile token to get all compatible configurations. If no token is specified all existing configurations are returned. Set< entity>Configuration – Updates the settings of a configuration entity. Where < entity> is the type of configuration entity. For example, the complete command to get a video encoder configuration is GetVideoEncoderConfiguration. The following commands initiate and manipulate a video/audio stream: GetStreamUri – Requests a valid streaming URI for a specific media profile and protocol. StartMulticastStreaming – Starts multicast streaming using a specified media profile. StopMulticastStreaming – Stops a multicast stream. SetSynchronizationPoint – Inserts a synchronization point (I-frame etc) in active streams. GetSnapshotUri – Requests a URI for a specific media profile that can be used to obtain JPEG snapshots.

A device can have the capability for changing video source mode which is a setting of video source as exclusion in same time. For example, device’s capability for max resolution (1920x1080@16:9 or 2048x1536@4:3) and frame rate (20fps or 30fps) can be changed by selecting each video source modes. The following commands manage video source mode. GetVideoSourceModes - Get a list of video source modes. SetVideoSourceMode - Set video source mode to specified mode.

The media service is used to configure the device media streaming properties. The media service allows a client to configure media and other real time streaming configurations. Media configurations are handled through media profiles. An overview of the ONVIF media configuration model is given in Section . The media service commands are divided into two major categories: Media configuration: Media profile commands Video source commands Video encoder commands Audio source commands Audio encoder commands Video analytics commands Metadata commands Audio output commands Audio decoder commands Media streaming: Request stream URI Get snapshot URI Multicast control commands Media synchronization point A basic set of operations are required for the media service; other operations are recommended to support. The detailed requirements are listed under the command descriptions.

This operation creates a new media profile. The media profile shall be created in the device. A device implementing this service shall support the creation of media profiles as long as the number of existing profiles does not exceed the capability value MaximumNumberOfProfiles. A created profile shall be deletable and a device shall set the “fixed” attribute to false in the returned Profile. request Name [tt:Name] Name of the new profile. Configuration - optional, unbounded [tr2:ConfigurationRef] Optional list of configurations to be added to the new profile. List entries with tr2:ConfigurationEnumeration value "All" shall be ignored. response Token [tt:ReferenceToken] Token assigned to the newly created profile. faults env:Receiver - ter:Action - ter:MaxNVTProfiles The maximum number of supported profiles supported by the device has been reached. env:Receiver - ter:Action - ter:ConfigurationConflict Other configurations of the media profile conflicts with the one to add and adding it would cause a conflicting media profile. env:Sender - ter:InvalidArgVal - ter:NoConfig One of the provided configurations indicated by their ConfigurationToken does not exist. access class ACTUATE

An endpoint can ask for the existing media profiles of a device using the GetProfiles command. Both pre-configured and dynamically created profiles can be retrieved using this command. The token parameter controls which profiles are returned: If no Token is provided this command lists all configured profiles of a device. If a Token is provided the command either lists the referenced profile or responds with an error. The Type parameter controls which configurations are returned and has no effect on the number of profiles returned: 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. A device implementing this service shall support the retrieval of media profiles through the GetProfiles command. request Token - optional [tt:ReferenceToken] Optional token to retrieve exactly one profile. Type - optional, unbounded [xs:string] If one or more types are passed only the corresponding configurations will be returned. response Profiles - optional, unbounded [tr2:MediaProfile] List of profiles. Each profile contains a set of configuration entities defining a specific configuration that can be used for media streaming, analytics, metadata streaming etc. faults env:Sender - ter:InvalidArgVal - ter:NoProfile The requested profile token does not exist. access class READ_MEDIA Note: a client can request an enumeration of profiles without any configuration details by not passing a Type parameter.

This operation adds one or more configurations to an existing media profile. If one of the configuration already exists in the media profile, it will be replaced. A device supporting the Media2 service shall support this command. request ProfileToken [tt:ReferenceToken] Token of an existing profile. Name - optional [tt:Name] The device shall update the name of the profile when this option is provided. Configuration - optional, unbounded [tr2:ConfigurationRef] Optional list of configurations to be added to the profile. List entries with tr2:ConfigurationEnumeration value "All" shall be ignored. response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoProfile The requested profile token does not exist. env:Sender - ter:InvalidArgVal - ter:NoConfig One of the provided configurations indicated by their ConfigurationToken does not exist. env:Receiver - ter:Action - ter:ConfigurationConflict Other configurations of the media profile conflicts with the one to add and adding it would cause a conflicting media profile. access class ACTUATE

This operation removes one or more configurations from an existing media profile. Tokens appearing in the configuration list shall be ignored. Presence of the "All" type shall result in an empty profile. Removing a non-existing configuration shall be ignored and not result in an error. A device supporting the Media2 service shall support this command. request ProfileToken [tt:ReferenceToken] Token of an existing profile. Configuration - unbounded [tr2:ConfigurationRef] List of configurations to be removed from the profile. response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoProfile The requested profile token does not exist. env:Receiver - ter:Action - ter:ConfigurationConflict Other configurations of the media profile are dependant on this configuration and removing it would cause a conflicting state of the media profile. access class ACTUATE

This operation deletes a profile. The device shall support the deletion of a media profile through the DeleteProfile command. A device signaling support for MultiTrackStreaming shall support deleting of virtual profiles via the command. Note that deleting a profile of a virtual profile set may invalidate the virtual profile. request Token [tt:ReferenceToken] Token of an existing profile. response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoProfile The requested profile token does not exist. env:Sender - ter:Action - ter:DeletionOfFixedProfile A fixed Profile cannot be deleted. access class ACTUATE

This operation bundles a set of existing profiles to a so called virtual profile allowing multitrack streaming in a single RTSP session. A device shall except a set of profiles where all VideoSourceConfiguration elements point to different video sources and the device is able to stream the set of video sources as a multitrack stream. If the method succeeds the device shall assign the returned virtual profile token to all profiles associated to the passed list of tokens. Note that a device supporting multitrack streaming is typically shipped with one or more sets of virtual tokens. A client can use the GetProfiles command to retrieve all pre-configured profiles. A device signaling support for MultiTrackStreaming shall support creating virtual profiles via this method. Virtual profiles can be deleted using DeleteProfile. request ProfileToken -unbounded [tt:ReferenceToken] List of existing profile Tokens. response VirtualProfileToken [tt:ReferenceToken] Token assigned to the newly created virtual profile. faults env:Sender - ter:InvalidArgVal - ter:NoProfile One or more passed profile tokens do not exist. env:Sender - ter:InvalidArgVal - ter: InvalidProfileToken The requested profiles can not be put together to create a virtual profile. access class ACTUATE

A media profile consists of a set of media configurations. Media profiles are used by a client to configure properties of a media stream from a device. A device shall provide at least one media profile at boot. A device should provide “ready to use” profiles for the most common media configurations that the device offers. A profile consists of a set of interconnected configuration entities. Configurations are provided by the device and can either be static or created dynamically by the device. For example, the dynamic configurations can be created by the device depending on current available encoding resources. See the following subsections for configuration entity specific constraints. The following subsections enumerate the available configurations. A profile consists of all or a subset of these configuration entities. Depending on the capabilities of the device, a particular configuration entity can be part of a profile or not. For example, a profile with an audio source and an audio encoder configuration can exist only in a device with audio support. A device shall support at least one Analytics Configuration if Analytics service is supported. A device shall support at least one PTZ Configuration if PTZ service is supported. All configurations have the following base parameters Token – The identifier of the configuration.This parameter is read-only and cannot be modified by clients. Name – A configurable name of up to 64 characters. UseCount – Read-only property indicating the number of referenced profiles. Deprecated in Media2 – devices may support this value. Certain configurations in a media profile are dependent on other configurations. In such cases, a device should not allow adding the dependent configuration if the required configuration isn't present. Similarly, a device should not allow removing the required configuration unless the dependent configuration is removed first. Furthermore a device shall allow adding and removing both configurations in the same AddConfiguration respective RemoveConfiguration command. The dependencies are as follow: VideoEncoderConfiguration depends on VideoSourceConfiguration AudioEncoderConfiguration depends on AudioSourceConfiguration PTZConfiguration depends on VideoSourceConfiguration AudioDecoderConfiguration depends on AudioOutputConfiguration MetadataConfiguration depends on VideoSourceConfiguration and/or AudioSourceConfiguration AnalyticsConfiguration depends on VideoSourceConfiguration and/or AudioSourceConfiguration If a dependency is violated in an AddConfiguration or RemoveConfiguration request, a ter:ConfigurationConflict fault should be returned in the response.

A VideoSourceConfiguration contains a reference to a VideoSource and a Bounds structure containing either the whole VideoSource pixel area or a sub-portion of it. The Bounds and VideoSource define the image that is streamed to a client. The origin of the bounds is located in the upper left corner of the video source. The Rotate option specifies an optional rotation of the area defined by the Bounds parameters. Three modes are defined: Off The default value meaning that no rotation is present. The optional Degree shall be ignored. On The device shall apply the rotation value provided by the Degree parameter. If absent a rotation of 180 degree shall be applied. 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 return the current effective rotation via the Degree parameter with the Video source configuration. Note that in case of e.g. a 90 degree rotation the width parameter corresponds to the height of the Video and vice versa. All coordinate systems (e.g. Normalized coordinate system of Privacy Masks in the Media2 Service and pixel based coordinate system of Motion Regions in the Analytics service) that apply to a video source configuration are based on the resulting image after applying the bounds and rotation to the source image. The Lens Description option allows to describe the geometric distortion of the Video Source. For details see . The Scene Orientation options allow a description of the orientation of the scene the video source is capturing. The Scene Orientation can be Below (from the ceiling), Above (from the floor or a table) and Horizon (on a wall). Some devices may support detecting the Scene Orientation automatically. The View Mode option informs a client what type of view is represented by the video source. The view modes enumeration include Fisheye – Undewarped viewmode from a device supporting fisheye lens. 360Panorama – 360 degree panoramic view. 180Panorama – 180 degree panoramic view. Quad – View mode combining four streams in single Quad, eg., applicable for devices supporting four heads. Original – Unaltered view from the sensor. LeftHalf – Viewmode combining the left side sensors, applicable for devices supporting multiple sensors. RightHalf – Viewmode combining the right side sensors, applicable for devices supporting multiple sensors. Dewarp – Dewarped view mode for device supporting fisheye lens. When Fisheye View Mode is present in the VideoSourceConfiguration, the device should also include the LensDescription (see ).

A VideoEncoderConfiguration contains the following parameters for configuring the encoding of video data: Encoding – The Video Media Subtype used to compress the video. See the [IANA Media Type Reference] for a full list of values. Resolution – The pixel resolution of the encoded video data. Quality – Determines the quality of the video. A high value within supported quality range means higher quality. RateControl – Defines parameters to configure the bitrate [kbps] as well as an EncodingInterval parameter (Interval at which images are encoded and transmitted) and a TargetFrameRate [fps] parameter to configure the output framerate. Encoding profile and GOV length [frame]. Signed – Indicates if the stream will be signed according to the Media Signing Specification. TheVideoEncoderConfiguration structure also contains multicast parameters. If the whole RateControl parameter structure is missing the current state of rate control is undefined and vendor specific. A device that supports disabling of the rate control mechanisms shall reflect that by omitting the RateControl element when disabled; otherwise it shall return the current values used for RateControl. If RateControl is missing, the respective options define whether a RateControl element can be (re-)added. The resolution's width and height are based on the Bounds field of the VideoSourceConfiguration. Therefore, if there is a 90-degree rotation, the width will represent the height of the encoded video, and the height will represent the width of the encoded video.

An Audio Source Configuration contains a reference to the AudioSource.

An AudioEncoderConfiguration contains the following parameters for encoding audio data: Encoding – The Audio Media Subtype used to compress the audio. See the [IANA Media Type Reference] for a full list of values. Bitrate – The output bitrate [kbps]. SampleRate – The output sample rate [kHz]. The AudioEncoderConfiguration structure also contains multicast parameters.

A profile with a PTZConfiguration enables the streaming of PTZ status in the metadata stream. Additionally the media profile can be used for controlling PTZ movement as defined in the PTZ Service Specification.

A profile containing a AnalyticsConfiguration enables streams using that media profile to contain analytics data (in the metadata) as defined by the submitted configuration reference. For the configuration of Analytics refer to the ONVIF Analytics Service Specification. When an analytics configuration is present in a profile, the metadata configuration can activate the streaming of the scene description within the RTP streams (see next section). A device may not allow referencing the very same AnalyticsConfiguration from multiple media profiles with different VideoSourceConfigurations. If the device allows it, it shall generate individual scene descriptions for each profile, since the coordinate system of a scene description relates to a specific VideoSourceConfiguration. Also masking and geometrical rules relate to the coordinate system of the VideoSourceConfiguration. This MAY require separate processing of the whole video analytics for each VideoSourceConfiguration, even if they refer to the very same VideoSource.

A profile containing a MetadataConfiguration enables the streaming of metadata. Metadata can consist of events, PTZ status, and/or analytics data. For PTZ transmission of status and position change information can be enabled separately. Event streaming can be enabled and controlled using topic filters. A device signalling MaxContentFilterSize shall support content filtering. For topic and content filter configuration refer to section “Event Handling” of the ONVIF Core Specification. Streaming of scene description can be enabled. Optionally the AnalyticsEngineConfiguration allows to restrict streaming of scene description to the provided list of AnalyticsModules. Note that analytics modules only generate scene description if they are configured in the AnalyticsConfiguration of the profile as defined in section . A device shall ignore any analytics module parameters passed to the SetMetadataConfiguration command and should not list AnalyticsModule/Parameters. The structure also contains multicast parameters used to configure and control multicast of the metadata stream. Devices supporting compressed metadata shall signal available compression algorithm as defined in the MetadataCompressionType. Currently defined compression types are "GZIP" and "EXI". For details on the EXI configuration see .

The audio output configuration contains the following parameters: SourceToken A reference to an existing audio output. OutputLevel A parameter to configure the output volume SendPrimacy A parameter that can be used for devices with a half duplex audio in/output to configure the active transmission direction (see Section ).

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. An optional Send-Primacy Parameter inside the AudioOutputConfiguration indicates which direction is currently active. A client 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 device in this mode. www.onvif.org/ver20/HalfDuplex/Client The client is allowed to send audio data via the backchannel to the server. The device 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.

This command configures the Audio EQPreset, provided it is supported. Refer to the AudioOutputConfigurationOptions response, associated with the audio output, to verify whether the EQPreset is supported and configurable. When a specific EQPreset is designated as the default, it will become active whenever the scheduler is inactive. Additionally, in the event of any conflicts within the scheduler, the default preset will remain active. Only one preset can be set as the default among the EQ presets linked to an audio output. If all presets have isDefault parameter set to false, the device may automatically select one preset as the default. request Configuration - [tt:EQPreset] response This message is empty. faults env:Sender - ter:InvalidArgVal - ter:NoConfig The requested configuration does not exist in the given context. access class WRITE_SYSTEM

The Audio Decoder Configuration does not contain any parameter to configure the decoding . The encodings supported by an audio decoder configuration can be retrieved via the method GetAudioDecoderConfigurationOptions.

The Receiver configuration provides an alternate source for video and audio. It allows to pipe encoded media from an external source which than can be processed and forwarded. For configuration see the ONVIF Receiver Service Specification. A device supporting media profiles with receivers shall allow to add any receiver configuration reported by GetReceivers as long as the profile doesn't include any other video or audio source configuration.

For each supported entity a device shall provide the set of Get<entity>Configuration, Set<entity>Configuration and Get<entity>ConfigurationOptions command.

The Get<entity>Configurations operation allows to retrieve the actual settings of one ore more configurations. The syntax and semantics of the request message are the same for all configuration entities: If a configuration token is provided the device shall respond with the requested configuration or provide an error if it does not exist. In case only a profile token is provided the device shall respond with all configurations that are compatible to the provided media profile. If no tokens are provided the device shall respond with all available configurations. request ProfileToken - optional [tt:ReferenceToken] Optional profile token to retrieve all compatible configurations. ConfigurationToken - optional [tt:ReferenceToken] Optional token to retrieve exactly one configuration. response Configurations - optional, unbounded [tt:<entity>Configuration] List of configurations. faults env:Sender - ter:InvalidArgVal - ter:NoProfile The requested profile token does not exist. env:Sender - ter:InvalidArgVal - ter:NoConfig The requested configuration does not exist in the given context. access class READ_MEDIA

The Set<entity>Configuration operation modifies a configuration. The change may have immediate effect to running streams but the changes are not guaranteed to take effect unless the client restarts any affected stream. Client methods for changing a running stream are out of scope for this specification. request Configuration [tt:<entity>Configuration] The Configuration element contains the modified configuration. The configuration shall exist in the device. response This message is empty. faults env:Sender - ter:InvalidArgVal - ter:NoConfig The requested configuration does not exist in the given context. env:Sender - ter:InvalidArgVal - ter:ConfigModify The configuration parameters are not possible to set. env:Receiver - ter:Action - ter:ConfigurationConflict The new settings conflicts with other uses of the configuration. access class ACTUATE Note for the VideoEncoderConfiguration: if necessary the device may adapt parameter values for Quality and RateControl elements without returning an error. A device shall adapt an out of range BitrateLimit instead of returning a fault. Note for the AudioSourceConfiguration: If the new settings invalidate any parameters already negotiated using RTSP, for example by changing codec type, the device must not apply these settings to existing streams. Instead it must either continue to stream using the old settings or stop sending data on the affected streams. Note for the VideoSourceConfiguration: If a Device supports Rotation and the new settings do not contain Rotate element, a device shall keep current rotation state.

The Get<entity>ConfigurationOptions operation returns the available parameters and their valid ranges to the client. Any combination of the parameters obtained using a given media profile and configuration shall be a valid input for the corresponding set configuration command. If a configuration token is provided, the device shall return the options compatible with that configuration. If a media profile token is specified, the device shall return the options compatible with that media profile. If both a media profile token and a configuration token are specified, the device shall return the options compatible with both that media profile and that configuration. If no tokens are specified, the options shall be considered generic for the device. request ConfigurationToken - optional [tt:ReferenceToken] Optional token to retrieve exactly one configuration. ProfileToken - optional [tt:ReferenceToken] Optional profile token to retrieve all compatible configurations. response ConfigurationOptions - unbounded [tt:<entity>Configuration] Depending on the structure of tr2:Get<entity>ConfigurationOptionsResponse, the options will return one or more elements. Note: entities AudioOutput, AudioSource, Metadata, and VideoSource return just one element. faults env:Sender - ter:InvalidArgVal - ter:NoProfile The requested profile token does not exist. env:Sender - ter:InvalidArgVal - ter:NoConfig The requested configuration does not exist in the given context. env:Sender - ter:InvalidArgVal - ter:IncompatibleConfiguration The requested configuration is not compatible. access class READ_MEDIA

This command provides information on how many video encoders a device can instantiate concurrently for a VideoSourceConfiguration. A device signaling support for VideoEncoder via the ConfigurationsSupported capability shall support this command. The Info response contains the following information: Total Total number of encoder instances independent of the codec, Codec Number of encoder instances for each supported codec . A device shall guarantee to instantiate the indicated number of instances concurrently. If a device limits the number of instances of each particular video encoding type, the response shall contain information per video codec. For each video source, there shall be at least one video source configuration for which the GetVideoEncoderInstances shall return a Total greater than 0. The total sum of video encoder instances over all video source configurations of a device shall not exceed the value signaled via MaximumNumberOfProfiles. For example, if a device has two VideoSourceConfigurations and if the first allows a total of two concurrent instances and the second allows only one instance, this device shall allow creation of at least three media profiles. request ConfigurationToken [tt:ReferenceToken] Token of the configuration. response Info [tr2:EncoderInstanceInfo] This message contains the minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration. faults env:Sender - ter:InvalidArgVal - ter:NoConfig The requested configuration does not exist in the given context. access class READ_MEDIA

This operation requests a URI that can be used to initiate a live media stream using RTSP as the control protocol. The returned URI should remain valid indefinitely even if the parameters of the profile are changed. The following stream types are defined RtspUnicast RTSP streaming RTP via UDP Unicast. RtspMulticast RTSP streaming RTP via UDP Multicast. RTSP RTSP streaming RTP over TCP. RtspsUnicast Secure RTSP streaming SRTP via UDP Unicast. RtspsMulticast Secure RTSP streaming SRTP via UDP Multicast. RtspOverHttp Tunneling both the RTSP control channel and the RTP stream over HTTP or HTTPS. For full compatibility with other ONVIF services a device shall not generate URIs longer than 128 octets. A device that signals the RTSPStreaming capability shall support this command. On a request for transport protocol RtspOverHttp a device shall return a URI that uses the same port as the web service. This enables seamless NAT traversal. A device supporting MultiTrackStreaming shall support the retrieval of a multitrack RTSP session URI by passing a virtual profile token. A device signaling support for SecureRTSPStreaming shall support streaming via SRTP. request Protocol [xs:string] The Protocol defines how the encoded data is expected to be streamed to the client. ProfileToken [tt:ReferenceToken] The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream. response Uri [xs:anyUri] The stable Uri to be used for requesting the media stream. faults env:Sender - ter:InvalidArgVal - ter:NoProfile The requested profile token does not exist. env:Sender - ter:InvalidArgVal - ter:InvalidStreamSetup The specified Protocol is not supported. env:Sender - ter:OperationProhibited - ter:StreamConflict The specified Protocol causes a conflict with another stream. env:Sender - ter:InvalidArgVal - ter:InvalidMulticastSettings No configuration is configured for multicast. env:Sender - ter:InvalidArgVal - ter: InvalidProfileToken Virtual profile token corresponding source could not be spliced together. env:Receiver - ter:Action - ter:IncompleteConfiguration The specified media profile does not have the minimum amount of configurations to have streams. Please add at least one source configuration and one matching encoder configuration. access class READ_MEDIA

A Network client uses the GetSnapshotUri command to obtain a JPEG snapshot from the device. The returned URI shall remain valid indefinitely even if the profile parameters change. The URI can be used for acquiring one or more JPEG images 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) should be taken from the profile if suitable. The provided image shall be updated automatically and independent from calls to GetSnapshotUri. A device shall support this command when the SnapshotUri capability is set to true. request ProfileToken [tt:ReferenceToken] The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream. response Uri [xs:anyUri] Stable Uri to be used for acquiring a snapshot in JPEG format as well as parameters defining the lifetime of the Uri. faults env:Sender - ter:InvalidArgVal - ter:NoProfile The requested profile token does not exist. env:Receiver - ter:Action - ter:IncompleteConfiguration The specified media profile does contain either unused sources or encoder configurations without a corresponding source. access class READ_MEDIA

This specification defines two mechanisms for controlling multicast streams. In addition to setting up multicast sessions via RTSP sessions as defined in section this chapter defines a multicast streaming mechanism were the actual streaming is controlled via IGMP. Use this method with caution, since an incorrect network configuration may result in flooding the network with Audio and Video packets. A device that signals support for non-RTSP controlled multicast streaming by the AutoStartMulticast capability shall support the methods defined in this chapter.

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 be resumed after rebooting. It can be turned off using the StopMulticastStreaming method. The multicast address, port and TTL are configured in the VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration respectively. Multicast streaming may stop when the corresponding profile is deleted or one of its Configurations is altered via one of the set configuration methods. The implementation shall ensure that the RTP stream can be decoded without setting up an RTSP control connection. Especially in case of H.264 video, the SPS/PPS header shall be sent inband. request ProfileToken [tt:ReferenceToken] The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream. response This message is empty. faults env:Sender - ter:InvalidArgVal - ter:NoProfile The requested profile token does not exist. env:Receiver - ter:Action - ter:IncompleteConfiguration The specified media profile does not contain either a reference to a video encoder a video source configuration, to a audio source or to audio encoder configuration or a reference to a metadata configuration access class ACTUATE

This command stops multicast streaming using a specified media profile of a device. In case a device receives a StopMulticastStreaming request whose corresponding multicast streaming is not started, the device should reply with successful StopMulticastStreamingResponse. request ProfileToken [tt:ReferenceToken] The ProfileToken element indicates the media profile to use. response This message is empty. faults env:Sender - ter:InvalidArgVal - ter:NoProfile The requested profile token does not exist. access class ACTUATE

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 forces 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 an event stream is associated to the profile, the synchronization point request shall be handled as described in the section Synchronization Point of the ONVIF Core Specification. If the profile is configured for PTZ metadata, the PTZ position shall be repeated within the metadata stream. A device shall support the request for an I-frame through the SetSynchronizationPoint command if the RTSPStreaming capability is set. If a signed video stream is associated with the profile, the video authenticity data shall be added to the stream. For details see the Media Signing Specification. request ProfileToken [tt:ReferenceToken] Profile reference for which a Synchronization Point is requested. response This message is empty. faults env:Sender - ter:InvalidArgVal - ter:NoProfile The requested profile token does not exist. access class ACTUATE

A device may have the ability to change its video source mode. Different video source modes may affect which options are available in GetVideoSourceConfigurationOptions and GetVideoEncoderConfigurationOptions, such as only allowing 16x9 aspect ratios in one mode and only allowing 4x3 aspect ratios in another, or only allowing 30fps-derived frame rates in one mode and only allowing 25fps-derived frame rates in another. The GetVideoSourceModes command provides summary information about the different modes supported by the device.

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 VideoSourceMode shall support this command. request VideoSourceToken [tt:ReferenceToken] The video source for which the source modes should be retrieved. response VideoSourceMode - unbounded [tr2:VideoSourceMode] List of mode information with capabilities of the respective video source. faults env:Sender - ter:InvalidArgVal - ter:NoVideoSource The requested video source does not exist. access class READ_SYSTEM

SetVideoSourceMode changes the media profile structure relating to video source for the specified video source mode. A device that indicates a capability of VideoSourceMode shall support this command. The behavior after changing the mode is not defined in this specification. request VideoSourceToken [tt:ReferenceToken] The video source for which the source modes should be retrieved. VideoSourceModeToken [tt:ReferenceToken] The token of the video source mode to be set. response Reboot [xs:boolean] information about rebooting after returning response. When Reboot is set “true”, a device will reboot automatically after setting mode. faults env:Sender - ter:InvalidArgVal - ter:NoVideoSource The requested video source does not exist. env:Sender - ter:InvalidArgVal - ter:NoVideoSourceMode The requested video source mode does not exist. access class WRITE_SYSTEM

The OSD service provides functions to enable a client to control and configure On-Screen Display of a device. The service introduces the OSD configuration with multiple types (e.g., image, text, date, and time). Also functions to retrieve and configure the configurations are provided. All OSD configurations are related to a VideoSourceConfiguration which will display the content of OSD.

This chapter defines methods to create and delete OSD configurations as well as gettıng, settıng and querying the options. A device that signals support for OSD via the OSD capability shall support all OSD methods defined in section . Device supporting temporary OSDTextConfiguration, shall notify TemporaryOSDText capability as defined in section . Device shall by default make all OSDTextConfigurations as persistent across reboot, but when IsPersistentText attribute in OSDTextConfiguration is set as false, OSD text content shall be cleared after reboot. OSDConfiguration shall still be valid after reboot.

This operation creates a new OSD configuration with specified values and also makes the association between the new OSD and an existing VideoSourceConfiguration identified by the VideoSourceConfigurationToken. Any value required by a device for a new OSD configuration that is optional and not present in the CreateOSD message may be adapted to the appropriate value by the device. A device that indicates OSD capability shall support the creation of OSD as long as the number of existing OSDs does not exceed the value of MaximumNumberOfOSDs in GetOSDOptions. A created OSD configuration shall be deletable. request OSD [tt:OSDConfiguration] Contains a new OSD configuration with the specified value. The device is responsible for assigning OSD token. OSD token in CreateOSDRequest can be ignored. response OSDToken [tt:ReferenceToken] Token assigned to the newly created configuration. faults env:Receiver - ter:Action - ter:MaxOSDs The maximum number of supported OSDs by the specific VideoSourceConfiguration has been reached. env:Sender - ter:InvalidArgVal - ter:NoConfig One of the provided configurations indicated by their ConfigurationToken does not exist. env:Receiver - ter:InvalidArgVal - ter:ConfigModify The configuration parameters are not possible to set. access class ACTUATE Note: an OSDTextConfiguration without the IsPersistentText attribute shall be interpreted by the device as persistent.

This operation deletes an OSD configuration. request OSDToken [tt:ReferenceToken] Token assigned to the newly created configuration. response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoConfig The requested OSD token OSDToken does not exist. access class ACTUATE

This operation lists existing OSD configurations for the device. The device shall support the listing of existing OSD configurations through the GetOSD command. If neither an OSD token nor a video source configuration token is provided the device shall respond with all available OSD configurations. request OSDToken - optional [tt:ReferenceToken] Token of an existing OSD configuration. If an OSD token is provided the device shall respond with the requested configuration or provide an error if it does not exist. ConfigurationToken - optional [tt:ReferenceToken] In case only a video source configuration token is provided the device shall respond with all configurations that exist for the video source configuration. response OSD - optional, unbounded [tt:OSDConfiguration] List of OSD configurations. faults env:Sender - ter:InvalidArgVal - ter:NoConfig The requested OSD token OSDToken does not exist. access class READ_MEDIA

This operation modifies an OSD configuration. Running streams using this configuration may be immediately updated according to the new settings. A device shall accept any combination of parameters returned by GetOSDOptions. If necessary the device may adapt parameter values for FontColor, FontSize, and BackgroundColor elements without returning an error. Modifying the configuration token is not supported. request OSD [tt:OSDConfiguration] The OSD element contains the modified OSD configuration. The Configuration contains an element that specifies the OSD whose configuration is to be modified. The OSD shall exist in the device. response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoConfig The requested OSD token OSDToken does not exist. env:Receiver - ter:InvalidArgVal - ter:ConfigModify The configuration parameters are not possible to set. access class ACTUATE

This operation returns the available options when the OSD parameters are reconfigured. The device shall support the listing of available OSD parameter options (for a given video source configuration) through the GetOSDOptions command. Any combination of the parameters obtained using a given video source configuration shall be a valid input for the corresponding SetOSD command. request ConfigurationToken - [tt:ReferenceToken] The ConfigurationToken element specifies the video source configuration of which the suitable OSD options are requested. The Video Source Configuration Token shall exist in the device. response OSDOptions [tt:OSDConfigurationOptions] the OSD options which are suitable for the video source configuration specified in the request. faults env:Sender - ter:InvalidArgVal - ter:NoConfig The requested video source configuration ConfigurationToken does not exist. access class READ_MEDIA

The ImageOption section of the GetOSDOptions response contains ImagePath, a list of URIs defining images on the device. If the FormatsSupported attribute of ImageOption is set, any URI in the ImagePath list may be used to upload (POST) an image. Otherwise, the list defines references to images that may have been installed on the device outside of the ONVIF scope. A device that returns the FormatsSupported attribute shall support at least the MIME type image/png. The device shall also return a MaxSize attribute of at least 1024 bytes, or MaxWidth and MaxHeight attributes of at least 16 pixels, or all three attributes. If all three attributes are provided, uploaded images that do not satisfy all three requirements shall be rejected. The number of image paths in ImagePath defines how many images may be stored on the device. When posting an image to one of the URIs, the following HTML status codes may be returned, depending on success or failure: 200 OK or 201 Created Image file was successfully uploaded 401 Unauthorized Attempted POST without authentication credentials at the ACTUATE access policy level. 404 Not Found Attempted POST to a URI not included in ImagePath list 408 Request Timeout POST took too long to upload. 411 Length Required POST does not include Content-Length header 413 Request Entity Too Large File is larger than MaxSize attribute allows, image is larger than MaxWidth or MaxHeight attributes allow, or insufficient device storage space 415 Unsupported Media Type POST does not include Content-Type header, or file MIME type does not match any type in the FormatsSupported attribute's list If an image is successfully uploaded but has a resolution larger than supported by the device, the device shall crop or resize the image and will not return an error. A device that returns the FormatsSupported attribute shall download any OSD image listed in the ImgPath list with the GET method on the URI. The response shall include the appropriate Content-Type HTML header so the client knows how to interpret the image. When retrieving an image from one of the URIs, the following HTML status codes may be returned, depending on success or failure: 200 OK Image file was successfully returned in the response. 401 Unauthorized attempted GET without authentication credentials at the READ_MEDIA access policy. 404 Not Found attempted GET of a URI not included in ImagePath list, or no uploaded image exists at the requested URI location The images returned by GetOSDOptions may be utilized by SetOSD. ImgPath in the SetOSD request may specify any image path listed by GetOSDOptions. If SetOSD specifies a valid image path which does not yet have an associated uploaded image, the device may either treat the image as a 0x0 pixel image, or may return the ter:NoConfig fault.

Privacy Masks allow to cover regions of the image. The device signals via the options how many masks and how many edges each mask may support. Additionally devices may restrict to support rectangle masks only. shows how the mask is defined by a polygon using normalized coordinates relative to the VideoSourceConfiguration window.

A device may support automatic update of the mask location and shape depending on internal operation. Details are outside of the scope of this specification. Depending on the supported options a device may support the following mask types: Color The device signals which color values or ranges are supported. Additionally a device may signal that it supports a single color for all masks of a VideoSourceConfiguration. Blurred The masked area is defocused. Pixelized The masked area is covered with a mosaic.

This operation creates a new Mask for an existing VideoSourceConfiguration. A device that signals support for Masks by the Mask capability shall support the creation of masks via this function as long as the number of existing masks does not exceed the value of MaxMasks for the given VideoSourceConfiguration. A device shall ignore the mask token passed in the command. request Mask [tr2:Mask] Contains the new mask configuration. The device is responsible for assigning the mask token. response Token [tt:ReferenceToken] Token assigned to the newly created mask. faults env:Receiver - ter:Action - ter:MaxMasks The maximum number of supported masks by the specific VideoSourceConfiguration has been reached. env:Sender - ter:InvalidArgVal - ter:NoConfig The provided video source configuration does not exist. env:Receiver - ter:InvalidArgVal - ter:InvalidPolygon The provided polygon is not supported. access class ACTUATE

This operation deletes a mask configuration. request Token [tt:ReferenceToken] Token assigned to the newly created mask. response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoConfig The requested Mask token does not exist. access class ACTUATE

This operation lists existing Mask configurations for the device. A device signaling support for the Mask capability shall support the listing of existing Mask configurations through this command. In case neither a mask nor configuration tokens is provided the device shall respond with all available Mask configurations in the device. request MaskToken - optional [tt:ReferenceToken] If a mask token is provided the device shall respond with the requested configuration or provide an error if it does not exist. ConfigurationToken - optional [tt:ReferenceToken] In case only a video source configuration token is provided the device shall respond with all configurations that exist for the video source configuration. response Mask - optional, unbounded [tr2:Mask] List of masks. faults env:Sender - ter:InvalidArgVal - ter:NoConfig The requested video source configuration or Mask indicated with MaskToken does not exist. access class READ_MEDIA

This operation modifies a mask configuration. Running streams using this configuration may be immediately updated according to the new settings. A device signaling support for Mask via its capabilities support this command. It shall accept any combination of parameters returned by GetMaskOptions. If necessary the device may adapt parameter values for the Color and Polygon element without returning an error. Note that for devices signaling SingleColorOnly all masks of the associated VideoSource will be updated. Note: A device signaling RectangleOnly shall accept any polygon with four points. In case the four vertices are not defining an exact rectangle the device may adjust the vertices. request Mask [tr2:Mask] Contains the new mask configuration. The device is responsible for assigning the mask token. response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoConfig The provided video source configuration does not exist. env:Receiver - ter:InvalidArgVal - ter:ConfigModify The configuration parameters are not possible to set. env:Receiver - ter:InvalidArgVal - ter:InvalidPolygon The provided polygon is not supported. access class ACTUATE

This operation returns the available options when the Mask parameters are reconfigured. A device signaling support for Mask via its capabilities shall support the listing of available Mask parameter options (for a given video source configuration) via this command. Any combination of the parameters obtained using a given video source configuration shall be a valid input for the corresponding SetMask command. request ConfigurationToken [tt:ReferenceToken] Token of an existing configuration for which all existing masks should be listed. response Options [tr2:MaskOptions] This message contains the Mask options which are suitable for the video source configuration specified in the request faults env:Sender - ter:InvalidArgVal - ter:NoConfig The requested video source configuration does not exist. access class READ_MEDIA

This section is about configuring one or more WebRTC signaling servers that a device should connect to, in order to be able to receive requests from clients and establish peer-to-peer WebRTC connections. The signaling protocol that is used for this is descibed in the [ONVIF WebRTC Specification]. A WebRTC configuration has the following parameters: Enabled [xs:boolean] – Enables/disables the configuration. Connected [xs:boolean] – Indicates if the device is connected to the server. This parameter is read-only. SignalingServer [xs:anyURI] – The signaling server URI. CertPathValidationPolicyID [xs:string] - The policy for validating the signaling server certificate. AuthorizationServer [tt: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]. DefaultProfile [tt:ReferenceToken] – The default media profile to use for streaming if no specific profile is specified when initializing a session. Error [xs:string] - Optional user readable error information (readonly).

This operation gets the current WebRTC configuration for the device. The operation shall be supported if the WebRTC capability is present. request This is an empty message. response Configuration - optional, unbounded [tr2:WebRTCConfiguration] This message contains the WebRTC configurations for the device. If empty, no configurations have been configured, faults No command specific faults defined. access class READ_SYSTEM

This operation shall synchronise the tr2:WebRTCConfiguration list with the configuration stored on the device, by creating new entries, updating existing ones, and deleting those omitted from the input. The operation shall be supported if the WebRTC capability is present. The device shall attempt to establish a connection to each signaling server where the Enabled parameter is set to true in the associated tr2:WebRTCConfiguration. request Configuration - optional, unbounded [tr2:WebRTCConfiguration] This message contains the WebRTC configurations to use for the device. If empty, existing WebRTC configurations are deleted. response This is an empty message. faults env:Receiver - ter:Action - ter:MaxWebRTCConfiguration The maximum number of configurations supported by the device has been reached. env:Sender - ter:InvalidArgVal - ter:InvalidConfig The configuration parameters are not possible to set. env:Sender - ter:InvalidArgVal - ter:NoAuthorizationServer The authorization server token does not exist. env:Sender - ter:InvalidArgVal - ter:NoProfile The profile token does not exist. access class WRITE_SYSTEM

This section is about uploading one or more pre-recorded audio clips to the device. The uploaded audio clips can be played by the user on a need basis, for example on a configured schedule, or when an associated event is triggered. The audio clip configuration includes the following parameters: Enabled [xs:boolean] – Enables/disables the audio clip. Name [xs:string] – Name of the audio clip. AudioOutputToken [tt:ReferenceToken] optional, unbounded – Optional token list of physical audio outputs. If no AudioOutputToken is provided, the device should play the audio clip through all physical audio outputs. Type [xs:string] - Format of the audio clip. Supported audio Clip formats includes audio/vnd.wave;codec=1(WAV with LPCM), audio/vnd.wave;codec=7(WAV with G711-ulaw), audio/mpeg(MP3), audio/ogg;codecs=opus, audio/ogg;codecs=vorbis, audio/ogg;codecs=flac, audio/ogg;codecs=speex. RepeatCycles [xs: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 [xs:int] optional - Optional time interval, in seconds, between audio clips when the audio clip is repeated. AudioOutputLevel [xs:int] optional - Optional level to control the volume of the audio clip when it is played. The device should automatically adjust the output level for a particular audio output when the parameter is outside its range. ScheduleToken [tt:ReferenceToken] optional - Optional schedule token associated with the audio clip configuration. The audio clip should be played when the configured schedule is triggered. The device should accept an optional ScheduleToken from the client if it supports the ONVIF Schedule service specification.

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. request Token - optional [tt:ReferenceToken] Token associated with the audio clip. response AudioClipItem - optional, unbounded [tr2:GetAudioClipsResponseItem] List of audio clip items. faults env:Sender - ter:InvalidArgVal - ter:NoAudioClip The audio clip token does not exist. access class READ_SYSTEM

This operation adds audio clip configuration to the device and provides the audio clip upload URI to the client. The response to the command includes an HTTP URL to which the audio clip may be uploaded with in 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 deleted from the device. The device shall return the audio clip configuration in the GetAudioClips API response only after the audio clip has actually been uploaded to the device. request Token - optional[tt:ReferenceToken] Optional token associated with the audio clip. Configuration - [tr2:AudioClip] Audio clip configuration to add. response Token - [tt:ReferenceToken] Unique token of the audio clip to be uploaded. UploadUri - [xs:anyURI] A URL to which the audio clip can be uploaded. ExpiryTime - [xsd:DateTime] Expiry time by which the client should upload the audio clip to the device. faults env:Receiver - ter:Action - ter:MaxAudioClipLimit The maximum number of audio clip configurations supported by the device has been reached. env:Sender - ter:InvalidArgVal - ter:InvalidConfig The configuration parameters are not possible to set. access class WRITE_SYSTEM Note: Audio clip uploads to the device can fail in the following scenarios, and a specific HTTP error code should be returned to the client when an upload fails. When the upload URL has expired, the device should return an HTTP 410 error to the client. When the format of the audio clip upload does not match the Type parameter in the audio clip configuration, the device should return an HTTP 415 Unsupported Media Type error to the client. When the size of the audio clip upload exceeds the MaxAudioClipSize parameter in KB, the device should return an HTTP 413, Request Entity Too Large error to the client.

This operation modifies the existing audio clip configuration on the device. request Token - [tt:ReferenceToken] Unique token associated with the audio clip. Configuration - [tr2:AudioClip] Audio clip configuration to modify. response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoAudioClip The audio clip token does not exist. env:Sender - ter:InvalidArgVal - ter:InvalidConfig The configuration parameters are not possible to set. access class WRITE_SYSTEM Note: The format of the audio clip cannot be changed during the SetAudioClip operation.

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. request Token - [tt:ReferenceToken] Token of the audio clip to be deleted from the device. response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoAudioClip The audio clip token does not exist. env:Sender - ter:InvalidArgVal - ter:AudioClipDeleteError The audio clip cannot be deleted due to the device's current usage. access class WRITE_SYSTEM

This operation plays or stops the ongoing audio clip on the device. If a new audio clip play request is received from the client while another clip is playing, the device shall stop the current audio clip and start the new audio clip. request Token - [tt:ReferenceToken] Token of the audio clip to be played or stopped. AudioOutputToken - optional, unbounded [tt: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. Play - [xs:boolean] If it is true, play the audio clip; if it is false, stop the ongoing audio clip. RepeatCycles - optional [xs: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. response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoAudioClip The audio clip token does not exist. env:Sender - ter:InvalidArgVal - ter:NoAudioOutput The audio output token does not exist. env:Sender - ter:InvalidArgVal - ter:PlayAudioClipError The audio clip is disabled for the play operation. access class READ_SYSTEM

This operation retrieves audio clips information which are playing currently in the device. request This is an empty message. response PlayingAudioClips - optional, unbounded [tr2:PlayingAudioClips] List of audio clips currently playing in the device. faults None access class READ_SYSTEM

The capabilities reflect optional functions and functionality of a service. The information is static and does not change during device operation. request This is an empty message. response Capabilities [tr2:Capabilities2] List of capabilities as defined above. faults None access class PRE_AUTH The following profile capabilites are available: MaximumNumberOfProfiles The sum of fixed and dynamic MediaProfiles supported by the device. A device implementing this service shall provide this capability. ConfigurationsSupported The configurations supported by the device as defined by tr2:ConfigurationEnumeration. The enumeration value "All" shall not be included in this list. A device implementing this service shall provide this capability. SnapshotUri Indicates the support for GetSnapshotUri. Rotation Indicates the support for the Rotation feature. VideoSourceMode Indicates the support for changing video source mode. OSD Indicates support for OSD configuration TemporaryOSDText Indicates the support for temporary osd text configuration. Mask Indicates support for mask configuration. SourceMask 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. The following streaming capabilites are available: RTSPStreaming Indicates the support for live media streaming via RTSP. SecureRTSPStreaming Indicates support for live media streaming via RTSPS and SRTP. RTPMulticast Indication of support of UDP multicasting as described in sections . RTP_RTSP_TCP Indicates the support for RTP/RTSP/TCP transport as defined in section 5.1.1.3 of the ONVIF Streaming Specification. NonAggregateControl Indicates support for non aggregate RTSP control as described in section 5.2.1.1 of the ONVIF Streaming Specification. RTSPWebSocketUri Indicates the support for RTSP/RTP streaming over WebSocket and provides the WebSocket URI, as described in Streaming Specification Section 5.1.1.5. AutoStartMulticast Indicates support for non-RTSP controlled multicast streaming. MultiTrackStreaming Indicates support for multiple video RTP streams in one RTSP session. WebRTC Indicates the supported number of WebRTC configurations. The following media signing capabilites are available: MediaSigningSupported Indicates whether the device supports signing of media according to the Media Signing Specification. The following audio clip Capabilities are available: MaxAudioClipLimit Indicates the maximum number of audio clips that can be uploaded to the device. MaxAudioClipSize Indicates the maximum size of the audio clip that can be uploaded, in KB. SupportedAudioClipFormat Enumerates the supported audio clip formats. See tr2: SupportedAudioClipFormat.

Whenever a profile is created, deleted or one or more of its configurations are added or removed the following event should be generated. ]]>

Whenever a Configuration of a device changes the device should provide the following event. For the parameter Type pass the appropriate ConfigurationEnumeration value. ]]>

A device that supports the media service should provide the “Active Connections” monitoring event to inform a client about the current usage of its Media Profiles. An ONVIF compliant device shall use the following topic and message format: Topic: tns1:Monitoring/Profile/ActiveConnections ]]> NOTE: Active Connections Event is deprecated and its replaced by Active Sessions Event.

A device that supports the media service should provide the "Active Sessions" monitoring events to inform a client about the current usage of its Media Streams. The monitoring events are sent every time a client connects to or disconnects from a unicast stream. An ONVIF compliant device shall use the following topics and message format: ]]> Token refers to the appropriate Video Encoder Configuration, Audio Encoder Configuration, Audio Decoder Configuration, or Metadata Configuration token. Sessions is a space-delimited list of IPv4 and/or IPv6 addresses of active streaming clients. Multiple clients at an IP address, regardless of streaming protocol, shall be repeated once for every client. Sort order of the list is not defined. When the first session associated with an encoding resource connects, the event type is Initialized. When all sessions associated with an encoding resource have disconnected, the event type is Deleted. Example of event for a Video Encoder Configuration with a stream to IPv4 10.220.232.202 and a stream to IPv6 fc80::2934:4e3e:e559:83e9, and then connecting a second stream to 10.220.232.202 (order of Sessions list is undefined; these addresses can appear in any order, but 10.220.232.202 shall appear twice to represent the two streams): tns1:Monitoring/ActiveSessions/VideoEncoder ]]> Example of event for a Metadata Configuration when connecting its first active stream to IPv4 10.220.232.202: tns1:Monitoring/ActiveSessions/Metadata ]]> Example of event for an Audio Encoder Configuration when all active connections are closed: tns1:Monitoring/ActiveSessions/AudioEncoder ]]>

A device that supports AudioClipCapabilities in the GetServiceCapabilities response should generate an audio clip start event when an audio clip starts playing on the device and generate an audio clip stop event when the audio clip stops playing.Token and ClipName parameters can be empty if no audio clip has either started or stopped since the device was last booted. ]]> The "Playing" parameter value is set to true for the audio clip start event and set to false for the audio clip stop event.

EXI encoding allows for a more compact representation of XML metadata. Provision is signaled if the CompressionType returned via GetMetadataConfigurationOptions contains "EXI". The ONVIF defined EXI configuration (see and ) shall be supported by all devices signaling support for EXI compression. The EXI header shall only be transmitted if a setting different then the ONVIF defined configuration is used. Except for the setting of the two elements “Presence Bit” and “EXI Options” the ONVIF defined EXI header settings (see ) shall always be used. Exi header element Value EXI Cookie mandatory Distinguishing Bits mandatory EXI Format Version 0 0000 Presence Bit for EXI Options 0 Exi Options see Padding Bits If present must be “0“. Exi Option Value alignment default (bit-packed) compression default (false) strict default (false) fragment default (false) preserve default (all false) selfContained default (false) schemaID Insert reference to schema obtained from device here. datatypeRepresentationMap none blockSize default (1,000,000) valueMaxLength default (unbounded) valuePartitionCapacity default (unbounded) user defined meta-data none Wide angle lenses produce a geometrically distorted image. The lens description describes where an incoming light beam hits the image sensor. This allows clients to compensate the distortion. This specification describes only the mapping from incoming light beams to sensor location. The actual method of compensating the distortion can be freely chosen by the client and is outside of this specification.

The lens projection function is defined by a set of points. A smooth mapping is achieved by using B-Spline approximation as shown in Figure B-2.

Lens to imager axis offsets can be described via the so-called LensOffset. Figure B-3 depicts that the compensation of a vertical offset results in a shift of the spline curve.