ONVIF Media 2 Service Specification

Transcription

1 ONVIF 1 Media 2 Service Ver ONVIF Media 2 Service Specification Version December, 2017

2 ONVIF 2 Media 2 Service Ver by ONVIF: Open Network Video Interface Forum Inc.. 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.

3 ONVIF 3 Media 2 Service Ver CONTENTS 1 Scope 5 2 Normative references 5 3 Terms and Definitions Definitions Abbreviations Overview Media profiles Video source mode Service Media Profile Methods CreateProfile GetProfiles AddConfiguration RemoveConfiguration DeleteProfile Media Configurations General Video source configuration Video encoder configuration Audio source configuration Audio encoder configuration PTZ Configuration Analytics Configuration Metadata Configuration Audio output configuration Audio decoder configuration Media Configuration Methods General Get<entity>Configurations Set<entity>Configuration Get<entity>ConfigurationOptions GetVideoEncoderInstances Stream URI GetStreamUri Snapshot GetSnapshotUri Multicast StartMulticastStreaming StopMulticastStreaming Synchronization Points SetSynchronizationPoint Video source mode GetVideoSourceModes SetVideoSourceMode OSD (On-Screen Display) General CreateOSD DeleteOSD GetOSDs SetOSD GetOSDOptions... 27

4 ONVIF 4 Media 2 Service Ver OSD Images Privacy Masks General CreateMask DeleteMask GetMasks SetMask GetMaskOptions GetServiceCapabilities Events Profile Change Configuration Change Active Connections Annex A. Efficient XML Interchange (EXI) (Normative) 36 Annex B. Lens Description (Normative) 37 Annex C. Revision History 39

5 ONVIF 5 Media 2 Service Ver Scope 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. 2 Normative references IANA Media Type Reference < ONVIF Core Specification < ONVIF PTZ Service Specification < ONVIF Streaming Specification < 3 Terms and Definitions 3.1 Definitions Configuration Entity Digital PTZ GZIP Media Profile Metadata Reference Token Video Analytics A network video device media abstract component that produces or consumes a media stream on the network, i.e. video and/or audio stream. Function that diminishes or crops an image to adjust the image position and ratio. GNU data format for lossless compression. Maps a video and audio sources and outputs encoders as well as PTZ and analytics configurations. All streaming data except video and audio, including video analytics results, PTZ position data and other metadata (such as textual data from POS applications). Token provided by the device to uniquely reference an instance of a physical IO, configuration or profile. Algorithms or programs used to analyze video data and to generate data describing object location and behaviour. 3.2 Abbreviations RTCP RTP RTSP TCP UDP EXI RTP Control Protocol Realtime Transport Protocol Real Time Streaming Protocol Transmission Control Protocol User Datagram Protocol Efficient XML Interchange Format 4 Overview 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

6 ONVIF 6 Media 2 Service Ver Table 1: Referenced namespaces (with prefix) Prefix env ter xs tt tr2 tns1 Namespace URI Media profiles 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). Figure 1: A media profile 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

7 ONVIF 7 Media 2 Service Ver 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 Figure 2. Media Profile Video Video EncoderConfiguration Video SourceConfiguration VideoSource Audio Audio EncoderConfiguration Audio SourceConfiguration AudioSource Audio Audio DecoderConfiguration Audio OutputConfiguration AudioOutput PTZ Control PTZ Configuration PTZ Node Metadata Analytics PTZ Status Events Analytics Configuration Metadata Configuration Figure 2: Complete profile configuration 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.

8 ONVIF 8 Media 2 Service Ver 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. 4.2 Video source mode 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.

9 ONVIF 9 Media 2 Service Ver Service 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 1. The media service commands are divided into two major categories: Media configuration: o o o o o o o o o 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: o o o o 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.

10 ONVIF 10 Media 2 Service Ver Media Profile Methods CreateProfile 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. 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. Token [tt:referencetoken] Token assigned to the newly created profile. 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. ACTUATE GetProfiles 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.

11 ONVIF 11 Media 2 Service Ver A device implementing this service shall support the retrieval of media profiles through the GetProfiles command. 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. 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. env:sender - ter:invalidargval - ter:noprofile The requested profile token Token does not exist. READ_MEDIA Note: a client can request an enumeration of profiles without any configuration details by not passing a Type paramenter AddConfiguration 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. ProfileToken [tt:referencetoken] Token of an existing profile. Name - optional [tt:name] The device shall update the name of the profile whenthis 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. This is an empty message. env:sender - ter:invalidargval - ter:noprofile The requested profile token 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. ACTUATE

12 ONVIF 12 Media 2 Service Ver RemoveConfiguration 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. ProfileToken [tt:referencetoken] Token of an existing profile. Configuration - unbounded [tr2:configurationref] List of configurations to be removed from the profile. This is an empty message. env:sender - ter:invalidargval - ter:noprofile The requested profile token 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. ACTUATE DeleteProfile This operation deletes a profile. The device shall support the deletion of a media profile through the DeleteProfile command. Token [tt:referencetoken] Token of an existing profile. This is an empty message. env:sender - ter:invalidargval - ter:noprofile The requested profile token Token does not exist. env:sender - ter:action - ter:deletionoffixedprofile A fixed Profile cannot be deleted. ACTUATE 5.2 Media Configurations General 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.

