onvif
    Preparing search index...

    Class Media

    Media service, ver10 profile

    Hierarchy (View Summary)

    Index
    constructor
    audioSources onvif profiles service videoSources xmlns
    addAudioDecoderConfiguration addAudioEncoderConfiguration addAudioOutputConfiguration addAudioSourceConfiguration addMetadataConfiguration addPTZConfiguration addVideoAnalyticsConfiguration addVideoEncoderConfiguration addVideoSourceConfiguration createOSD createProfile deleteOSD deleteProfile getAudioDecoderConfiguration getAudioDecoderConfigurationOptions getAudioDecoderConfigurations getAudioEncoderConfiguration getAudioEncoderConfigurationOptions getAudioEncoderConfigurations getAudioOutputConfiguration getAudioOutputConfigurationOptions getAudioOutputConfigurations getAudioOutputs getAudioSourceConfiguration getAudioSourceConfigurationOptions getAudioSourceConfigurations getAudioSources getCompatibleAudioDecoderConfigurations getCompatibleAudioEncoderConfigurations getCompatibleAudioOutputConfigurations getCompatibleAudioSourceConfigurations getCompatibleMetadataConfigurations getCompatibleVideoAnalyticsConfigurations getCompatibleVideoEncoderConfigurations getCompatibleVideoSourceConfigurations getGuaranteedNumberOfVideoEncoderInstances getMetadataConfiguration getMetadataConfigurationOptions getMetadataConfigurations getOSD getOSDOptions getOSDs getProfile getProfiles getServiceCapabilities getSnapshotUri getStreamUri getVideoAnalyticsConfiguration getVideoAnalyticsConfigurations getVideoEncoderConfiguration getVideoEncoderConfigurationOptions getVideoEncoderConfigurations getVideoSourceConfiguration getVideoSourceConfigurationOptions getVideoSourceConfigurations getVideoSourceModes getVideoSources removeAudioDecoderConfiguration removeAudioEncoderConfiguration removeAudioOutputConfiguration removeAudioSourceConfiguration removeMetadataConfiguration removePTZConfiguration removeVideoAnalyticsConfiguration removeVideoEncoderConfiguration removeVideoSourceConfiguration request setAudioDecoderConfiguration setAudioEncoderConfiguration setAudioOutputConfiguration setAudioSourceConfiguration setMetadataConfiguration setOSD setSynchronizationPoint setVideoAnalyticsConfiguration setVideoEncoderConfiguration setVideoSourceConfiguration setVideoSourceMode startMulticastStreaming stopMulticastStreaming
    audioSources: AudioSource[] = []
    onvif: Onvif
    profiles: Profile[] = []
    service: keyof OnvifServices
    videoSources: VideoSource[] = []
    xmlns: string

    • 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. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support the addition of an audio decoder configuration to a profile through the AddAudioDecoderConfiguration command

      Parameters

      • options: AddAudioDecoderConfiguration
        • configurationToken: string

          This element contains a reference to the AudioDecoderConfiguration to add.

        • OptionalprofileToken?: string

          This element contains a reference to the profile where the configuration should be added.

      Returns Promise<void>

    • 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 that supports audio streaming from device to client shall support addition of audio encoder configurations to a profile through the AddAudioEn- coderConfiguration command. A device shall support adding a compatible AudioEncoderConfiguration to a Profile containing an AudioSource- Configuration and shall support streaming audio data of such a Profile.

      Parameters

      • options: AddAudioEncoderConfiguration
        • configurationToken: string

          Contains a reference to the AudioEncoderConfiguration to add

        • OptionalprofileToken?: string

          Reference to the profile where the configuration should be added

      Returns Promise<void>

    • 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. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support the addition of an audio output configuration to a profile through the AddAudioOutputConfiguration command.

      Parameters

      • options: AddAudioOutputConfiguration
        • configurationToken: string

          Contains a reference to the AudioOutputConfiguration to add

        • OptionalprofileToken?: string

          Reference to the profile where the configuration should be added

      Returns Promise<void>

    • 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. A device that supports audio streaming from device to client shall support addition of audio source configuration to a profile through the AddAudioSource- Configuration command.

      Parameters

      • options: AddAudioSourceConfiguration
        • configurationToken: string

          Contains a reference to the AudioSourceConfiguration to add

        • OptionalprofileToken?: string

          Reference to the profile where the configuration should be added

      Returns Promise<void>

    • 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. A device shall support the addition of a metadata configuration to a profile though the AddMetadataConfiguration command. 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. Metadata configurations are handled through the commands defined in Section 5.10 and 5.9.4.

      Parameters

      • options: AddMetadataConfiguration
        • configurationToken: string

          Contains a reference to the MetadataConfiguration to add

        • OptionalprofileToken?: string

          Reference to the profile where the configuration should be added

      Returns Promise<void>

    • 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. A device that supports PTZ control shall support addition of PTZ configurations to a profile through the AddPTZConfiguration command. 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, see document PTZ Service Specification

      Parameters

      • options: AddPTZConfiguration
        • configurationToken: string

          Contains a reference to the PTZConfiguration to add

        • OptionalprofileToken?: string

          Reference to the profile where the configuration should be added

      Returns Promise<void>

    • 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. A device that supports video analytics shall support addition of video analytics configurations to a profile through the AddVideoAnalyticsConfiguration command. 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. Video analytics data is specified in the document Video Analytics Specification and analytics configurations are managed through the commands defined in Section 5.9. 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. In this case, it should respond with a ConfigurationConflict Fault.

      Parameters

      • options: AddVideoAnalyticsConfiguration
        • configurationToken: string

          Contains a reference to the VideoAnalyticsConfiguration to add

        • OptionalprofileToken?: string

          Reference to the profile where the configuration should be added

      Returns Promise<void>

    • 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 addition of a video encoder configuration to a profile through the AddVideoEncoderConfiguration command. A device shall support adding a compatible VideoEncoderConfiguration to a Profile containing a VideoSource- Configuration and shall support streaming video data of such a Profile.

      Parameters

      • options: AddVideoEncoderConfiguration
        • configurationToken: string

          Contains a reference to the VideoEncoderConfiguration to add

        • OptionalprofileToken?: string

          Reference to the profile where the configuration should be added

      Returns Promise<void>

    • 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

      • options: AddVideoSourceConfiguration
        • configurationToken: string

          Contains a reference to the VideoSourceConfiguration to add

        • OptionalprofileToken?: string

          Reference to the profile where the configuration should be added

      Returns Promise<void>

    • 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

      • options: CreateProfile
        • name: string

          friendly name of the profile to be created

        • Optionaltoken?: string

          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" | "-.".

      Returns Promise<Profile>

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

      Parameters

      • options: DeleteProfile
        • OptionalprofileToken?: string

          This element contains a reference to the profile that should be deleted.

      Returns Promise<void>

    • If the audio decoder configuration token is already known, the decoder configuration can be fetched through the GetAudioDecoderConfiguration command. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support the retrieval of a specific audio decoder configuration through the GetAudioDecoderConfiguration command.

      Parameters

      Returns Promise<AudioDecoderConfiguration>

    • This operation returns the available parameters and their valid ranges to the client. Any combination of the parameters obtained using a given media profile and audio decoder configuration shall be a valid input for the SetAudioDecoderConfiguration command. A device that supports audio streaming from client to device shall support the GetAudioDecoderConfigurationOptions command. If an audio decoder configuration token is provided, the device shall return the options compatible with that configuration. If a media profile token is specified, the device shall return the options compatible with that media profile. If both a media profile token and an audio decoder configuration token are specified, the device shall return the options compatible with both that media profile and that configuration. If no tokens are specified, the options shall be considered generic for the device.

      Parameters

      • options: GetAudioDecoderConfigurationOptions = {}
        • OptionalconfigurationToken?: string

          Optional audio decoder configuration token that specifies an existing configuration that the options are intended for.

        • OptionalprofileToken?: string

          Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.

      Returns Promise<AudioDecoderConfigurationOptions>

    • This command lists all existing AudioDecoderConfigurations of a device. The client does not need to know anything apriori about the audio decoder configurations in order to use this command. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support the listing of AudioOutputConfigurations through this command.

      Returns Promise<AudioDecoderConfiguration[]>

    • The GetAudioEncoderConfiguration command fetches the encoder configuration if the audio encoder configuration token is known. A device that supports audio streaming from device to client shall support the listing of a specific audio encoder configuration through the GetAudioEncoderConfiguration command.

      Parameters

      Returns Promise<AudioEncoderConfiguration>

    • This operation returns the available parameters and their valid ranges to the client. Any combination of the parameters obtained using a given media profile and audio encoder configuration shall be a valid input for the SetAudioEncoderConfiguration command. A device that supports audio streaming from device to client shall support the GetAudioEncoderConfigurationOptions command. If an audio encoder configuration token is provided, the device shall return the options compatible with that configuration. If a media profile token is specified, the device shall return the options compatible with that media profile. If both a media profile token and an audio encoder configuration token are specified, the device shall return the options compatible with both that media profile and that configuration. If no tokens are specified, the options shall be considered generic for the device.

      Parameters

      • options: GetAudioEncoderConfigurationOptions = {}
        • OptionalconfigurationToken?: string

          Optional audio encoder configuration token that specifies an existing configuration that the options are intended for.

        • OptionalprofileToken?: string

          Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.

      Returns Promise<AudioEncoderConfigurationOptions>

    • This operation lists all existing device audio encoder configurations. The client does not need to know anything apriori about the audio encoder configurations in order to use the command. A device that supports audio streaming from device to client shall support the listing of available audio encoder configurations through the GetAudioEncoderConfigurations command

      Returns Promise<AudioEncoderConfiguration[]>

    • If the audio output configuration token is already known, the output configuration can be fetched through the GetAudioOutputConfiguration command. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support the retrieval of a specific audio output configuration through the GetAudioOutputConfiguration command.

      Parameters

      Returns Promise<AudioOutputConfiguration>

    • This operation returns the available parameters and their valid ranges to the client. Any combination of the parameters obtained using a given media profile and audio output configuration shall be a valid input for the SetAudioOutputConfiguration command. A device that supports audio streaming from client to device shall support the GetAudioOutputConfigurationOptions command. If an audio output configuration token is provided, the device shall return the options compatible with that configuration. If a media profile token is specified, the device shall return the options compatible with that media profile. If both a media profile token and an audio output configuration token are specified, the device shall return the options compatible with both that media profile and that configuration. If no tokens are specified, the options shall be considered generic for the device.

      Parameters

      • options: GetAudioOutputConfigurationOptions = {}
        • OptionalconfigurationToken?: string

          Optional audio output configuration token that specifies an existing configuration that the options are intended for.

        • OptionalprofileToken?: string

          Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.

      Returns Promise<AudioOutputConfigurationOptions>

    • This command lists all existing AudioOutputConfigurations of a device. The client does not need to know any- thing apriori about the audio configurations to use this command. A device that signals support for Audio out- puts via its Device IO AudioOutputs capability shall support the listing of AudioOutputConfigurations through this command

      Returns Promise<AudioOutputConfiguration[]>

    • This command lists all available audio outputs of a device. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support listing of available audio outputs through the GetAu- dioOutputs command.

      Returns Promise<AudioOutput[]>

    • The GetAudioSourceConfiguration command fetches the audio source configurations if the audio source configuration token is already known. A device that supports audio streaming from device to client shall support the retrieval of a specific audio source configuration through the GetAudioSourceConfiguration command.

      Parameters

      Returns Promise<AudioSourceConfiguration>

    • This operation returns the available parameters and their valid ranges to the client. Any combination of the parameters obtained using a given media profile and audio source configuration shall be a valid input for the SetAudioSourceConfiguration command. A device that supports audio streaming from device to client shall support the GetAudioSourceConfigurationOptions command. If an audio source configuration token is provided, the device shall return the options compatible with that configuration. If a media profile token is specified, the device shall return the options compatible with that media profile. If both a media profile token and an audio source configuration token are specified, the device shall return the options compatible with both that media profile and that configuration. If no tokens are specified, the options shall be considered generic for the device.

      Parameters

      • options: GetAudioSourceConfigurationOptions = {}
        • OptionalconfigurationToken?: string

          Optional audio source configuration token that specifies an existing configuration that the options are intended for.

        • OptionalprofileToken?: string

          Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.

      Returns Promise<AudioSourceConfigurationOptions>

    • This operation lists all existing audio source configurations of a device. This command lists all audio source configurations in a device. The client does not need to know anything apriori about the audio source configurations in order to use the command. A device that supports audio streaming from device to client shall support listing of available audio source configurations through the GetAudioSourceConfigurations command

      Returns Promise<AudioSourceConfiguration[]>

    • This operation lists all available audio sources of the device. A device that supports audio streaming from device to client shall support listing of available audio sources through the GetAudioSources command.

      Returns Promise<AudioSource[]>

    • 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. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support the listing of compatible (with a specific profile) audio decoder configurations through the GetCompatibleAudioDecoderConfigurations command

      Parameters

      Returns Promise<AudioDecoderConfiguration[]>

    • This operation requests all audio 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 AddAudioEncoderConfigura- tion command on the media profile. The result varies depending on the capabilities, configurations and settings in the device. A device that supports audio streaming from device to client shall support listing of compatible (with a specific profile) audio encoder configurations through the GetCompatibleAudioEncoderConfigurations command

      Parameters

      Returns Promise<AudioEncoderConfiguration[]>

    • 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. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support the listing of compatible (with a specific profile) AudioOutputConfigurations through the GetCompatibleAudioOutputConfigurations command

      Parameters

      Returns Promise<AudioOutputConfiguration[]>

    • This operation requests all audio source 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 AddAudioSourceConfigu- ration command on the media profile. The result varies depending on the capabilities, configurations and set- tings in the device. A device that supports audio streaming from device to client shall support listing of compat- ible (with a specific profile) audio source configurations through the GetCompatibleAudioSourceConfigurations command

      Parameters

      Returns Promise<AudioSourceConfiguration[]>

    • 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. A device or other device that supports metadata streaming shall support the listing of compatible (with a specific profile) metadata configuration through the GetCompatibleMetadataConfigurations command.

      Parameters

      Returns Promise<MetadataConfiguration[]>

    • 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. A device that supports video analytics shall support the listing of compatible (with a specific profile) video analytics configuration through the GetCompatibleVideoAnalyticsConfigurations command.

      Parameters

      Returns Promise<VideoAnalyticsConfiguration[]>

    • 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 AddVideoEncoderConfig- uration command on the media profile. The result will vary depending on the capabilities, configurations and settings in the device. The device shall support the listing of compatible (with a specific profile) video encoder configurations through the GetCompatibleVideoEncoderConfigurations command

      Parameters

      Returns Promise<VideoEncoderConfiguration[]>

    • 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

      Returns Promise<VideoSourceConfiguration[]>

    • The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known. A device or another device that supports metadata streaming shall support the listing of a specific metadata configuration through the GetMetadataConfiguration command.

      Parameters

      Returns Promise<MetadataConfiguration>

    • This operation returns the available parameters and their valid ranges to the client. Any combination of the parameters obtained using a given media profile and metadata configuration shall be a valid input for the Set- MetadataConfiguration command. A device that supports metadata streaming shall support the GetMetadata- ConfigurationOptions command. If a metadata configuration token is provided, the device shall return the options compatible with that configuration. If a media profile token is specified, the device shall return the options compatible with that media profile. If both a media profile token and a metadata configuration token are specified, the device shall return the options compatible with both that media profile and that configuration. If no tokens are specified, the options shall be considered generic for the device.

      Parameters

      • options: GetMetadataConfigurationOptions = {}
        • OptionalconfigurationToken?: string

          Optional metadata configuration token that specifies an existing configuration that the options are intended for.

        • OptionalprofileToken?: string

          Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.

      Returns Promise<MetadataConfigurationOptions>

    • This operation lists all existing metadata configurations. The client does not need to know anything apriori about the metadata in order to use the command. A device or another device that supports metadata streaming shall support the listing of existing metadata configurations through the GetMetadataConfigurations command.

      Returns Promise<MetadataConfiguration[]>

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

      Parameters

      • options: GetProfile
        • OptionalprofileToken?: string

          this command requests a specific profile

      Returns Promise<Profile>

    • Receive profiles in Media ver10 format 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.

      Returns Promise<Profile[]>

    • Returns the capabilities of the media service. The result is returned in a typed answer.

      Returns Promise<Capabilities>

    • This method 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. Method uses Media2 if device supports it.

      For Media2 you need to provide only protocol parameter ('RTPS' by default). Here is supported values from the ONVIF documentation: 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.

      For Media1 you need to set both parameters: protocl and stream (RTP-Unicast by default) If Media2 supported by device, this parameters will be converted to Media2 call. This is excerpt from ONVIF documentation: 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"

      Parameters

      Returns Promise<GetStreamUriResponse>

    • This operation lists all video analytics configurations of a device. This command lists all configured video an- alytics in a device. The client does not need to know anything apriori about the video analytics in order to use the command. A device that supports video analytics shall support the listing of available video analytics configuration through the GetVideoAnalyticsConfigurations command.

      Returns Promise<VideoAnalyticsConfiguration[]>

    • This operation returns the available parameters and their valid ranges to the client. Any combination of the parameters obtained using a given media profile and video encoder configuration shall be a valid input for the SetVideoEncoderConfiguration command. The device shall support the GetVideoEncoderConfigurationOptions command. If a video encoder configuration token is provided, the device shall return the options compatible with that configuration. If a media profile token is specified, the device shall return the options compatible with that media profile. If both a media profile token and a video encoder configuration token are specified, the device shall return the options compatible with both that media profile and that configuration. If no tokens are specified, the options shall be considered generic for the device

      Parameters

      • options: GetVideoEncoderConfigurationOptions = {}
        • OptionalconfigurationToken?: string

          Optional video encoder configuration token that specifies an existing configuration that the options are intended for.

        • OptionalprofileToken?: string

          Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.

      Returns Promise<VideoEncoderConfigurationOptions>

    • This operation lists all existing video encoder configurations of a device. This command lists all configured video encoder configurations in a device. The client does not need to know anything apriori about the video encoder configurations in order to use the command. The device shall support the listing of available video encoder configurations through the GetVideoEncoderConfigurations command

      Returns Promise<VideoEncoderConfiguration[]>

    • If the video source configuration token is already known, the video source configuration can be fetched through the GetVideoSourceConfiguration command. The device shall support retrieval of specific video source configurations through the GetVideoSourceConfiguration command

      Parameters

      Returns Promise<VideoSourceConfiguration>

    • This operation returns the available parameters and their valid ranges to the client. Any combination of the parameters obtained using a given media profile and video source configuration shall be a valid input for the SetVideoSourceConfiguration command. The device shall support the GetVideoSourceConfigurationOptions command. If a video source configuration token is provided, the device shall return the options compatible with that con- figuration. If a media profile token is specified, the device shall return the options compatible with that media profile. If both a media profile token and a video source configuration token are specified, the device shall return the options compatible with both that media profile and that configuration. If no tokens are specified, the options shall be considered generic for the device.

      Parameters

      • options: GetVideoSourceConfigurationOptions = {}
        • OptionalconfigurationToken?: string

          Optional video source configurationToken that specifies an existing configuration that the options are intended for.

        • OptionalprofileToken?: string

          Optional ProfileToken that specifies an existing media profile that the options shall be compatible with.

      Returns Promise<VideoSourceConfigurationOptions>

    • This operation lists all existing video source configurations for a device. This command lists all video source configurations in a device. The client need not know anything about the video source configurations in order to use the command. The device shall support the listing of available video source configurations through the GetVideoSourceConfigurations command.

      Returns Promise<VideoSourceConfiguration[]>

    • This operation lists all available video sources for the device. The device shall support the listing of available video sources through the GetVideoSources command

      Returns Promise<VideoSource[]>

    • 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. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support the removal of an audio decoder configuration from a profile through the RemoveAudioDecoderConfiguration command.

      Parameters

      • options: RemoveAudioDecoderConfiguration
        • OptionalprofileToken?: string

          This element contains a reference to the media profile from which the AudioDecoderConfiguration shall be removed.

      Returns Promise<void>

    • 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. A device that supports audio streaming from device to client shall support removal of audio encoder configurations from a profile through the RemoveAudioEncoderConfiguration command.

      Parameters

      • options: RemoveAudioEncoderConfiguration
        • OptionalprofileToken?: string

          Contains a reference to the media profile from which the AudioEncoderConfiguration shall be removed.

      Returns Promise<void>

    • 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. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support the removal of an audio output configuration from a profile through the RemoveAudioOutputConfiguration command.

      Parameters

      • options: RemoveAudioOutputConfiguration
        • OptionalprofileToken?: string

          Contains a reference to the media profile from which the AudioOutputConfiguration shall be removed.

      Returns Promise<void>

    • 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. A device that supports audio streaming from device to client shall support removal of an audio source configuration from a profile through the RemoveAudioSourceConfiguration command.

      Parameters

      • options: RemoveAudioSourceConfiguration
        • OptionalprofileToken?: string

          Contains a reference to the media profile from which the AudioSourceConfiguration shall be removed.

      Returns Promise<void>

    • 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. A device shall support the removal of a metadata configuration from a profile through the RemoveMetadataConfiguration command.

      Parameters

      • options: RemoveMetadataConfiguration
        • OptionalprofileToken?: string

          Contains a reference to the media profile from which the MetadataConfiguration shall be removed.

      Returns Promise<void>

    • 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. A device that supports PTZ control shall support removal of PTZ configurations from a profile through the RemovePTZConfiguration command.

      Parameters

      • options: RemovePTZConfiguration
        • OptionalprofileToken?: string

          Contains a reference to the media profile from which the PTZConfiguration shall be removed.

      Returns Promise<void>

    • 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. A device that supports video analytics shall support removal of a video analytics configuration from a profile through the RemoveVideoAnalyticsConfiguration command.

      Parameters

      • options: RemoveVideoAnalyticsConfiguration
        • OptionalprofileToken?: string

          Contains a reference to the media profile from which the VideoAnalyticsConfiguration shall be removed.

      Returns Promise<void>

    • 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. The device shall support removal of a video encoder configuration from a profile through the RemoveVideoEncoderConfiguration command.

      Parameters

      • options: RemoveVideoEncoderConfiguration
        • OptionalprofileToken?: string

          Contains a reference to the media profile from which the VideoEncoderConfiguration shall be removed.

      Returns Promise<void>

    • 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. The device shall support removal of a video source configuration from a profile through the RemoveVideoSourceConfiguration command. Video source configurations should only be removed after removing a VideoEncoderConfiguration from the media profile.

      Parameters

      • options: RemoveVideoSourceConfiguration
        • OptionalprofileToken?: string

          Contains a reference to the media profile from which the VideoSourceConfiguration shall be removed.

      Returns Promise<void>

    • This operation modifies an audio decoder configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support the modification of audio decoder parameters through the SetAudioDe- coderConfiguration command.

      Parameters

      • options: SetAudioDecoderConfiguration
        • configuration: AudioDecoderConfiguration

          Contains the modified audio decoder configuration. The configuration shall exist in the device.

        • forcePersistence: boolean

          The ForcePersistence element is obsolete and should always be assumed to be true.

      Returns Promise<void>

    • This operation modifies an audio 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 streams. Client methods for changing a running stream are out of scope for this specification. A device that supports audio streaming from device to client shall support the configuration of audio encoder parameters through the SetAudioEncoderConfiguration command.

      Parameters

      • options: SetAudioEncoderConfiguration
        • configuration: AudioEncoderConfiguration

          Contains the modified audio encoder configuration. The configuration shall exist in the device.

        • forcePersistence: boolean

          The ForcePersistence element is obsolete and should always be assumed to be true.

      Returns Promise<void>

    • This operation modifies an audio output configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. An device that signals support for Audio outputs via its Device IO AudioOutputs capability shall support the modification of audio output parameters through the SetAudioOutputConfiguration command.

      Parameters

      • options: SetAudioOutputConfiguration
        • configuration: AudioOutputConfiguration

          Contains the modified audio output configuration. The configuration shall exist in the device.

        • forcePersistence: boolean

          The ForcePersistence element is obsolete and should always be assumed to be true.

      Returns Promise<void>

    • 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, but the changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream. If the new settings invalidate any parameters already negotiated using RTSP, for example by changing codec type, the device must not apply these settings to existing streams. Instead it must either continue to stream using the old settings or stop sending data on the affected streams. Client methods for changing a running stream are out of scope for this specification. A device that supports audio streaming from device to client shall support the configuration of audio source parameters through the SetAudioSourceConfiguration command.

      Parameters

      • options: SetAudioSourceConfiguration
        • configuration: AudioSourceConfiguration

          Contains the modified audio source configuration. The configuration shall exist in the device.

        • forcePersistence: boolean

          The ForcePersistence element is obsolete and should always be assumed to be true.

      Returns Promise<void>

    • 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. Client methods for changing a running stream are out of scope for this specification. A device or another device that supports metadata streaming shall support the configuration of metadata parameters through the SetMetadataConfiguration command.

      Parameters

      • options: SetMetadataConfiguration
        • configuration: MetadataConfiguration

          Contains the modified metadata configuration. The configuration shall exist in the device.

        • forcePersistence: boolean

          The ForcePersistence element is obsolete and should always be assumed to be true.

      Returns 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

      Returns Promise<void>

    • 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 im- mediately 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. A device that supports video analytics shall support the configuration of video analytics parameters through the SetVideoAnalyticsConfiguration command.

      Parameters

      • options: SetVideoAnalyticsConfiguration
        • configuration: VideoAnalyticsConfiguration

          Contains the modified video analytics configuration. The configuration shall exist in the device.

        • forcePersistence: boolean

          The ForcePersistence element is obsolete and should always be assumed to be true.

      Returns Promise<void>

    • 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, but the changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream. If the new settings invalidate any parameters already negotiated using RTSP, for example by changing codec type, the device must not apply these settings to existing streams. Instead it must either continue to stream using the old settings or stop sending data on the affected streams. Client methods for changing a running stream are out of scope for this specification. The device shall support the modification of video encoder parameters through the SetVideoEncoderConfiguration command. A device shall accept any combination of parameters that it returned in the GetVideoEncoderConfigurationOptionsResponse. If necessary the device may adapt parameter values for Quality and RateControl elements without returning an error. A device shall adapt an out of range BitrateLimit instead of returning a fault.

      Parameters

      • options: SetVideoEncoderConfiguration
        • configuration: VideoEncoderConfiguration

          Contains the modified video encoder configuration. The configuration shall exist in the device.

        • forcePersistence: boolean

          The ForcePersistence element is obsolete and should always be assumed to be true.

      Returns Promise<void>

    • 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. Client methods for changing a running stream are out of scope for this specification. The device shall support the modification of video source parameters through the SetVideoSourceConfiguration command.

      Parameters

      • options: SetVideoSourceConfiguration
        • configuration: VideoSourceConfiguration

          Contains the modified video source configuration. The configuration shall exist in the device.

        • forcePersistence: boolean

          The ForcePersistence element is obsolete and should always be assumed to be true.

      Returns 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

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods
    addAudioDecoderConfigurationaddAudioEncoderConfigurationaddAudioOutputConfigurationaddAudioSourceConfigurationaddMetadataConfigurationaddPTZConfigurationaddVideoAnalyticsConfigurationaddVideoEncoderConfigurationaddVideoSourceConfigurationcreateOSDcreateProfiledeleteOSDdeleteProfilegetAudioDecoderConfigurationgetAudioDecoderConfigurationOptionsgetAudioDecoderConfigurationsgetAudioEncoderConfigurationgetAudioEncoderConfigurationOptionsgetAudioEncoderConfigurationsgetAudioOutputConfigurationgetAudioOutputConfigurationOptionsgetAudioOutputConfigurationsgetAudioOutputsgetAudioSourceConfigurationgetAudioSourceConfigurationOptionsgetAudioSourceConfigurationsgetAudioSourcesgetCompatibleAudioDecoderConfigurationsgetCompatibleAudioEncoderConfigurationsgetCompatibleAudioOutputConfigurationsgetCompatibleAudioSourceConfigurationsgetCompatibleMetadataConfigurationsgetCompatibleVideoAnalyticsConfigurationsgetCompatibleVideoEncoderConfigurationsgetCompatibleVideoSourceConfigurationsgetGuaranteedNumberOfVideoEncoderInstancesgetMetadataConfigurationgetMetadataConfigurationOptionsgetMetadataConfigurationsgetOSDgetOSDOptionsgetOSDsgetProfilegetProfilesgetServiceCapabilitiesgetSnapshotUrigetStreamUrigetVideoAnalyticsConfigurationgetVideoAnalyticsConfigurationsgetVideoEncoderConfigurationgetVideoEncoderConfigurationOptionsgetVideoEncoderConfigurationsgetVideoSourceConfigurationgetVideoSourceConfigurationOptionsgetVideoSourceConfigurationsgetVideoSourceModesgetVideoSourcesremoveAudioDecoderConfigurationremoveAudioEncoderConfigurationremoveAudioOutputConfigurationremoveAudioSourceConfigurationremoveMetadataConfigurationremovePTZConfigurationremoveVideoAnalyticsConfigurationremoveVideoEncoderConfigurationremoveVideoSourceConfigurationrequestsetAudioDecoderConfigurationsetAudioEncoderConfigurationsetAudioOutputConfigurationsetAudioSourceConfigurationsetMetadataConfigurationsetOSDsetSynchronizationPointsetVideoAnalyticsConfigurationsetVideoEncoderConfigurationsetVideoSourceConfigurationsetVideoSourceModestartMulticastStreamingstopMulticastStreaming