Interface Media2

Media2 service, ver20 (Profile T profiles, configurations, OSD, stream URI).

Example: Profiles with configurations, stream / snapshot URI, and OSD list:

import { Onvif } from 'onvif';

const onvif = new Onvif({ hostname: '192.168.1.13', username: 'admin', password: 'admin' });
await onvif.connect();

const profiles = await onvif.media2.getProfiles({ type: ['All'] });
const profileToken = profiles[0]!.token;
const encoders = await onvif.media2.getVideoEncoderConfigurations({ profileToken });
console.log(profiles[0]?.name, encoders[0]?.encoding, encoders[0]?.resolution);

const { uri } = await onvif.media2.getStreamUri({ profileToken, protocol: 'RtspUnicast' });
const snap = await onvif.media2.getSnapshotUri({ profileToken });
console.log(uri, snap.uri);

const sources = await onvif.media2.getVideoSourceConfigurations({ profileToken });
const osds = await onvif.media2.getOSDs({ configurationToken: sources[0]!.token });
console.log('OSDs', osds.map((o) => o.token));

interface Media2 {
    onvif: Onvif;
    service: keyof OnvifServices;
    xmlns: string;
    addConfiguration(options: AddConfigurationExtended): Promise<void>;
    createMask(options: Mask): Promise<string>;
    createOSD(options: OSDConfiguration): Promise<string>;
    createProfile(options: CreateProfileExtended): Promise<string>;
    deleteMask(token: DeleteMask): Promise<void>;
    deleteOSD(OSDToken: DeleteOSD): Promise<void>;
    deleteProfile(options: DeleteProfile): Promise<void>;
    getAnalyticsConfigurations(
        options?: GetAnalyticsConfigurations,
    ): Promise<VideoAnalyticsConfiguration[]>;
    getAudioDecoderConfigurationOptions(
        options?: GetConfiguration,
    ): Promise<AudioDecoderConfigurationOptions>;
    getAudioDecoderConfigurations(
        options?: GetAudioDecoderConfigurations,
    ): Promise<AudioDecoderConfiguration[]>;
    getAudioEncoderConfigurationOptions(
        options?: GetConfiguration,
    ): Promise<AudioEncoderConfigurationOption[]>;
    getAudioEncoderConfigurations(
        options?: GetAudioEncoderConfigurations,
    ): Promise<AudioEncoder2Configuration[]>;
    getAudioOutputConfigurationOptions(
        options?: GetConfiguration,
    ): Promise<AudioOutputConfigurationOptions>;
    getAudioOutputConfigurations(
        options?: GetAudioOutputConfigurations,
    ): Promise<AudioOutputConfigurationExtended[]>;
    getAudioSourceConfigurationOptions(
        options?: GetConfiguration,
    ): Promise<AudioSourceConfigurationOptions>;
    getAudioSourceConfigurations(
        options?: GetAudioSourceConfigurations,
    ): Promise<AudioSourceConfiguration[]>;
    getMaskOptions(configurationToken: GetMaskOptions): Promise<MaskOptions>;
    getMasks(options?: GetMasks): Promise<Mask[]>;
    getMetadataConfigurationOptions(
        options?: GetConfiguration,
    ): Promise<MetadataConfigurationOptions>;
    getMetadataConfigurations(
        options?: GetMetadataConfigurations,
    ): Promise<MetadataConfiguration[]>;
    getOSDOptions(
        options?: Partial<GetOSDOptions>,
    ): Promise<OSDConfigurationOptions>;
    getOSDs(options?: GetOSDs): Promise<OSDConfiguration[]>;
    getProfiles(options?: GetProfiles): Promise<MediaProfile[]>;
    getServiceCapabilities(): Promise<Capabilities2>;
    getSnapshotUri(options?: GetSnapshotUri): Promise<GetSnapshotUriResponse>;
    getStreamUri(
        __namedParameters: GetStreamUri,
    ): Promise<GetStreamUriResponse>;
    getVideoEncoderConfigurationOptions(
        options?: GetConfiguration,
    ): Promise<VideoEncoder2ConfigurationOptions[]>;
    getVideoEncoderConfigurations(
        options?: GetVideoEncoderConfigurations,
    ): Promise<VideoEncoder2Configuration[]>;
    getVideoEncoderInstances(
        options: GetVideoEncoderInstances,
    ): Promise<EncoderInstanceInfo>;
    getVideoSourceConfigurationOptions(
        options?: GetConfiguration,
    ): Promise<VideoSourceConfigurationOptions>;
    getVideoSourceConfigurations(
        options?: GetVideoSourceConfigurations,
    ): Promise<VideoSourceConfiguration[]>;
    getVideoSourceModes(
        options?: GetVideoSourceModes,
    ): Promise<VideoSourceMode[]>;
    getWebRTCConfigurations(): Promise<WebRTCConfiguration[]>;
    removeConfiguration(options: RemoveConfigurationExtended): Promise<void>;
    request<T = any>(
        body: OnvifSoapBody,
        options?: LineraseOptions,
    ): Promise<T>;
    setAudioDecoderConfiguration(
        configuration: AudioDecoderConfiguration,
    ): Promise<void>;
    setAudioEncoderConfiguration(
        configuration: AudioEncoder2Configuration,
    ): Promise<void>;
    setAudioOutputConfiguration(
        configuration: AudioOutputConfigurationExtended,
    ): Promise<void>;
    setAudioSourceConfiguration(
        configuration: AudioSourceConfiguration,
    ): Promise<void>;
    setMask(options: Mask): Promise<void>;
    setMetadataConfiguration(
        configuration: MetadataConfiguration,
    ): Promise<void>;
    setOSD(options: OSDConfiguration): Promise<void>;
    setSynchronizationPoint(options?: SetSynchronizationPoint): Promise<void>;
    setVideoEncoderConfiguration(
        configuration: VideoEncoder2Configuration,
    ): Promise<void>;
    setVideoSourceConfiguration(
        configuration: VideoSourceConfiguration,
    ): Promise<void>;
    setVideoSourceMode(options: SetVideoSourceMode): Promise<void>;
    startMulticastStreaming(
        profileToken?: StartMulticastStreaming,
    ): Promise<void>;
    stopMulticastStreaming(
        profileToken?: StopMulticastStreaming,
    ): Promise<void>;
}

