The capabilities for the media service is returned in the Capabilities element. Media profile capabilities. Streaming capabilities. Indicates if GetSnapshotUri is supported. Indicates whether or not Rotation feature is supported. Indicates the support for changing video source mode. Indicates if OSD is supported. Indicates the support for temporary osd text configuration. Indicates if Masking is supported. 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. Maximum number of profiles supported. Enumerates the configurations supported by the device as defined by tr2:ConfigurationEnumeration. Indicates support for live media streaming via RTSP. Indicates support for RTP multicast. Indicates support for RTP/RTSP/TCP. Indicates support for non aggregate RTSP control. If streaming over websocket supported, RTSP websocket URI is provided. The scheme and IP part shall match the one used in the request (e.g. the GetServices request). Indicates support for non-RTSP controlled multicast streaming. Type of the configuration as defined by tr2:ConfigurationEnumeration. Reference token of an existing configuration. Token shall be included in the AddConfiguration request along with the type. Token shall be included in the CreateProfile request when Configuration elements are included and type is selected. Token is optional for RemoveConfiguration request. If no token is provided in RemoveConfiguration request, device shall remove the configuration of the type included in the profile. A set of media configurations. Optional configuration of the Video input. Optional configuration of the Audio input. Optional configuration of the Video encoder. Optional configuration of the Audio encoder. Optional configuration of the analytics module and rule engine. Optional configuration of the pan tilt zoom unit. Optional configuration of the metadata stream. Optional configuration of the Audio output. Optional configuration of the Audio decoder. A media profile consists of a set of media configurations. User readable name of the profile. The configurations assigned to the profile. Unique identifier of the profile. A value of true signals that the profile cannot be deleted. Default is false. friendly name of the profile to be created Optional set of configurations to be assigned to the profile. Token assigned by the device for the newly created profile. Optional token of the requested profile. The types shall be provided as defined by tr2:ConfigurationEnumeration. Lists all profiles that exist in the media service. The response provides the requested types of Configurations as far as available. If a profile doesn't contain a type no error shall be provided. Reference to the profile where the configuration should be added Optional item. If present updates the Name property of the profile. List of configurations to be added. The types shall be provided in the order defined by tr2:ConfigurationEnumeration. This element contains a reference to the media profile from which the AudioDecoderConfiguration shall be removed. List of configurations to be removed. The types shall be provided in the order defined by tr2:ConfigurationEnumeration. This element contains a reference to the profile that should be deleted. Token of the requested configuration. Contains the token of an existing media profile the configurations shall be compatible with. This element contains a list of video encoder configurations. This element contains a list of video source configurations. This element contains a list of audio encoder configurations. This element contains a list of audio source configurations. This element contains a list of Analytics configurations. This element contains a list of metadata configurations This element contains a list of audio output configurations This element contains a list of audio decoder configurations Contains the modified video encoder configuration. The configuration shall exist in the device. Contains the modified video source configuration. The configuration shall exist in the device. Contains the modified audio encoder configuration. The configuration shall exist in the device. Contains the modified audio source configuration. The configuration shall exist in the device. Contains the modified metadata configuration. The configuration shall exist in the device. Contains the modified audio output configuration. The configuration shall exist in the device. Contains the modified audio decoder configuration. The configuration shall exist in the device. This message contains the video source configuration options. If a video source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device. This message contains the audio source configuration options. If a audio source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device. This message contains the audio encoder configuration options. If a audio encoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device. This message contains the metadata configuration options. If a metadata configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device. This message contains the audio output configuration options. If a audio output configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device. This message contains the audio decoder configuration options. If a audio decoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device. Token of the video source configuration Mime name of the video format. For name definitions see tt:VideoEncodingMimeNames and IANA Media Types. The minimum guaranteed number of encoder instances (applications) for the VideoSourceConfiguration. If a device limits the number of instances for respective Video Codecs the response contains the information how many streams can be set up at the same time per VideoSource. The minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration. The device is able to deliver the Total number of streams The minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration. Defines the network protocol for streaming as defined by tr2:TransportProtocol The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream. Stable Uri to be used for requesting the media stream Contains a Profile reference for which a Synchronization Point is requested. The ProfileToken element indicates the media profile to use and will define the source and dimensions of the snapshot. Stable Uri to be used for requesting snapshot images. Contains the token of the Profile that is used to define the multicast stream. Contains a video source reference for which a video source mode is requested. Return the information for specified video source mode. Contains a video source reference for which a video source mode is requested. Indicate video source mode. The response contains information about rebooting after returning response. When Reboot is set true, a device will reboot automatically after setting mode. Indication which encodings are supported for this video source. The list may contain one or more enumeration values of tt:VideoEncoding. Max frame rate in frames per second for this video source mode. Max horizontal and vertical resolution for this video source mode. Indication which encodings are supported for this video source. The list may contain one or more enumeration values of tt:VideoEncoding. After setting the mode if a device starts to reboot this value is true. If a device change the mode without rebooting this value is false. If true, configured parameters may not be guaranteed by the device after rebooting. Informative description of this video source mode. This field should be described in English. Indicate token for video source mode. Indication of whether this mode is active. If active this value is true. In case of non-indication, it means as false. The value of true shall be had by only one video source mode. The GetOSDs command fetches the OSD configuration if the OSD token is known. Token of the Video Source Configuration, which has OSDs associated with are requested. If token not exist, request all available OSDs. This element contains a list of requested OSDs. Contains the modified OSD configuration. Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with. Contain the initial OSD configuration for create. Returns Token of the newly created OSD This element contains a reference to the OSD configuration that should be deleted. Unique identifier of this mask configuration. Geometric representation of the mask area. Type of masking as defined by tr2:MaskType:
  • Color - The masked area is colored with color defined by the Color field.
  • Pixelated - The masked area is filled in mosaic style to hide details.
  • Blurred - The masked area is low pass filtered to hide details.
