Media

Returns the capabilities of the media service.

The result is returned in a typed answer.

This command lists all available physical video inputs of the device.

This command lists all available physical audio inputs of the device.

This command lists all available physical audio outputs of the device.

This operation creates a new empty media profile.

The media profile shall be created in the device and shall be persistent (remain after reboot). A created profile shall be deletable and a device shall set the "fixed" attribute to false in the returned Profile.

If the profile token is already known, a profile can be fetched through the GetProfile command.

Any endpoint can ask for the existing media profiles of a device using the GetProfiles command.

Pre-configured or dynamically configured profiles can be retrieved using this command. This command lists all configured profiles in a device. The client does not need to know the media profile in order to use the command.

This operation adds a VideoEncoderConfiguration to an existing media profile.

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

This operation adds a VideoSourceConfiguration to an existing media profile.

If such a configuration exists in the media profile, it will be replaced. The change shall be persistent.

This operation adds an AudioEncoderConfiguration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent. A device shall support adding a compatible AudioEncoderConfiguration to a profile containing an AudioSourceConfiguration and shall support streaming audio data of such a profile.

This operation adds an AudioSourceConfiguration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent.

This operation adds a PTZConfiguration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent. Adding a PTZConfiguration to a media profile means that streams using that media profile can contain PTZ status (in the metadata), and that the media profile can be used for controlling PTZ movement.

This operation adds a VideoAnalytics configuration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent. Adding a VideoAnalyticsConfiguration to a media profile means that streams using that media profile can contain video analytics data (in the metadata) as defined by the submitted configuration reference. A profile containing only a video analytics configuration but no video source configuration is incomplete. Therefore, a client should first add a video source configuration to a profile before adding a video analytics configuration. The device can deny adding of a video analytics configuration before a video source configuration.

This operation adds a Metadata configuration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent. Adding a MetadataConfiguration to a Profile means that streams using that profile contain metadata. Metadata can consist of events, PTZ status, and/or video analytics data.

This operation adds an AudioOutputConfiguration to an existing media profile.

If a configuration exists in the media profile, it will be replaced. The change shall be persistent.

This operation adds an AudioDecoderConfiguration to an existing media profile.

If a configuration exists in the media profile, it shall be replaced. The change shall be persistent.

This operation removes a VideoEncoderConfiguration from an existing media profile.

If the media profile does not contain a VideoEncoderConfiguration, the operation has no effect. The removal shall be persistent.

This operation removes a VideoSourceConfiguration from an existing media profile.

If the media profile does not contain a VideoSourceConfiguration, the operation has no effect. The removal shall be persistent. Video source configurations should only be removed after removing a VideoEncoderConfiguration from the media profile.

This operation removes an AudioEncoderConfiguration from an existing media profile.

If the media profile does not contain an AudioEncoderConfiguration, the operation has no effect. The removal shall be persistent.

This operation removes an AudioSourceConfiguration from an existing media profile.

If the media profile does not contain an AudioSourceConfiguration, the operation has no effect. The removal shall be persistent. Audio source configurations should only be removed after removing an AudioEncoderConfiguration from the media profile.

This operation removes a PTZConfiguration from an existing media profile.

If the media profile does not contain a PTZConfiguration, the operation has no effect. The removal shall be persistent.

This operation removes a VideoAnalyticsConfiguration from an existing media profile.

If the media profile does not contain a VideoAnalyticsConfiguration, the operation has no effect. The removal shall be persistent.

This operation removes a MetadataConfiguration from an existing media profile.

If the media profile does not contain a MetadataConfiguration, the operation has no effect. The removal shall be persistent.

This operation removes an AudioOutputConfiguration from an existing media profile.

If the media profile does not contain an AudioOutputConfiguration, the operation has no effect. The removal shall be persistent.

This operation removes an AudioDecoderConfiguration from an existing media profile.

If the media profile does not contain an AudioDecoderConfiguration, the operation has no effect. The removal shall be persistent.

This operation deletes a profile.

This change shall always be persistent. Deletion of a profile is only possible for non-fixed profiles

This operation lists all existing video source configurations for a device.

The client need not know anything about the video source configurations in order to use the command.

This operation lists all existing video encoder configurations of a device.