Hierarchy (View Summary)

Service
- Media2

Index

Properties

onvif service xmlns

Methods

addConfiguration createMask createOSD createProfile deleteMask deleteOSD deleteProfile getAnalyticsConfigurations getAudioDecoderConfigurationOptions getAudioDecoderConfigurations getAudioEncoderConfigurationOptions getAudioEncoderConfigurations getAudioOutputConfigurationOptions getAudioOutputConfigurations getAudioSourceConfigurationOptions getAudioSourceConfigurations getMaskOptions getMasks getMetadataConfigurationOptions getMetadataConfigurations getOSDOptions getOSDs getProfiles getServiceCapabilities getSnapshotUri getStreamUri getVideoEncoderConfigurationOptions getVideoEncoderConfigurations getVideoEncoderInstances getVideoSourceConfigurationOptions getVideoSourceConfigurations getVideoSourceModes getWebRTCConfigurations removeConfiguration request setAudioDecoderConfiguration setAudioEncoderConfiguration setAudioOutputConfiguration setAudioSourceConfiguration setMask setMetadataConfiguration setOSD setSynchronizationPoint setVideoEncoderConfiguration setVideoSourceConfiguration setVideoSourceMode startMulticastStreaming stopMulticastStreaming

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

addConfiguration

addConfiguration(options: AddConfigurationExtended): Promise<void>
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.
Parameters
- options: AddConfigurationExtended
  - Optionalconfiguration?: ConfigurationRefExtended[]
    
    List of configurations to be added. The types shall be provided in the order defined by tr2:ConfigurationEnumeration. List entries with tr2:ConfigurationEnumeration value "All" shall be ignored.
  - Optionalname?: string
    
    Optional item. If present updates the Name property of the profile.
  - OptionalprofileToken?: string
    
    Reference to the profile where the configuration should be added
Returns Promise<void>
- Defined in media2.ts:226

createMask

createMask(options: Mask): Promise<string>

Create the Mask.

Parameters