Color of the masked area. If set the mask will cover the image, otherwise it will be fully transparent.
Token of the mask. Token of the VideoSourceConfiguration the Mask is associated with.
Optional mask token of an existing mask. Optional token of a Video Source Configuration. List of Mask configurations. Mask to be updated. Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with. Maximum supported number of masks per VideoSourceConfiguration. Maximum supported number of points per mask. Information which types of tr2:MaskType are supported. Valid values are 'Color', 'Pixelated' and 'Blurred'. Colors supported. Information whether the polygon must have four points and a rectangular shape. Indicates the device capability of change in color of privacy mask for one video source configuration will automatically be applied to all the privacy masks associated with the same video source configuration. Contain the initial mask configuration for create. Returns Token of the newly created Mask This element contains a reference to the Mask configuration that should be deleted.
Returns the capabilities of the media service. The result is returned in a typed answer. This operation creates a new media profile. A created profile created via this method may be deleted via the DeleteProfile method. Optionally Configurations can be assinged to the profile on creation. For details regarding profile assignement check also the method AddConfiguration. Retrieve the profile with the specified token or all defined media profiles.
  • If no configuration types are defined only the profile names and token are returned.
  • In case of provided configuration types all information regarding these types is returned.
  • If no Type is provided the response shall contain all available configurations. Otherwise only matching configurations shall be returned.
