Port MediaPort

General methods

Constructor.

All arguments are forwarded to SOAP::WSDL::Client.

SOAP Service methods

The commented class names in the method's parameters denote that objects of the corresponding class can be passed instead of the marked hash ref.

You may pass any combination of objects, hash and list refs to these methods, as long as you meet the structure.

List items (i.e. multiple occurrences) are not displayed in the synopsis. You may generally pass a list ref of hash refs (or objects) instead of a hash ref - this may result in invalid XML if used improperly, though. Note that SOAP::WSDL always expects list references at maximum depth position.

XML attributes are not displayed in this synopsis and cannot be set using hash refs. See the respective class' documentation for additional information.

GetServiceCapabilities

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

Returns a ONVIF::Media::Elements::GetServiceCapabilitiesResponse object.

 $response = $interface->GetServiceCapabilities( {
  },,
 );

GetVideoSources

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

Returns a ONVIF::Media::Elements::GetVideoSourcesResponse object.

 $response = $interface->GetVideoSources( {
  },,
 );

GetAudioSources

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

Returns a ONVIF::Media::Elements::GetAudioSourcesResponse object.

 $response = $interface->GetAudioSources( {
  },,
 );

GetAudioOutputs

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

Returns a ONVIF::Media::Elements::GetAudioOutputsResponse object.

 $response = $interface->GetAudioOutputs( {
  },,
 );

CreateProfile

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.

Returns a ONVIF::Media::Elements::CreateProfileResponse object.

 $response = $interface->CreateProfile( {
    Name => $some_value, # Name
    Token => $some_value, # ReferenceToken
  },,
 );

GetProfile

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