options: Mask

Returns Promise<string>

Token of the newly created mask

Example

const token = await cam.media2.createMask({
    type: 'Color',
    token: 'mask_token_1',
    color: { x: 1, y: 2, z: 3, colorspace: 'http://www.onvif.org/ver10/colorspace/YCbCr' },
    configurationToken: 'VideoSourceConfigurationToken_1',
    enabled: true,
    polygon: {
      point: [{ x: 0.1, y: 0.1 }, { x: 0.2, y: 0.2 }, { x: 0.3, y: 0.3 }],
    }
  });

createOSD

createOSD(options: OSDConfiguration): Promise<string>
Create the OSD. NB!: Unlike the reference implementation, this method returns the generated token, since not all implementations allow you to specify the token yourself; it is often generated on the server side.
Parameters
- options: OSDConfiguration
Returns Promise<string>
Token of the newly created OSD
- Defined in media2.ts:1030

createProfile

createProfile(options: CreateProfileExtended): Promise<string>
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 assigned to the profile on creation. For details regarding profile assignment check also the method AddConfiguration.
Parameters
- options: CreateProfileExtended
  - Optionalconfiguration?: ConfigurationRefExtended[]
    
    Optional set of configurations to be assigned to the profile. List entries with tr2:ConfigurationEnumeration value "All" shall be ignored.
  - name: string
    
    friendly name of the profile to be created
Returns Promise<string>
- Defined in media2.ts:199

deleteMask

deleteMask(token: DeleteMask): Promise<void>
Delete the Mask.
Parameters
- token: DeleteMask
Returns Promise<void>
- Defined in media2.ts:1230

deleteOSD

deleteOSD(OSDToken: DeleteOSD): Promise<void>
Delete the OSD.
Parameters
- OSDToken: DeleteOSD
Returns Promise<void>
- Defined in media2.ts:1085

deleteProfile

deleteProfile(options: DeleteProfile): Promise<void>
This operation deletes a profile. The device shall support the deletion of a media profile through the DeletePro- file command. A device signaling support for MultiTrackStreaming shall support deleting of virtual profiles via the command. Note that deleting a profile of a virtual profile set may invalidate the virtual profile.
Parameters
- options: DeleteProfile
  - token: string
    
    This element contains a reference to the profile that should be deleted.
Returns Promise<void>
- Defined in media2.ts:273

getAnalyticsConfigurations

getAnalyticsConfigurations(
options?: GetAnalyticsConfigurations,
): Promise<VideoAnalyticsConfiguration[]>
The getAnalyticsConfigurations operation allows to retrieve the analytics settings of one ore more configurations.
- 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.
Parameters
- Optionaloptions: GetAnalyticsConfigurations
  - OptionalconfigurationToken?: string
    
    Token of the requested configuration.
  - OptionalprofileToken?: string
    
    Contains the token of an existing media profile the configurations shall be compatible with.
Returns Promise<VideoAnalyticsConfiguration[]>
- Defined in media2.ts:388

getAudioDecoderConfigurationOptions

getAudioDecoderConfigurationOptions(
options?: GetConfiguration,
): Promise<AudioDecoderConfigurationOptions>
This command list the audio decoding capabilities for a given profile and configuration of a device.
Parameters
- options: GetConfiguration = {}
Returns Promise<AudioDecoderConfigurationOptions>
- Defined in media2.ts:818

getAudioDecoderConfigurations

getAudioDecoderConfigurations(
options?: GetAudioDecoderConfigurations,
): Promise<AudioDecoderConfiguration[]>
The getAudioDecoderConfigurations operation allows to retrieve the audio decoder settings of one ore more configurations.
- 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.
Parameters
- Optionaloptions: GetAudioDecoderConfigurations
  - OptionalconfigurationToken?: string
    
    Token of the requested configuration.
  - OptionalprofileToken?: string
    
    Contains the token of an existing media profile the configurations shall be compatible with.
Returns Promise<AudioDecoderConfiguration[]>
- Defined in media2.ts:441

getAudioEncoderConfigurationOptions