13 ONVIF 13 Media 2 Service Ver 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. All configurations have the following base parameters Token The identifier of the configuration.this parameter is readonly and cannot be modified by clients. Name A configurable name of up to 64 characters. UseCount Readonly 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, the required configuration shall be present before adding the dependent configuration. It shall also be possible to add both configurations in a single AddConfiguration request if they are compatible. Similarly, the required configuration shall not be removed unless the dependent configuration is removed first. Both configurations shall also be removable in a single RemoveConfiguration command. The dependencies are as follow: VideoEncoderConfiguration depends on VideoSourceConfiguration AudioEncoderConfiguration depends on AudioSourceConfiguration PTZConfiguration depends on VideoSourceConfiguration AudioDecoderConfiguration depends on AudioOutputConfiguration If a dependency is violated in an AddConfiguration or RemoveConfiguration request, a ter:configurationconflict fault should be returned in the response Video source configuration 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 Rotate option specifies an optional rotation of the area defined by the Bounds parameters. 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. Privacy Masks in the Media2 Service and Motion Regions in the Analytics service) that apply to a video source configuration are based on the resulting image after applying the Bounds and then Rotate to the source image. The Lens Description option allows to describe the geometric distortion of the Video Source. For details see Annex B. 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.

14 ONVIF 14 Media 2 Service Ver Panrama 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 Video encoder configuration A VideoEncoderConfiguration contains the following parameters for configuring the encoding of video data: Encoding The encoding used to compress the video. See the IANA MIME Type Name 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]. 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 Audio source configuration An Audio Source Configuration contains a reference to the AudioSource Audio encoder configuration An AudioEncoderConfiguration contains the following parameters for encoding audio data: Encoding The encoding used to compress audio. See the IANA MIME Type Name 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.

15 ONVIF 15 Media 2 Service Ver PTZ Configuration A profile with a PTZConfiguration enables the streaming of PTZ status in the metadata stream. Additionaly the media profile can be used for controlling PTZ movement as defined in the PTZ Service Specification Analytics Configuration 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. A device shall return an error (ter:noconfig) if a client attempts to add VideoAnalyticsConfiguration to the Profile when the required source configuration (e.g., VideoSourceConfiguration) is not present. To avoid this error condition, a client may first add a required source configuration (e.g., VideoSourceConfiguration), or may add a required source configuration (e.g., VideoSourceConfiguration) and VideoAnalyticsConfiguration together in a single AddConfiguration command. A device can deny adding a video analytics configuration before a video source configuration. In this case, it should respond with a ConfigurationConflict Fault. 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 Metadata Configuration A profile containing a MetadataConfiguration enables the streaming of metadata. Metadata can consist of events, PTZ status, and/or analytics data. A MetadataConfiguration contains parameters for selecting the data to include in the metadata stream. The choices include PTZ status, PTZ position, events as defined by a subscription and analytics data. The event subscription data is described in the section Event Handling of the ONVIF Core Specification. The analytics parameters define which data to include from the analytics engine part of the profile; see Section 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 Annex A Audio output configuration 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 ) Audio channel modes 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.

16 ONVIF 16 Media 2 Service Ver 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: 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. 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. It is up to the device how to deal with sending and receiving audio data. Acoustic echo cancellation is out of ONVIF scope Audio decoder configuration 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. 5.3 Media Configuration Methods General For each supported entity a device shall provide the set of Get<entity>Configuration, Set<entity>Configuration and Get<entity>ConfigurationOptions command Get<entity>Configurations 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. ProfileToken - optional [tt:referencetoken] Optional profile token to retrieve all compatible configurations. ConfigurationToken - optional [tt:referencetoken] Optional token to retrieve exactly one configuration. Configurations - optional, unbounded [tt:<entity>configuration] List of configurations. env:sender - ter:invalidargval - ter:noprofile The requested profile token token does not exist. env:sender - ter:invalidargval - ter:noconfig The requested configuration does not exist in the given context.

17 ONVIF 17 Media 2 Service Ver READ_MEDIA Set<entity>Configuration 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. Configuration [tt:<entity>configuration] The Configuration element contains the modified configuration. The configuration shall exist in the device. This message is empty. 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. 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 Get<entity>ConfigurationOptions 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. ConfigurationToken - optional [tt:referencetoken] Optional token to retrieve exactly one configuration.

18 ONVIF 18 Media 2 Service Ver ProfileToken - optional [tt:referencetoken] Optional profile token to retrieve all compatible configurations. ConfigurationOptions - unbounded [tt:<entity>configuration] Depending on the structure of tr2:get<entity>configurationoptionsresponse, theoptions will return one or more elements. Note: entities AudioOutput, AudioSource, Metadata, and VideoSource return just one element. env:sender - ter:invalidargval - ter:noprofile The requested profile token token does not exist. env:sender - ter:invalidargval - ter:noconfig The requested configuration does not exist in the given context. READ_MEDIA