Returns a ONVIF::Media::Elements::GetProfileResponse object.

 $response = $interface->GetProfile( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetProfiles

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 a ONVIF::Media::Elements::GetProfilesResponse object.

 $response = $interface->GetProfiles( {
  },,
 );

AddVideoEncoderConfiguration

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.

Returns a ONVIF::Media::Elements::AddVideoEncoderConfigurationResponse object.

 $response = $interface->AddVideoEncoderConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

AddVideoSourceConfiguration

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.

Returns a ONVIF::Media::Elements::AddVideoSourceConfigurationResponse object.

 $response = $interface->AddVideoSourceConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

AddAudioEncoderConfiguration

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.

Returns a ONVIF::Media::Elements::AddAudioEncoderConfigurationResponse object.

 $response = $interface->AddAudioEncoderConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

AddAudioSourceConfiguration

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.

Returns a ONVIF::Media::Elements::AddAudioSourceConfigurationResponse object.

 $response = $interface->AddAudioSourceConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

AddPTZConfiguration

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.

Returns a ONVIF::Media::Elements::AddPTZConfigurationResponse object.

 $response = $interface->AddPTZConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

AddVideoAnalyticsConfiguration

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.

Returns a ONVIF::Media::Elements::AddVideoAnalyticsConfigurationResponse object.

 $response = $interface->AddVideoAnalyticsConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

AddMetadataConfiguration

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.

Returns a ONVIF::Media::Elements::AddMetadataConfigurationResponse object.

 $response = $interface->AddMetadataConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

AddAudioOutputConfiguration

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.

Returns a ONVIF::Media::Elements::AddAudioOutputConfigurationResponse object.

 $response = $interface->AddAudioOutputConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

AddAudioDecoderConfiguration

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.

Returns a ONVIF::Media::Elements::AddAudioDecoderConfigurationResponse object.

 $response = $interface->AddAudioDecoderConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

RemoveVideoEncoderConfiguration

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.

Returns a ONVIF::Media::Elements::RemoveVideoEncoderConfigurationResponse object.

 $response = $interface->RemoveVideoEncoderConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

RemoveVideoSourceConfiguration

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.

Returns a ONVIF::Media::Elements::RemoveVideoSourceConfigurationResponse object.

 $response = $interface->RemoveVideoSourceConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

RemoveAudioEncoderConfiguration

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.

Returns a ONVIF::Media::Elements::RemoveAudioEncoderConfigurationResponse object.

 $response = $interface->RemoveAudioEncoderConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

RemoveAudioSourceConfiguration

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.

Returns a ONVIF::Media::Elements::RemoveAudioSourceConfigurationResponse object.

 $response = $interface->RemoveAudioSourceConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

RemovePTZConfiguration

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.

Returns a ONVIF::Media::Elements::RemovePTZConfigurationResponse object.

 $response = $interface->RemovePTZConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

RemoveVideoAnalyticsConfiguration

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.

Returns a ONVIF::Media::Elements::RemoveVideoAnalyticsConfigurationResponse object.

 $response = $interface->RemoveVideoAnalyticsConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

RemoveMetadataConfiguration

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.

Returns a ONVIF::Media::Elements::RemoveMetadataConfigurationResponse object.

 $response = $interface->RemoveMetadataConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

RemoveAudioOutputConfiguration

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.

Returns a ONVIF::Media::Elements::RemoveAudioOutputConfigurationResponse object.

 $response = $interface->RemoveAudioOutputConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

RemoveAudioDecoderConfiguration

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.

Returns a ONVIF::Media::Elements::RemoveAudioDecoderConfigurationResponse object.

 $response = $interface->RemoveAudioDecoderConfiguration( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

DeleteProfile

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

Returns a ONVIF::Media::Elements::DeleteProfileResponse object.

 $response = $interface->DeleteProfile( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetVideoSourceConfigurations

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.

Returns a ONVIF::Media::Elements::GetVideoSourceConfigurationsResponse object.

 $response = $interface->GetVideoSourceConfigurations( {
  },,
 );

GetVideoEncoderConfigurations

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.

Returns a ONVIF::Media::Elements::GetVideoEncoderConfigurationsResponse object.

 $response = $interface->GetVideoEncoderConfigurations( {
  },,
 );

GetAudioSourceConfigurations

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.

Returns a ONVIF::Media::Elements::GetAudioSourceConfigurationsResponse object.

 $response = $interface->GetAudioSourceConfigurations( {
  },,
 );

GetAudioEncoderConfigurations

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.

Returns a ONVIF::Media::Elements::GetAudioEncoderConfigurationsResponse object.

 $response = $interface->GetAudioEncoderConfigurations( {
  },,
 );

GetVideoAnalyticsConfigurations

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.

Returns a ONVIF::Media::Elements::GetVideoAnalyticsConfigurationsResponse object.

 $response = $interface->GetVideoAnalyticsConfigurations( {
  },,
 );

GetMetadataConfigurations

This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command.

Returns a ONVIF::Media::Elements::GetMetadataConfigurationsResponse object.

 $response = $interface->GetMetadataConfigurations( {
  },,
 );

GetAudioOutputConfigurations

This command lists all existing AudioOutputConfigurations of a device. The NVC need not know anything apriori about the audio configurations to use this command.

Returns a ONVIF::Media::Elements::GetAudioOutputConfigurationsResponse object.

 $response = $interface->GetAudioOutputConfigurations( {
  },,
 );

GetAudioDecoderConfigurations

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.

Returns a ONVIF::Media::Elements::GetAudioDecoderConfigurationsResponse object.

 $response = $interface->GetAudioDecoderConfigurations( {
  },,
 );

GetVideoSourceConfiguration

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

Returns a ONVIF::Media::Elements::GetVideoSourceConfigurationResponse object.

 $response = $interface->GetVideoSourceConfiguration( {
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

GetVideoEncoderConfiguration

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

Returns a ONVIF::Media::Elements::GetVideoEncoderConfigurationResponse object.

 $response = $interface->GetVideoEncoderConfiguration( {
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

GetAudioSourceConfiguration

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

Returns a ONVIF::Media::Elements::GetAudioSourceConfigurationResponse object.

 $response = $interface->GetAudioSourceConfiguration( {
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

GetAudioEncoderConfiguration

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

Returns a ONVIF::Media::Elements::GetAudioEncoderConfigurationResponse object.

 $response = $interface->GetAudioEncoderConfiguration( {
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

GetVideoAnalyticsConfiguration

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

Returns a ONVIF::Media::Elements::GetVideoAnalyticsConfigurationResponse object.

 $response = $interface->GetVideoAnalyticsConfiguration( {
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

GetMetadataConfiguration

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

Returns a ONVIF::Media::Elements::GetMetadataConfigurationResponse object.

 $response = $interface->GetMetadataConfiguration( {
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

GetAudioOutputConfiguration

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

Returns a ONVIF::Media::Elements::GetAudioOutputConfigurationResponse object.

 $response = $interface->GetAudioOutputConfiguration( {
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

GetAudioDecoderConfiguration

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

Returns a ONVIF::Media::Elements::GetAudioDecoderConfigurationResponse object.

 $response = $interface->GetAudioDecoderConfiguration( {
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

GetCompatibleVideoEncoderConfigurations

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.

Returns a ONVIF::Media::Elements::GetCompatibleVideoEncoderConfigurationsResponse object.

 $response = $interface->GetCompatibleVideoEncoderConfigurations( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetCompatibleVideoSourceConfigurations

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.

Returns a ONVIF::Media::Elements::GetCompatibleVideoSourceConfigurationsResponse object.

 $response = $interface->GetCompatibleVideoSourceConfigurations( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetCompatibleAudioEncoderConfigurations

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.

Returns a ONVIF::Media::Elements::GetCompatibleAudioEncoderConfigurationsResponse object.

 $response = $interface->GetCompatibleAudioEncoderConfigurations( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetCompatibleAudioSourceConfigurations

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.

Returns a ONVIF::Media::Elements::GetCompatibleAudioSourceConfigurationsResponse object.

 $response = $interface->GetCompatibleAudioSourceConfigurations( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetCompatibleVideoAnalyticsConfigurations

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.

Returns a ONVIF::Media::Elements::GetCompatibleVideoAnalyticsConfigurationsResponse object.

 $response = $interface->GetCompatibleVideoAnalyticsConfigurations( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetCompatibleMetadataConfigurations

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.

Returns a ONVIF::Media::Elements::GetCompatibleMetadataConfigurationsResponse object.

 $response = $interface->GetCompatibleMetadataConfigurations( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetCompatibleAudioOutputConfigurations

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.

Returns a ONVIF::Media::Elements::GetCompatibleAudioOutputConfigurationsResponse object.

 $response = $interface->GetCompatibleAudioOutputConfigurations( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetCompatibleAudioDecoderConfigurations

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.

Returns a ONVIF::Media::Elements::GetCompatibleAudioDecoderConfigurationsResponse object.

 $response = $interface->GetCompatibleAudioDecoderConfigurations( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

SetVideoSourceConfiguration

This operation modifies a video source configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream. NVC methods for changing a running stream are out of scope for this specification.

Returns a ONVIF::Media::Elements::SetVideoSourceConfigurationResponse object.

 $response = $interface->SetVideoSourceConfiguration( {
    Configuration =>  { # ONVIF::Media::Types::VideoSourceConfiguration
      SourceToken => $some_value, # ReferenceToken
      Bounds => ,
      Extension =>  { # ONVIF::Media::Types::VideoSourceConfigurationExtension
        Rotate =>  { # ONVIF::Media::Types::Rotate
          Mode => $some_value, # RotateMode
          Degree =>  $some_value, # int
          Extension =>  { # ONVIF::Media::Types::RotateExtension
          },
        },
        Extension =>  { # ONVIF::Media::Types::VideoSourceConfigurationExtension2
        },
      },
    },
    ForcePersistence =>  $some_value, # boolean
  },,
 );

SetVideoEncoderConfiguration

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.

Returns a ONVIF::Media::Elements::SetVideoEncoderConfigurationResponse object.

 $response = $interface->SetVideoEncoderConfiguration( {
    Configuration =>  { # ONVIF::Media::Types::VideoEncoderConfiguration
      Encoding => $some_value, # VideoEncoding
      Resolution =>  { # ONVIF::Media::Types::VideoResolution
        Width =>  $some_value, # int
        Height =>  $some_value, # int
      },
      Quality =>  $some_value, # float
      RateControl =>  { # ONVIF::Media::Types::VideoRateControl
        FrameRateLimit =>  $some_value, # int
        EncodingInterval =>  $some_value, # int
        BitrateLimit =>  $some_value, # int
      },
      MPEG4 =>  { # ONVIF::Media::Types::Mpeg4Configuration
        GovLength =>  $some_value, # int
        Mpeg4Profile => $some_value, # Mpeg4Profile
      },
      H264 =>  { # ONVIF::Media::Types::H264Configuration
        GovLength =>  $some_value, # int
        H264Profile => $some_value, # H264Profile
      },
      Multicast =>  { # ONVIF::Media::Types::MulticastConfiguration
        Address =>  { # ONVIF::Media::Types::IPAddress
          Type => $some_value, # IPType
          IPv4Address => $some_value, # IPv4Address
          IPv6Address => $some_value, # IPv6Address
        },
        Port =>  $some_value, # int
        TTL =>  $some_value, # int
        AutoStart =>  $some_value, # boolean
      },
      SessionTimeout =>  $some_value, # duration
    },
    ForcePersistence =>  $some_value, # boolean
  },,
 );

SetAudioSourceConfiguration

This operation modifies an audio source configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected stream NVC methods for changing a running stream are out of scope for this specification.

Returns a ONVIF::Media::Elements::SetAudioSourceConfigurationResponse object.

 $response = $interface->SetAudioSourceConfiguration( {
    Configuration =>  { # ONVIF::Media::Types::AudioSourceConfiguration
      SourceToken => $some_value, # ReferenceToken
    },
    ForcePersistence =>  $some_value, # boolean
  },,
 );

SetAudioEncoderConfiguration

This operation modifies an audio encoder configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Running streams using this configuration may be immediately updated according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected streams. NVC methods for changing a running stream are out of scope for this specification.

Returns a ONVIF::Media::Elements::SetAudioEncoderConfigurationResponse object.

 $response = $interface->SetAudioEncoderConfiguration( {
    Configuration =>  { # ONVIF::Media::Types::AudioEncoderConfiguration
      Encoding => $some_value, # AudioEncoding
      Bitrate =>  $some_value, # int
      SampleRate =>  $some_value, # int
      Multicast =>  { # ONVIF::Media::Types::MulticastConfiguration
        Address =>  { # ONVIF::Media::Types::IPAddress
          Type => $some_value, # IPType
          IPv4Address => $some_value, # IPv4Address
          IPv6Address => $some_value, # IPv6Address
        },
        Port =>  $some_value, # int
        TTL =>  $some_value, # int
        AutoStart =>  $some_value, # boolean
      },
      SessionTimeout =>  $some_value, # duration
    },
    ForcePersistence =>  $some_value, # boolean
  },,
 );

SetVideoAnalyticsConfiguration

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

Returns a ONVIF::Media::Elements::SetVideoAnalyticsConfigurationResponse object.

 $response = $interface->SetVideoAnalyticsConfiguration( {
    Configuration =>  { # ONVIF::Media::Types::VideoAnalyticsConfiguration
      AnalyticsEngineConfiguration =>  { # ONVIF::Media::Types::AnalyticsEngineConfiguration
        AnalyticsModule =>  { # ONVIF::Media::Types::Config
          Parameters =>  { # ONVIF::Media::Types::ItemList
            SimpleItem => ,
            ElementItem =>  {
            },
            Extension =>  { # ONVIF::Media::Types::ItemListExtension
            },
          },
        },
        Extension =>  { # ONVIF::Media::Types::AnalyticsEngineConfigurationExtension
        },
      },
      RuleEngineConfiguration =>  { # ONVIF::Media::Types::RuleEngineConfiguration
        Rule =>  { # ONVIF::Media::Types::Config
          Parameters =>  { # ONVIF::Media::Types::ItemList
            SimpleItem => ,
            ElementItem =>  {
            },
            Extension =>  { # ONVIF::Media::Types::ItemListExtension
            },
          },
        },
        Extension =>  { # ONVIF::Media::Types::RuleEngineConfigurationExtension
        },
      },
    },
    ForcePersistence =>  $some_value, # boolean
  },,
 );

SetMetadataConfiguration

This operation modifies a metadata configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. Changes in the Multicast settings shall always be persistent. Running streams using this configuration may be updated immediately according to the new settings. The changes are not guaranteed to take effect unless the client requests a new stream URI and restarts any affected streams. NVC methods for changing a running stream are out of scope for this specification.

Returns a ONVIF::Media::Elements::SetMetadataConfigurationResponse object.

 $response = $interface->SetMetadataConfiguration( {
    Configuration =>  { # ONVIF::Media::Types::MetadataConfiguration
      PTZStatus =>  { # ONVIF::Media::Types::PTZFilter
        Status =>  $some_value, # boolean
        Position =>  $some_value, # boolean
      },
      Analytics =>  $some_value, # boolean
      Multicast =>  { # ONVIF::Media::Types::MulticastConfiguration
        Address =>  { # ONVIF::Media::Types::IPAddress
          Type => $some_value, # IPType
          IPv4Address => $some_value, # IPv4Address
          IPv6Address => $some_value, # IPv6Address
        },
        Port =>  $some_value, # int
        TTL =>  $some_value, # int
        AutoStart =>  $some_value, # boolean
      },
      SessionTimeout =>  $some_value, # duration
      AnalyticsEngineConfiguration =>  { # ONVIF::Media::Types::AnalyticsEngineConfiguration
        AnalyticsModule =>  { # ONVIF::Media::Types::Config
          Parameters =>  { # ONVIF::Media::Types::ItemList
            SimpleItem => ,
            ElementItem =>  {
            },
            Extension =>  { # ONVIF::Media::Types::ItemListExtension
            },
          },
        },
        Extension =>  { # ONVIF::Media::Types::AnalyticsEngineConfigurationExtension
        },
      },
      Extension =>  { # ONVIF::Media::Types::MetadataConfigurationExtension
      },
    },
    ForcePersistence =>  $some_value, # boolean
  },,
 );

SetAudioOutputConfiguration

This operation modifies an audio output configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device.

Returns a ONVIF::Media::Elements::SetAudioOutputConfigurationResponse object.

 $response = $interface->SetAudioOutputConfiguration( {
    Configuration =>  { # ONVIF::Media::Types::AudioOutputConfiguration
      OutputToken => $some_value, # ReferenceToken
      SendPrimacy =>  $some_value, # anyURI
      OutputLevel =>  $some_value, # int
    },
    ForcePersistence =>  $some_value, # boolean
  },,
 );

SetAudioDecoderConfiguration

This operation modifies an audio decoder configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device.

Returns a ONVIF::Media::Elements::SetAudioDecoderConfigurationResponse object.

 $response = $interface->SetAudioDecoderConfiguration( {
    Configuration =>  { # ONVIF::Media::Types::AudioDecoderConfiguration
    },
    ForcePersistence =>  $some_value, # boolean
  },,
 );

GetVideoSourceConfigurationOptions

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.

Returns a ONVIF::Media::Elements::GetVideoSourceConfigurationOptionsResponse object.

 $response = $interface->GetVideoSourceConfigurationOptions( {
    ConfigurationToken => $some_value, # ReferenceToken
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetVideoEncoderConfigurationOptions

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.

Returns a ONVIF::Media::Elements::GetVideoEncoderConfigurationOptionsResponse object.

 $response = $interface->GetVideoEncoderConfigurationOptions( {
    ConfigurationToken => $some_value, # ReferenceToken
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetAudioSourceConfigurationOptions

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.

Returns a ONVIF::Media::Elements::GetAudioSourceConfigurationOptionsResponse object.

 $response = $interface->GetAudioSourceConfigurationOptions( {
    ConfigurationToken => $some_value, # ReferenceToken
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetAudioEncoderConfigurationOptions

This operation returns the available options (supported values and ranges for audio encoder configuration parameters) when the audio encoder parameters are reconfigured.

Returns a ONVIF::Media::Elements::GetAudioEncoderConfigurationOptionsResponse object.

 $response = $interface->GetAudioEncoderConfigurationOptions( {
    ConfigurationToken => $some_value, # ReferenceToken
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetMetadataConfigurationOptions

This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration.

Returns a ONVIF::Media::Elements::GetMetadataConfigurationOptionsResponse object.

 $response = $interface->GetMetadataConfigurationOptions( {
    ConfigurationToken => $some_value, # ReferenceToken
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetAudioOutputConfigurationOptions

This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output.

Returns a ONVIF::Media::Elements::GetAudioOutputConfigurationOptionsResponse object.

 $response = $interface->GetAudioOutputConfigurationOptions( {
    ConfigurationToken => $some_value, # ReferenceToken
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetAudioDecoderConfigurationOptions

This command list the audio decoding capabilities for a given profile and configuration of a device.

Returns a ONVIF::Media::Elements::GetAudioDecoderConfigurationOptionsResponse object.

 $response = $interface->GetAudioDecoderConfigurationOptions( {
    ConfigurationToken => $some_value, # ReferenceToken
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetGuaranteedNumberOfVideoEncoderInstances

The GetGuaranteedNumberOfVideoEncoderInstances command can be used to request the minimum number of guaranteed video encoder instances (applications) per Video Source Configuration.

Returns a ONVIF::Media::Elements::GetGuaranteedNumberOfVideoEncoderInstancesResponse object.

 $response = $interface->GetGuaranteedNumberOfVideoEncoderInstances( {
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

GetStreamUri

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

Returns a ONVIF::Media::Elements::GetStreamUriResponse object.

 $response = $interface->GetStreamUri( {
    StreamSetup =>  { # ONVIF::Media::Types::StreamSetup
      Stream => $some_value, # StreamType
      Transport =>  { # ONVIF::Media::Types::Transport
        Protocol => $some_value, # TransportProtocol
      },
    },
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

StartMulticastStreaming

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.

Returns a ONVIF::Media::Elements::StartMulticastStreamingResponse object.

 $response = $interface->StartMulticastStreaming( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

StopMulticastStreaming

This command stop multicast streaming using a specified media profile of a device

Returns a ONVIF::Media::Elements::StopMulticastStreamingResponse object.

 $response = $interface->StopMulticastStreaming( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

SetSynchronizationPoint

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.

Returns a ONVIF::Media::Elements::SetSynchronizationPointResponse object.

 $response = $interface->SetSynchronizationPoint( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetSnapshotUri

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.

Returns a ONVIF::Media::Elements::GetSnapshotUriResponse object.

 $response = $interface->GetSnapshotUri( {
    ProfileToken => $some_value, # ReferenceToken
  },,
 );

GetVideoSourceModes

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.

Returns a ONVIF::Media::Elements::GetVideoSourceModesResponse object.

 $response = $interface->GetVideoSourceModes( {
    VideoSourceToken => $some_value, # ReferenceToken
  },,
 );

SetVideoSourceMode

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.

Returns a ONVIF::Media::Elements::SetVideoSourceModeResponse object.

 $response = $interface->SetVideoSourceMode( {
    VideoSourceToken => $some_value, # ReferenceToken
    VideoSourceModeToken => $some_value, # ReferenceToken
  },,
 );

GetOSDs

Get the OSDs.

Returns a ONVIF::Media::Elements::GetOSDsResponse object.

 $response = $interface->GetOSDs( {
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

GetOSD

Get the OSD.

Returns a ONVIF::Media::Elements::GetOSDResponse object.

 $response = $interface->GetOSD( {
    OSDToken => $some_value, # ReferenceToken
  },,
 );

GetOSDOptions

Get the OSD Options.

Returns a ONVIF::Media::Elements::GetOSDOptionsResponse object.

 $response = $interface->GetOSDOptions( {
    ConfigurationToken => $some_value, # ReferenceToken
  },,
 );

SetOSD

Set the OSD

Returns a ONVIF::Media::Elements::SetOSDResponse object.

 $response = $interface->SetOSD( {
    OSD =>  { # ONVIF::Media::Types::OSDConfiguration
      VideoSourceConfigurationToken =>  { value => $some_value },
      Type => $some_value, # OSDType
      Position =>  { # ONVIF::Media::Types::OSDPosConfiguration
        Type =>  $some_value, # string
        Pos => ,
        Extension =>  { # ONVIF::Media::Types::OSDPosConfigurationExtension
        },
      },
      TextString =>  { # ONVIF::Media::Types::OSDTextConfiguration
        Type =>  $some_value, # string
        DateFormat =>  $some_value, # string
        TimeFormat =>  $some_value, # string
        FontSize =>  $some_value, # int
        FontColor =>  { # ONVIF::Media::Types::OSDColor
          Color => ,
        },
        BackgroundColor =>  { # ONVIF::Media::Types::OSDColor
          Color => ,
        },
        PlainText =>  $some_value, # string
        Extension =>  { # ONVIF::Media::Types::OSDTextConfigurationExtension
        },
      },
      Image =>  { # ONVIF::Media::Types::OSDImgConfiguration
        ImgPath =>  $some_value, # anyURI
        Extension =>  { # ONVIF::Media::Types::OSDImgConfigurationExtension
        },
      },
      Extension =>  { # ONVIF::Media::Types::OSDConfigurationExtension
      },
    },
  },,
 );

CreateOSD

Create the OSD.

Returns a ONVIF::Media::Elements::CreateOSDResponse object.

 $response = $interface->CreateOSD( {
    OSD =>  { # ONVIF::Media::Types::OSDConfiguration
      VideoSourceConfigurationToken =>  { value => $some_value },
      Type => $some_value, # OSDType
      Position =>  { # ONVIF::Media::Types::OSDPosConfiguration
        Type =>  $some_value, # string
        Pos => ,
        Extension =>  { # ONVIF::Media::Types::OSDPosConfigurationExtension
        },
      },
      TextString =>  { # ONVIF::Media::Types::OSDTextConfiguration
        Type =>  $some_value, # string
        DateFormat =>  $some_value, # string
        TimeFormat =>  $some_value, # string
        FontSize =>  $some_value, # int
        FontColor =>  { # ONVIF::Media::Types::OSDColor
          Color => ,
        },
        BackgroundColor =>  { # ONVIF::Media::Types::OSDColor
          Color => ,
        },
        PlainText =>  $some_value, # string
        Extension =>  { # ONVIF::Media::Types::OSDTextConfigurationExtension
        },
      },
      Image =>  { # ONVIF::Media::Types::OSDImgConfiguration
        ImgPath =>  $some_value, # anyURI
        Extension =>  { # ONVIF::Media::Types::OSDImgConfigurationExtension
        },
      },
      Extension =>  { # ONVIF::Media::Types::OSDConfigurationExtension
      },
    },
  },,
 );

DeleteOSD

Delete the OSD.

Returns a ONVIF::Media::Elements::DeleteOSDResponse object.

 $response = $interface->DeleteOSD( {
    OSDToken => $some_value, # ReferenceToken
  },,
 );