getAudioEncoderConfigurationOptions(
options?: GetConfiguration,
): Promise<AudioEncoderConfigurationOption[]>
This operation returns the available options (supported values and ranges for audio encoder configuration parameters) when the audio encoder parameters are reconfigured.
Parameters
- options: GetConfiguration = {}
Returns Promise<AudioEncoderConfigurationOption[]>
- Defined in media2.ts:785

getAudioEncoderConfigurations

getAudioEncoderConfigurations(
options?: GetAudioEncoderConfigurations,
): Promise<AudioEncoder2Configuration[]>
The getAudioEncoderConfigurations operation allows to retrieve the audio encoder settings of one ore more configurations.
- 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.
Parameters
- Optionaloptions: GetAudioEncoderConfigurations
  - OptionalconfigurationToken?: string
    
    Token of the requested configuration.
  - OptionalprofileToken?: string
    
    Contains the token of an existing media profile the configurations shall be compatible with.
Returns Promise<AudioEncoder2Configuration[]>
- Defined in media2.ts:371

getAudioOutputConfigurationOptions

getAudioOutputConfigurationOptions(
options?: GetConfiguration,
): Promise<AudioOutputConfigurationOptions>
This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output. To retrieve the EQPresetList, a valid ConfigurationToken must be provided. If EQPreset is supported and isFrequencyDecibelEditable is signaled as true, the response shall include the FrequencyDecibelPair.
Parameters
- options: GetConfiguration = {}
Returns Promise<AudioOutputConfigurationOptions>
- Defined in media2.ts:809

getAudioOutputConfigurations

getAudioOutputConfigurations(
options?: GetAudioOutputConfigurations,
): Promise<AudioOutputConfigurationExtended[]>
The getAudioOutputConfigurations operation allows to retrieve the audio output settings of one ore more configurations.
- 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.
Parameters
- Optionaloptions: GetAudioOutputConfigurations
  - OptionalconfigurationToken?: string
    
    Token of the requested configuration.
  - OptionalprofileToken?: string
    
    Contains the token of an existing media profile the configurations shall be compatible with.
Returns Promise<AudioOutputConfigurationExtended[]>
- Defined in media2.ts:422

getAudioSourceConfigurationOptions

getAudioSourceConfigurationOptions(
options?: GetConfiguration,
): Promise<AudioSourceConfigurationOptions>
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
- options: GetConfiguration = {}
Returns Promise<AudioSourceConfigurationOptions>
- Defined in media2.ts:775

getAudioSourceConfigurations

getAudioSourceConfigurations(
options?: GetAudioSourceConfigurations,
): Promise<AudioSourceConfiguration[]>
The getAudioSourceConfigurations operation allows to retrieve the audio source settings of one ore more configurations.
- 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.
Parameters
- Optionaloptions: GetAudioSourceConfigurations
  - OptionalconfigurationToken?: string
    
    Token of the requested configuration.
  - OptionalprofileToken?: string
    
    Contains the token of an existing media profile the configurations shall be compatible with.
Returns Promise<AudioSourceConfiguration[]>
- Defined in media2.ts:354

getMaskOptions

getMaskOptions(configurationToken: GetMaskOptions): Promise<MaskOptions>
Get the Mask Options.
Parameters
- configurationToken: GetMaskOptions
Returns Promise<MaskOptions>
Example
```
const res = await cam.media2.getMaskOptions({ configurationToken: 'MaskToken_1' });
console.log(res.types);
```
- Defined in media2.ts:1216

getMasks

getMasks(options?: GetMasks): Promise<Mask[]>
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.
Parameters
- Optionaloptions: GetMasks
Returns Promise<Mask[]>
- Defined in media2.ts:1101

getMetadataConfigurationOptions

getMetadataConfigurationOptions(
options?: GetConfiguration,
): Promise<MetadataConfigurationOptions>
This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration.
Parameters
- options: GetConfiguration = {}
Returns Promise<MetadataConfigurationOptions>
- Defined in media2.ts:797

getMetadataConfigurations

getMetadataConfigurations(
options?: GetMetadataConfigurations,
): Promise<MetadataConfiguration[]>
The getMetadataConfigurations operation allows to retrieve the metadata settings of one ore more configurations.
- 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.
Parameters
- Optionaloptions: GetMetadataConfigurations
  - OptionalconfigurationToken?: string
    
    Token of the requested configuration.
  - OptionalprofileToken?: string
    
    Contains the token of an existing media profile the configurations shall be compatible with.
