Class: Media

Media()

https://www.onvif.org/specs/srv/media/ONVIF-Media-Service-Spec-v1706.pdf
https://www.onvif.org/ver10/media/wsdl/media.wsdl

Functions

Media#createProfile, Media#getProfiles, Media#getProfile, Media#addVideoSourceConfiguration, Media#addVideoEncoderConfiguration, Media#addAudioSourceConfiguration, Media#addAudioEncoderConfiguration, Media#addPTZConfiguration, Media#addVideoAnalyticsConfiguration, Media#addMetadataConfiguration, Media#addAudioOutputConfiguration, Media#addAudioDecoderConfiguration, Media#removeVideoSourceConfiguration, Media#removeVideoEncoderConfiguration, Media#removeAudioSourceConfiguration, Media#removeAudioEncoderConfiguration, Media#removePTZConfiguration, Media#removeVideoAnalyticsConfiguration, Media#removeMetadataConfiguration, Media#removeAudioOutputConfiguration, Media#removeAudioDecoderConfiguration, Media#deleteProfile, Media#getVideoSources, Media#getVideoSourceConfigurations, Media#getVideoSourceConfiguration, Media#getCompatibleVideoSourceConfigurations, Media#getVideoSourceConfigurationOptions, setVideoSourceConfiguration, Media#getVideoEncoderConfigurations, Media#getVideoEncoderConfiguration, Media#getCompatibleVideoEncoderConfigurations, Media#getVideoEncoderConfigurationOptions, setVideoEncoderConfiguration, Media#getGuaranteedNumberOfVideoEncoderInstances, Media#getAudioSources, Media#getAudioSourceConfigurations, Media#getAudioSourceConfiguration, Media#getCompatibleAudioSourceConfigurations, Media#getAudioSourceConfigurationOptions, setAudioSourceConfiguration, Media#getAudioEncoderConfigurations, Media#getAudioEncoderConfiguration, Media#getCompatibleAudioEncoderConfigurations, Media#getAudioEncoderConfigurationOptions, setAudioEncoderConfiguration, Media#getVideoAnalyticsConfigurations, Media#getVideoAnalyticsConfiguration, Media#getCompatibleVideoAnalyticsConfigurations, setVideoAnalyticsConfiguration, Media#getMetadataConfigurations, Media#getMetadataConfiguration, Media#getCompatibleMetadataConfigurations, Media#getMetadataConfigurationOptions, setMetadataConfiguration, Media#getAudioOutputs, Media#getAudioOutputConfigurations, Media#getAudioOutputConfiguration, Media#getCompatibleAudioOutputConfigurations, Media#getAudioOutputConfigurationOptions, setAudioOutputConfiguration, Media#getAudioDecoderConfigurations, Media#getAudioDecoderConfiguration, Media#getCompatibleAudioDecoderConfigurations, Media#getAudioDecoderConfigurationOptions, setAudioDecoderConfiguration, Media#getStreamUri, Media#getSnapshotUri, Media#startMulticastStreaming, Media#stopMulticastStreaming, Media#setSynchronizationPoint, Media#getVideoSourceModes, setVideoSourceMode, createOSD, Media#deleteOSD, Media#getOSDs, Media#getOSD, setOSD, Media#getOSDOptions

Overview

Constructor

new Media()

Source:

Methods