This operation adds one or more Configurations to an existing media profile. If a configuration exists in the media profile, it will be replaced. A device shall support adding a compatible Configuration to a Profile containing a VideoSourceConfiguration and shall support streaming video data of such a profile.
Note that OSD elements must be added via the CreateOSD command.
This operation removes the listed configurations from an existing media profile. If the media profile does not contain one of the listed configurations that item shall be ignored. This operation deletes a profile. Deletion of a profile is only possible for non-fixed profiles By default this operation lists all existing video source configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned. By default this operation lists all existing video encoder configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned. By default this operation lists all existing audio source configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned. By default this operation lists all existing audio encoder configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned. By default this operation lists all existing video analytics configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned. By default this operation lists all existing metadata configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned. By default this operation lists all existing audio output configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned. By default this operation lists all existing audio decoder configurations for a device. Provide a profile token to list only configurations that are compatible with the profile. If a configuration token is provided only a single configuration will be returned. This operation modifies a video source configuration. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream. NVC methods for changing a running stream are out of scope for this specification. This operation modifies a video encoder configuration. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream. NVC methods for changing a running stream are out of scope for this specification.
SessionTimeout is provided as a hint for keeping rtsp session by a device. If necessary the device may adapt parameter values for SessionTimeout elements without returning an error. For the time between keep alive calls the client shall adhere to the timeout value signaled via RTSP.
This operation modifies an audio source configuration. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream NVC methods for changing a running stream are out of scope for this specification. This operation modifies an audio encoder configuration. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected streams. NVC methods for changing a running stream are out of scope for this specification. This operation modifies a metadata configuration. Running streams using this configuration may be updated immediately according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected streams. NVC methods for changing a running stream are out of scope for this specification. This operation modifies an audio output configuration. This operation modifies an audio decoder configuration. This operation returns the available options (supported values and ranges for video source configuration parameters) when the video source parameters are reconfigured If a video source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. This operation returns the available options (supported values and ranges for video encoder configuration parameters) when the video encoder parameters are reconfigured.
For JPEG, MPEG4 and H264 extension elements have been defined that provide additional information. A device must provide the XxxOption information for all encodings supported and should additionally provide the corresponding XxxOption2 information.
This response contains the available video encoder configuration options. If a video encoder configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. If no tokens are specified, the options shall be considered generic for the device.
This operation returns the available options (supported values and ranges for audio source configuration parameters) when the audio source parameters are reconfigured. If an audio source configuration is specified, the options shall concern that particular configuration. If a media profile is specified, the options shall be compatible with that media profile. This operation returns the available options (supported values and ranges for audio encoder configuration parameters) when the audio encoder parameters are reconfigured. This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration. This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output. This command list the audio decoding capabilities for a given profile and configuration of a device. The GetVideoEncoderInstances command can be used to request the minimum number of guaranteed video encoder instances (applications) per Video Source Configuration. This operation requests a URI that can be used to initiate a live media stream using RTSP as the control protocol. The returned URI shall remain valid indefinitely even if the profile is changed.
Defined stream types are
  • RtspUnicast RTSP streaming RTP as UDP Unicast.
  • RtspMulticast RTSP streaming RTP as UDP Multicast.
  • RTSP RTSP streaming RTP over TCP.
  • RtspOverHttp Tunneling both the RTSP control channel and the RTP stream over HTTP or HTTPS.
If a multicast stream is requested the VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration element inside the corresponding media profile must be configured with valid multicast settings.
For full compatibility with other ONVIF services a device should not generate Uris longer than 128 octets.
This command starts multicast streaming using a specified media profile of a device. Streaming continues until StopMulticastStreaming is called for the same Profile. The streaming shall continue after a reboot of the device until a StopMulticastStreaming request is received. The multicast address, port and TTL are configured in the VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration respectively. This command stops multicast streaming using a specified media profile of a device Synchronization points allow clients to decode and correctly use all data after the synchronization point. For example, if a video stream is configured with a large I-frame distance and a client loses a single packet, the client does not display video until the next I-frame is transmitted. In such cases, the client can request a Synchronization Point which enforces the device to add an I-Frame as soon as possible. Clients can request Synchronization Points for profiles. The device shall add synchronization points for all streams associated with this profile. Similarly, a synchronization point is used to get an update on full PTZ or event status through the metadata stream. If a video stream is associated with the profile, an I-frame shall be added to this video stream. If a PTZ metadata stream is associated to the profile, the PTZ position shall be repeated within the metadata stream. A client uses the GetSnapshotUri command to obtain a JPEG snapshot from the device. The returned URI shall remain valid indefinitely even if the profile is changed. The ValidUntilConnect, ValidUntilReboot and Timeout Parameter shall be set accordingly (ValidUntilConnect=false, ValidUntilReboot=false, timeout=PT0S). The URI can be used for acquiring a JPEG image through 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) may be taken from the profile if suitable. The provided image will be updated automatically and independent from calls to GetSnapshotUri. A device returns the information for current video source mode and settable video source modes of specified video source. A device that indicates a capability of VideoSourceModes shall support this command. SetVideoSourceMode changes the media profile structure relating to video source for the specified video source mode. A device that indicates a capability of VideoSourceModes shall support this command. The behavior after changing the mode is not defined in this specification. This operation lists existing OSD configurations for the device.
  • If an OSD token is provided the device shall respond with the requested configuration or provide an error if it does not exist.
  • In case only a video source configuration token is provided the device shall respond with all configurations that exist for the video source configuration.
  • If no tokens are provided the device shall respond with all available OSD configurations.
Get the OSD Options. Set the OSD Create the OSD. Delete the OSD. This operation lists existing Mask configurations for the device.
  • If an Mask token is provided the device shall respond with the requested configuration or provide an error if it does not exist.
  • In case only a video source configuration token is provided the device shall respond with all configurations that exist for the video source configuration.
  • If no tokens are provided the device shall respond with all available Mask configurations.
Get the Mask Options. Set the Mask Create the Mask. Delete the Mask.