Returns Promise<MetadataConfiguration[]>
- Defined in media2.ts:405

getOSDOptions

getOSDOptions(
options?: Partial<GetOSDOptions>,
): Promise<OSDConfigurationOptions>
Get the OSD Options.
Parameters
- options: Partial<GetOSDOptions> = {}
Returns Promise<OSDConfigurationOptions>
- Defined in media2.ts:1006

getOSDs

getOSDs(options?: GetOSDs): Promise<OSDConfiguration[]>
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.
Parameters
- Optionaloptions: GetOSDs
Returns Promise<OSDConfiguration[]>
- Defined in media2.ts:933

getProfiles

getProfiles(options?: GetProfiles): Promise<MediaProfile[]>
Retrieve the profile with the specified token or all defined media profiles.
- 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.
Parameters
- options: GetProfiles = {}
  - Optionaltoken?: string
    
    Optional token of the requested profile.
  - Optionaltype?: string[]
    
    The types shall be provided as defined by tr2:ConfigurationEnumeration.
Returns Promise<MediaProfile[]>
- Defined in media2.ts:177

getServiceCapabilities

getServiceCapabilities(): Promise<Capabilities2>
Returns the capabilities of the media service. The result is returned in a typed answer.

Returns Promise<Capabilities2>
- Defined in media2.ts:160

getSnapshotUri

getSnapshotUri(options?: GetSnapshotUri): Promise<GetSnapshotUriResponse>
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 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.
Parameters
- Optionaloptions: GetSnapshotUri
Returns Promise<GetSnapshotUriResponse>
- Defined in media2.ts:1272

getStreamUri

getStreamUri(__namedParameters: GetStreamUri): Promise<GetStreamUriResponse>
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 at least one of VideoEncoder2Configuration, AudioEncoder2Configuration and MetadataConfiguration shall have a valid multicast setting.
Parameters
- __namedParameters: GetStreamUri
Returns Promise<GetStreamUriResponse>
- Defined in media2.ts:1252

getVideoEncoderConfigurationOptions

getVideoEncoderConfigurationOptions(
options?: GetConfiguration,
): Promise<VideoEncoder2ConfigurationOptions[]>
This operation returns the available options (supported values and ranges for video encoder configuration parameters) when the video encoder parameters are reconfigured.

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
- options: GetConfiguration = {}
Returns Promise<VideoEncoder2ConfigurationOptions[]>
- Defined in media2.ts:761

getVideoEncoderConfigurations

getVideoEncoderConfigurations(
options?: GetVideoEncoderConfigurations,
): Promise<VideoEncoder2Configuration[]>
The getVideoEncoderConfigurations operation allows to retrieve the video encoder settings of one ore more configurations.
- 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.
Parameters
- Optionaloptions: GetVideoEncoderConfigurations
  - OptionalconfigurationToken?: string
    
    Token of the requested configuration.
  - OptionalprofileToken?: string
    
    Contains the token of an existing media profile the configurations shall be compatible with.
Returns Promise<VideoEncoder2Configuration[]>
- Defined in media2.ts:337

getVideoEncoderInstances

getVideoEncoderInstances(
options: GetVideoEncoderInstances,
): Promise<EncoderInstanceInfo>
The GetVideoEncoderInstances command can be used to request the minimum number of guaranteed video encoder instances (applications) per Video Source Configuration.
Parameters
- options: GetVideoEncoderInstances
Returns Promise<EncoderInstanceInfo>
- Defined in media2.ts:828

getVideoSourceConfigurationOptions

getVideoSourceConfigurationOptions(
options?: GetConfiguration,
): Promise<VideoSourceConfigurationOptions>
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
- options: GetConfiguration = {}
Returns Promise<VideoSourceConfigurationOptions>
- Defined in media2.ts:746

getVideoSourceConfigurations