19 ONVIF 19 Media 2 Service Ver GetVideoEncoderInstances This command provides information on how many video encoders a device can instantiate concurrently for a VideoSourceConfiguration. A device 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. 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. ConfigurationToken [tt:referencetoken] Token of the configuration. Info [tr2:encoderinstanceinfo] This message contains the minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration. env:sender - ter:invalidargval - ter:noconfig The requested configuration does not exist in the given context. READ_MEDIA

20 ONVIF 20 Media 2 Service Ver Stream URI GetStreamUri 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. 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. 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. Uri [xs:anyuri] The stable Uri to be used for requesting the media stream. env:sender - ter:invalidargval - ter:noprofile The requested profile token 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 Not all configurations are configured for multicast. env:receiver - ter:action - ter:incompleteconfiguration The specified media profile does contain either unused sources or encoder configurations without a corresponding source. READ_MEDIA

21 ONVIF 21 Media 2 Service Ver Snapshot GetSnapshotUri A Network client uses the GetSnapshotUri command to obtain a JPEG snhapshot 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 a 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. ProfileToken [tt:referencetoken] The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream. 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. env:sender - ter:invalidargval - ter:noprofile The requested profile token 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. READ_MEDIA 5.6 Multicast This specification defines two mechanisms for controlling multicast streams. In addition to settting 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 StartMulticastStreaming 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.

22 ONVIF 22 Media 2 Service Ver ProfileToken [tt:referencetoken] The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream. This message is empty. env:sender - ter:invalidargval - ter:noprofile The requested profile token 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 ACTUATE StopMulticastStreaming 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. ProfileToken [tt:referencetoken] The ProfileToken element indicates the media profile to use. This message is empty. env:sender - ter:invalidargval - ter:noprofile The requested profile token token does not exist. ACTUATE 5.7 Synchronization Points SetSynchronizationPoint 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

23 ONVIF 23 Media 2 Service Ver 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. ProfileToken [tt:referencetoken] Profile reference for which a Synchronization Point is requested. This message is empty. env:sender - ter:invalidargval - ter:noprofile The requested profile token token does not exist. ACTUATE 5.8 Video source mode 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 GetVideoSourceModes 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. VideoSourceToken [tt:referencetoken] The video source for which the source modes should be retrieved. VideoSourceMode - unbounded [tr2:videosourcemode] List of mode information with capabilities of the respective video source. env:sender - ter:invalidargval - ter:novideosource The requested video source does not exist. READ_SYSTEM SetVideoSourceMode 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.

24 ONVIF 24 Media 2 Service Ver 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. Reboot [xs:boolean] information about rebooting after returning response. When Reboot is set true, a device will reboot automatically after setting mode. 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. WRITE_SYSTEM

25 ONVIF 25 Media 2 Service Ver OSD (On-Screen Display) General 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. (-1,1) (1,1) CUSTOM_TEXT (Logo Image) (0,0) YYYY-MM-DD HH:MM:SS (-1,-1) (1,-1) Figure 3: Example of screen which have four OSD configurations and coordinate system 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 5.9. 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 CreateOSD 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. 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. OSDToken [tt:referencetoken] Token assigned to the newly created configuration.

26 ONVIF 26 Media 2 Service Ver 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. ACTUATE Note: an OSDTextConfiguration without the IsPersistentText attribute shall be interpreted by the device as persistent DeleteOSD This operation deletes an OSD configuration. OSDToken [tt:referencetoken] Token assigned to the newly created configuration. This is an empty message. env:sender - ter:invalidargval - ter:noconfig The requested OSD token OSDToken does not exist. ACTUATE GetOSDs 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. 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. OSD - optional, unbounded [tt:osdconfiguration] List of OSD configurations.

27 ONVIF 27 Media 2 Service Ver env:sender - ter:invalidargval - ter:noconfig The requested OSD token OSDToken does not exist. READ_MEDIA SetOSD 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. 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. This is an empty message. 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. ACTUATE GetOSDOptions 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. ConfigurationToken - optional [tt:referencetoken] The ConfigurationToken element specifies the video source configuration of which the sutiable OSD options are requested. The Video Source Configuration Token shall exist in the device. OSDOptions [tt:osdconfigurationoptions] the OSD options which are suitable for the video source configuration specified in the request.

28 ONVIF 28 Media 2 Service Ver env:sender - ter:invalidargval - ter:noconfig The requested OSD token OSDToken does not exist. READ_MEDIA OSD Images 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.

29 ONVIF 29 Media 2 Service Ver 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 includethe 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.

30 ONVIF 30 Media 2 Service Ver Privacy Masks General 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. Figure 3 shows how the mask is defined by a polygon using normalized coordinates relative to the VideoSourceConfiguration window. Figure 3: Example of screen with mask and coordinate system 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. Additionaly a device may signal that it supports a single color for all masks of a VideoSourceConfiguration. Blurred The masked area is defocussed. Pixelized The masked area is covered with a mosaic CreateMask 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. Mask [tr2:mask] Contains the new mask configuration. The device is responsible for assigning the mask token. Token [tt:referencetoken] Token assigned to the newly created mask. 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.