This command lists all configured video encoder configurations in a device. The client need not know anything apriori about the video encoder configurations in order to use the command.

This operation lists all existing audio source configurations of a device.

This command lists all audio source configurations in a device. The client need not know anything apriori about the audio source configurations in order to use the command.

This operation lists all existing device audio encoder configurations.

The client need not know anything apriori about the audio encoder configurations in order to use the command.

This operation lists all video analytics configurations of a device.

This command lists all configured video analytics in a device. The client need not know anything apriori about the video analytics in order to use the command.

This operation lists all existing metadata configurations.

The client need not know anything apriori about the metadata in order to use the command.

This command lists all existing AudioOutputConfigurations of a device.

The NVC need not know anything apriori about the audio configurations to use this command.

This command lists all existing AudioDecoderConfigurations of a device.

The NVC need not know anything apriori about the audio decoder configurations in order to use this command.

If the video source configuration token is already known, the video source configuration can be fetched through the GetVideoSourceConfiguration command.

If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command.

The GetAudioSourceConfiguration command fetches the audio source configurations if the audio source configuration token is already known.

The GetAudioEncoderConfiguration command fetches the encoder configuration if the audio encoder configuration token is known.

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

The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known.

If the audio output configuration token is already known, the output configuration can be fetched through the GetAudioOutputConfiguration command.

If the audio decoder configuration token is already known, the decoder configuration can be fetched through the GetAudioDecoderConfiguration command.

This operation lists all the video encoder configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddVideoEncoderConfiguration command on the media profile. The result will vary depending on the capabilities, configurations and settings in the device.

This operation requests all the video source configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddVideoSourceConfiguration command on the media profile. The result will vary depending on the capabilities, configurations and settings in the device.

This operation requests all audio encoder configurations of a device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddAudioSourceConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.

This operation requests all audio source configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddAudioEncoderConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.

This operation requests all video analytic configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddVideoAnalyticsConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.

This operation requests all the metadata configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddMetadataConfiguration command on the media profile. The result varies depending on the capabilities, configurations and settings in the device.

This command lists all audio output configurations of a device that are compatible with a certain media profile.

Each returned configuration shall be a valid input for the AddAudioOutputConfiguration command.

This operation lists all the audio decoder configurations of the device that are compatible with a certain media profile.

Each of the returned configurations shall be a valid input parameter for the AddAudioDecoderConfiguration command on the media profile.

This operation modifies a video source configuration.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device. 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.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Changes in the Multicast settings shall always be persistent. 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.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device. 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.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device. 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.

A video analytics configuration is modified using this command.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device or not. Running streams using this configuration shall be immediately updated according to the new settings. Otherwise inconsistencies can occur between the scene description processed by the rule engine and the notifications produced by analytics engine and rule engine which reference the very same video analytics configuration token.

This operation modifies a metadata configuration.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Changes in the Multicast settings shall always be persistent. 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.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device.

This operation modifies an audio decoder configuration.

The ForcePersistence flag indicates if the changes shall remain after reboot of the device.

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 GetGuaranteedNumberOfVideoEncoderInstances 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. The ValidUntilConnect, ValidUntilReboot and Timeout Parameter shall be set accordingly (ValidUntilConnect=false, ValidUntilReboot=false, timeout=PT0S).

The correct syntax for the StreamSetup element for these media stream setups defined in 5.1.1 of the streaming specification are as follows:

1. RTP unicast over UDP: StreamType = "RTP_unicast", TransportProtocol = "UDP"
2. RTP over RTSP over HTTP over TCP: StreamType = "RTP_unicast", TransportProtocol = "HTTP"
3. RTP over RTSP over TCP: StreamType = "RTP_unicast", TransportProtocol = "RTSP"

If a multicast stream is requested at least one of VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration shall have a valid multicast setting.

For full compatibility with other ONVIF services a device should not generate Uris longer than 128 octets.

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 stop 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 an HTTP GET operation. The image encoding will always be JPEG regardless of the encoding setting in the media profile. The Jpeg settings (like resolution or quality) may be taken from the profile if suitable. The provided image will be updated automatically and independent from calls to GetSnapshotUri.

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.

Get the OSDs.

Get the OSD.

Get the OSD Options.

Set the OSD.

Create the OSD.

Delete the OSD.