getVideoSourceConfigurations(
options?: GetVideoSourceConfigurations,
): Promise<VideoSourceConfiguration[]>
The getVideoSourceConfigurations operation allows to retrieve the video source settings of one ore more configurations.
- 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.
Parameters
- Optionaloptions: GetVideoSourceConfigurations
  - OptionalconfigurationToken?: string
    
    Token of the requested configuration.
  - OptionalprofileToken?: string
    
    Contains the token of an existing media profile the configurations shall be compatible with.
Returns Promise<VideoSourceConfiguration[]>
- Defined in media2.ts:320

getVideoSourceModes

getVideoSourceModes(options?: GetVideoSourceModes): Promise<VideoSourceMode[]>
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
- Optionaloptions: GetVideoSourceModes
Returns Promise<VideoSourceMode[]>
- Defined in media2.ts:895

`Protected`getWebRTCConfigurations

getWebRTCConfigurations(): Promise<WebRTCConfiguration[]>
Protected Experimental
The getWebRTCConfigurations operation allows to retrieve the WebRTC settings of one ore more configurations.
- 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. Specs not ready yet, this method is for the future development
Returns Promise<WebRTCConfiguration[]>
- Defined in media2.ts:457

removeConfiguration

removeConfiguration(options: RemoveConfigurationExtended): Promise<void>
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
Parameters
- options: RemoveConfigurationExtended
  - Optionalconfiguration?: ConfigurationRefExtended[]
    
    List of configurations to be removed. The types shall be provided in the order defined by tr2:ConfigurationEnumeration. Tokens appearing in the configuration list shall be ignored. Presence of the "All" type shall result in an empty profile.
  - OptionalprofileToken?: string
    
    This element contains a reference to the media profile from which the configuration shall be removed.
Returns Promise<void>
- Defined in media2.ts:251

request

request<T = any>(body: OnvifSoapBody, options?: LineraseOptions): Promise<T>
Type Parameters
- T = any
Parameters
- body: OnvifSoapBody
- Optionaloptions: LineraseOptions
Returns Promise<T>
Inherited from Service.request
- Defined in service.ts:73

setAudioDecoderConfiguration

setAudioDecoderConfiguration(
configuration: AudioDecoderConfiguration,
): Promise<void>
This operation modifies an audio decoder configuration.
Parameters
- configuration: AudioDecoderConfiguration
Returns Promise<void>
- Defined in media2.ts:709

setAudioEncoderConfiguration

setAudioEncoderConfiguration(
configuration: AudioEncoder2Configuration,
): Promise<void>
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.
Parameters
- configuration: AudioEncoder2Configuration
Returns Promise<void>
- Defined in media2.ts:583

setAudioOutputConfiguration

setAudioOutputConfiguration(
configuration: AudioOutputConfigurationExtended,
): Promise<void>
This operation modifies an audio output configuration.
Parameters
- configuration: AudioOutputConfigurationExtended
Returns Promise<void>
- Defined in media2.ts:687

setAudioSourceConfiguration

setAudioSourceConfiguration(
configuration: AudioSourceConfiguration,
): Promise<void>
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.
Parameters
- configuration: AudioSourceConfiguration
Returns Promise<void>
- Defined in media2.ts:611

setMask

setMask(options: Mask): Promise<void>
Set the Mask
Parameters
- options: Mask
Returns Promise<void>

See
createMask
- Defined in media2.ts:1173

setMetadataConfiguration

setMetadataConfiguration(configuration: MetadataConfiguration): Promise<void>
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.
Parameters
- configuration: MetadataConfiguration
Returns Promise<void>
- Defined in media2.ts:634

setOSD

setOSD(options: OSDConfiguration): Promise<void>
Set the OSD
Parameters
- options: OSDConfiguration
Returns Promise<void>
- Defined in media2.ts:952

setSynchronizationPoint

setSynchronizationPoint(options?: SetSynchronizationPoint): Promise<void>
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
- options: SetSynchronizationPoint = {}
Returns Promise<void>
- Defined in media2.ts:852

setVideoEncoderConfiguration

setVideoEncoderConfiguration(
configuration: VideoEncoder2Configuration,
): Promise<void>
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.
Parameters
- configuration: VideoEncoder2Configuration
Returns Promise<void>
- Defined in media2.ts:473

setVideoSourceConfiguration

setVideoSourceConfiguration(
configuration: VideoSourceConfiguration,
): Promise<void>
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.
Parameters
- configuration: VideoSourceConfiguration
Returns Promise<void>
- Defined in media2.ts:516

setVideoSourceMode

setVideoSourceMode(options: SetVideoSourceMode): Promise<void>
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.
Parameters
- options: SetVideoSourceMode
Returns Promise<void>
- Defined in media2.ts:916

startMulticastStreaming

startMulticastStreaming(profileToken?: StartMulticastStreaming): Promise<void>
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
- profileToken: StartMulticastStreaming = {}
Returns Promise<void>
- Defined in media2.ts:868

stopMulticastStreaming

stopMulticastStreaming(profileToken?: StopMulticastStreaming): Promise<void>
This command stops multicast streaming using a specified media profile of a device
Parameters
- profileToken: StopMulticastStreaming = {}
Returns Promise<void>
- Defined in media2.ts:881

Interface Media2

Example: Profiles with configurations, stream / snapshot URI, and OSD list:

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Protected Readonlyonvif

Protected Readonlyservice

Protected Readonlyxmlns

Methods

addConfiguration

Parameters

Optionalconfiguration?: ConfigurationRefExtended[]

Optionalname?: string

OptionalprofileToken?: string

Returns Promise<void>

createMask

Parameters

Returns Promise<string>

Example

createOSD

Parameters

Returns Promise<string>

createProfile

Parameters

Optionalconfiguration?: ConfigurationRefExtended[]

name: string

Returns Promise<string>

deleteMask

Parameters

Returns Promise<void>

deleteOSD

Parameters

Returns Promise<void>

deleteProfile

Parameters

token: string

Returns Promise<void>

getAnalyticsConfigurations

Parameters

OptionalconfigurationToken?: string

OptionalprofileToken?: string

Returns Promise<VideoAnalyticsConfiguration[]>

getAudioDecoderConfigurationOptions

Parameters

Returns Promise<AudioDecoderConfigurationOptions>

getAudioDecoderConfigurations

Parameters

OptionalconfigurationToken?: string

OptionalprofileToken?: string

Returns Promise<AudioDecoderConfiguration[]>

getAudioEncoderConfigurationOptions

Parameters

Returns Promise<AudioEncoderConfigurationOption[]>

getAudioEncoderConfigurations

Parameters

OptionalconfigurationToken?: string

OptionalprofileToken?: string

Returns Promise<AudioEncoder2Configuration[]>

getAudioOutputConfigurationOptions

Parameters

Returns Promise<AudioOutputConfigurationOptions>

getAudioOutputConfigurations

Parameters

OptionalconfigurationToken?: string

OptionalprofileToken?: string

Returns Promise<AudioOutputConfigurationExtended[]>

getAudioSourceConfigurationOptions

Parameters

Returns Promise<AudioSourceConfigurationOptions>

getAudioSourceConfigurations

Parameters

OptionalconfigurationToken?: string

OptionalprofileToken?: string

Returns Promise<AudioSourceConfiguration[]>

getMaskOptions

Parameters

Returns Promise<MaskOptions>

Example

`Protected` `Readonly`onvif

`Protected` `Readonly`service

`Protected` `Readonly`xmlns

`Optional`configuration?: ConfigurationRefExtended[]

`Optional`name?: string

`Optional`profileToken?: string

`Optional`configuration?: ConfigurationRefExtended[]

`Optional`configurationToken?: string

`Optional`profileToken?: string

`Optional`configurationToken?: string

`Optional`profileToken?: string

`Optional`configurationToken?: string

`Optional`profileToken?: string

`Optional`configurationToken?: string

`Optional`profileToken?: string

`Optional`configurationToken?: string

`Optional`profileToken?: string

`Optional`configurationToken?: string

`Optional`profileToken?: string

`Optional`token?: string

`Optional`type?: string[]

`Optional`configurationToken?: string

`Optional`profileToken?: string

`Optional`configurationToken?: string

`Optional`profileToken?: string

`Protected`getWebRTCConfigurations

`Optional`configuration?: ConfigurationRefExtended[]

`Optional`profileToken?: string