addAudioDecoderConfiguration(profileToken, configurationToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Reference to the profile where the configuration should be added.
configurationToken string This element contains a reference to the AudioDecoderConfiguration to add.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

addAudioEncoderConfiguration(profileToken, configurationToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Reference to the profile where the configuration should be added.
configurationToken string Contains a reference to the AudioEncoderConfiguration to add.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

addAudioOutputConfiguration(profileToken, configurationToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Reference to the profile where the configuration should be added.
configurationToken string Contains a reference to the AudioOutputConfiguration to add.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

addAudioSourceConfiguration(profileToken, configurationToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Reference to the profile where the configuration should be added
configurationToken string Contains a reference to the AudioSourceConfiguration to add
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

addMetadataConfiguration(profileToken, configurationToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Reference to the profile where the configuration should be added.
configurationToken string Contains a reference to the MetadataConfiguration to add.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

addPTZConfiguration(profileToken, configurationToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Reference to the profile where the configuration should be added.
configurationToken string Contains a reference to the PTZConfiguration to add.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

addVideoAnalyticsConfiguration(profileToken, configurationToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Reference to the profile where the configuration should be added.
configurationToken string Contains a reference to the VideoAnalyticsConfiguration to add.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

addVideoEncoderConfiguration(profileToken, configurationToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Reference to the profile where the configuration should be added
configurationToken string Contains a reference to the VideoEncoderConfiguration to add
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

addVideoSourceConfiguration(profileToken, configurationToken, callbackopt)

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.
The device shall support addition of a video source configuration to a profile through the AddVideoSourceConfiguration command.
Parameters:
Name Type Attributes Description
profileToken string Reference to the profile where the configuration should be added
configurationToken string Contains a reference to the VideoSourceConfiguration to add
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

createProfile(name, tokenopt, callbackopt)

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.
Parameters:
Name Type Attributes Description
name string friendly name of the profile to be created.
token string <optional>
 Optional token, specifying the unique identifier of the new profile.
A device supports at least a token length of 12 characters and characters "A-Z" | "a-z" | "0-9" | "-.".
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

createRequest(body)

Private function for creating a SOAP request.
Parameters:
Name Type Description
body string The body of the xml.
Source:

deleteOSD(OSDToken, callbackopt)

Delete the OSD.
Parameters:
Name Type Attributes Description
OSDToken string This element contains a reference to the OSD configuration that should be deleted.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

deleteProfile(profileToken, callbackopt)

This operation deletes a profile. This change shall always be persistent. Deletion of a profile is only possible for non-fixed profiles
Parameters:
Name Type Attributes Description
profileToken string Contains a reference to the profile that should be deleted.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioDecoderConfiguration(configurationToken, callbackopt)

If the audio decoder configuration token is already known, the decoder configuration can be fetched through the GetAudioDecoderConfiguration command.
Parameters:
Name Type Attributes Description
configurationToken string Token of the requested audio decoder configuration.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioDecoderConfigurationOptions(profileTokenopt, configurationTokenopt, callbackopt)

This command list the audio decoding capabilities for a given profile and configuration of a device.
Parameters:
Name Type Attributes Description
profileToken string <optional>
 Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
configurationToken string <optional>
 Optional audio decoder configuration token that specifies an existing configuration that the options are intended for.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioDecoderConfigurations(callbackopt)

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.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioEncoderConfiguration(configurationToken, callbackopt)

The GetAudioEncoderConfiguration command fetches the encoder configuration if the audio encoder configuration token is known.
Parameters:
Name Type Attributes Description
configurationToken string Token of the requested audio encoder configuration.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioEncoderConfigurationOptions(profileTokenopt, configurationTokenopt, callbackopt)

This operation returns the available options (supported values and ranges for audio encoder configuration parameters) when the audio encoder parameters are reconfigured.
Parameters:
Name Type Attributes Description
profileToken string <optional>
 Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
configurationToken string <optional>
 Optional audio encoder configuration token that specifies an existing configuration that the options are intended for.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioEncoderConfigurations(callbackopt)

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.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioOutputConfiguration(configurationToken, callbackopt)

If the audio output configuration token is already known, the output configuration can be fetched through the GetAudioOutputConfiguration command.
Parameters:
Name Type Attributes Description
configurationToken string Token of the requested audio output configuration.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioOutputConfigurationOptions(profileTokenopt, configurationTokenopt, callbackopt)

This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output.
Parameters:
Name Type Attributes Description
profileToken string <optional>
 Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
configurationToken string <optional>
 Optional audio output configuration token that specifies an existing configuration that the options are intended for.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioOutputConfigurations(callbackopt)

This command lists all existing AudioOutputConfigurations of a device. The NVC need not know anything apriori about the audio configurations to use this command.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioOutputs(callbackopt)

This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioSourceConfiguration(configurationToken, callbackopt)

The GetAudioSourceConfiguration command fetches the audio source configurations if the audio source configuration token is already known.
Parameters:
Name Type Attributes Description
configurationToken string Token of the requested audio source configuration.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioSourceConfigurationOptions(profileTokenopt, configurationTokenopt, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string <optional>
 Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
configurationToken string <optional>
 Optional audio source configuration token that specifies an existing configuration that the options are intended for.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioSourceConfigurations(callbackopt)

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.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getAudioSources(callbackopt)

This command lists all available physical audio inputs of the device.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getCompatibleAudioDecoderConfigurations(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains the token of an existing media profile the configurations shall be compatible with.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getCompatibleAudioEncoderConfigurations(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains the token of an existing media profile the configurations shall be compatible with.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getCompatibleAudioOutputConfigurations(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains the token of an existing media profile the configurations shall be compatible with.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getCompatibleAudioSourceConfigurations(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains the token of an existing media profile the configurations shall be compatible with.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getCompatibleMetadataConfigurations(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains the token of an existing media profile the configurations shall be compatible with.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getCompatibleVideoAnalyticsConfigurations(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains the token of an existing media profile the configurations shall be compatible with.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getCompatibleVideoEncoderConfigurations(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains the token of an existing media profile the configurations shall be compatible with.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getCompatibleVideoSourceConfigurations(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains the token of an existing media profile the configurations shall be compatible with.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getGuaranteedNumberOfVideoEncoderInstances(configurationToken, callbackopt)

The GetGuaranteedNumberOfVideoEncoderInstances command can be used to request the minimum number of guaranteed video encoder instances (applications) per Video Source Configuration.
Parameters:
Name Type Attributes Description
configurationToken string Token of the video source configuration
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getMetadataConfiguration(configurationToken, callbackopt)

The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known.
Parameters:
Name Type Attributes Description
configurationToken string Token of the requested metadata configuration.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getMetadataConfigurationOptions(profileTokenopt, configurationTokenopt, callbackopt)

This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration.
Parameters:
Name Type Attributes Description
profileToken string <optional>
 Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
configurationToken string <optional>
 Optional metadata configuration token that specifies an existing configuration that the options are intended for.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getMetadataConfigurations(callbackopt)

This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getOSD(OSDToken, callbackopt)

Get the OSD.
Parameters:
Name Type Attributes Description
OSDToken string The GetOSD command fetches the OSD configuration if the OSD token is known.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getOSDOptions(configurationToken, callbackopt)

Get the OSD Options.
Parameters:
Name Type Attributes Description
configurationToken string Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getOSDs(configurationTokenopt, callbackopt)

Get the OSDs.
Parameters:
Name Type Attributes Description
configurationToken string <optional>
 Optional token of the Video Source Configuration, which has OSDs associated with are requested. If token not exist, request all available OSDs.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getProfile(profileToken, callbackopt)

If the profile token is already known, a profile can be fetched through the GetProfile command. The device shall support the retrieval of a specific media profile through the GetProfile command.
A device shall include the “fixed” attribute in the returned Profile element.
Parameters:
Name Type Attributes Description
profileToken string this command requests a specific profile
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getProfiles(callbackopt)

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. The device shall support the retrieval of media profiles through the GetProfiles command.
A device shall include the “fixed” attribute in all the returned Profile elements.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getSnapshotUri(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string The ProfileToken element indicates the media profile to use and will define the source and dimensions of the snapshot.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getStreamUri(streamType, protocolType, profileToken, callbackopt)

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:
  • RTP unicast over UDP: StreamType = "RTP_unicast", TransportProtocol = "UDP"
  • RTP over RTSP over HTTP over TCP: StreamType = "RTP_unicast", TransportProtocol = "HTTP"
  • RTP over RTSP over TCP: StreamType = "RTP_unicast", TransportProtocol = "RTSP"
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.
Parameters:
Name Type Attributes Description
streamType RTP-Unicast | RTP-Multicast Defines if a multicast or unicast stream is requested.
protocolType UDP | HTTP | RTSP The transport protocol to use.
profileToken string The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getVideoAnalyticsConfiguration(configurationToken, callbackopt)

The GetVideoAnalyticsConfiguration command fetches the video analytics configuration if the video analytics token is known.
Parameters:
Name Type Attributes Description
configurationToken * Token of the requested video analytics configuration.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getVideoAnalyticsConfigurations(callbackopt)

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.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getVideoEncoderConfiguration(configurationToken, callbackopt)

If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command.
Parameters:
Name Type Attributes Description
configurationToken string Token of the requested video encoder configuration.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getVideoEncoderConfigurationOptions(profileTokenopt, configurationTokenopt, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string <optional>
 Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
configurationToken string <optional>
 Optional video encoder configuration token that specifies an existing configuration that the options are intended for.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getVideoEncoderConfigurations(callbackopt)

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.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getVideoSourceConfiguration(configurationToken, callbackopt)

If the video source configuration token is already known, the video source configuration can be fetched through the GetVideoSourceConfiguration command.
Parameters:
Name Type Attributes Description
configurationToken string Token of the requested video source configuration.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getVideoSourceConfigurationOptions(profileTokenopt, configurationTokenopt, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string <optional>
 Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.
configurationToken string <optional>
 Optional video source configurationToken that specifies an existing configuration that the options are intended for.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getVideoSourceConfigurations(callbackopt)

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.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getVideoSourceModes(videoSourceToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
videoSourceToken string Contains a video source reference for which a video source mode is requested.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

getVideoSources(callbackopt)

This command lists all available physical video inputs of the device.
Parameters:
Name Type Attributes Description
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

init(timeDiff, serviceAddress, usernameopt, passwordopt)

Call this function directly after instantiating a Media object.
Parameters:
Name Type Attributes Description
timeDiff number The onvif device's time difference.
serviceAddress object An url object from url package - require('url').
username string <optional>
 Optional only if the device does NOT have a user.
password string <optional>
 Optional only if the device does NOT have a password.
Source:

removeAudioDecoderConfiguration(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains a reference to the media profile from which the AudioDecoderConfiguration shall be removed.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

removeAudioEncoderConfiguration(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains a reference to the media profile from which the AudioSourceConfiguration shall be removed.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

removeAudioOutputConfiguration(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains a reference to the media profile from which the AudioOutputConfiguration shall be removed.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

removeAudioSourceConfiguration(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains a reference to the media profile from which the AudioSourceConfiguration shall be removed.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

removeMetadataConfiguration(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains a reference to the media profile from which the MetadataConfiguration shall be removed.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

removePTZConfiguration(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains a reference to the media profile from which the PTZConfiguration shall be removed.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

removeVideoAnalyticsConfiguration(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains a reference to the media profile from which the VideoAnalyticsConfiguration shall be removed.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

removeVideoEncoderConfiguration(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains a reference to the media profile from which the VideoEncoderConfiguration shall be removed.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

removeVideoSourceConfiguration(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains a reference to the media profile from which the VideoSourceConfiguration shall be removed.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

setSynchronizationPoint(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains a Profile reference for which a Synchronization Point is requested.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

startMulticastStreaming(profileToken, callbackopt)

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.
Parameters:
Name Type Attributes Description
profileToken string Contains the token of the Profile that is used to define the multicast stream.
callback callback <optional>
 Optional callback, instead of a Promise.
Source:

stopMulticastStreaming(profileToken, callbackopt)

This command stop multicast streaming using a specified media profile of a device.
Parameters:
Name Type Attributes Description
profileToken string Contains the token of the Profile that is used to define the multicast stream.
callback callback <optional>
 Optional callback, instead of a Promise.
Source: