ONVIF::Media::Interfaces::Media::MediaPort (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/ONVIF::Media::Interfaces::Media::MediaPort.3pm".)

NAME

ONVIF::Media::Interfaces::Media::MediaPort - SOAP Interface for the Media Web Service

SYNOPSIS

use ONVIF::Media::Interfaces::Media::MediaPort;

my $interface = ONVIF::Media::Interfaces::Media::MediaPort->new();

my $response;

$response = $interface->GetServiceCapabilities();

$response = $interface->GetVideoSources();

$response = $interface->GetAudioSources();

$response = $interface->GetAudioOutputs();

$response = $interface->CreateProfile();

$response = $interface->GetProfile();

$response = $interface->GetProfiles();

$response = $interface->AddVideoEncoderConfiguration();

$response = $interface->AddVideoSourceConfiguration();

$response = $interface->AddAudioEncoderConfiguration();

$response = $interface->AddAudioSourceConfiguration();

$response = $interface->AddPTZConfiguration();

$response = $interface->AddVideoAnalyticsConfiguration();

$response = $interface->AddMetadataConfiguration();

$response = $interface->AddAudioOutputConfiguration();

$response = $interface->AddAudioDecoderConfiguration();

$response = $interface->RemoveVideoEncoderConfiguration();

$response = $interface->RemoveVideoSourceConfiguration();

$response = $interface->RemoveAudioEncoderConfiguration();

$response = $interface->RemoveAudioSourceConfiguration();

$response = $interface->RemovePTZConfiguration();

$response = $interface->RemoveVideoAnalyticsConfiguration();

$response = $interface->RemoveMetadataConfiguration();

$response = $interface->RemoveAudioOutputConfiguration();

$response = $interface->RemoveAudioDecoderConfiguration();

$response = $interface->DeleteProfile();

$response = $interface->GetVideoSourceConfigurations();

$response = $interface->GetVideoEncoderConfigurations();

$response = $interface->GetAudioSourceConfigurations();

$response = $interface->GetAudioEncoderConfigurations();

$response = $interface->GetVideoAnalyticsConfigurations();

$response = $interface->GetMetadataConfigurations();

$response = $interface->GetAudioOutputConfigurations();

$response = $interface->GetAudioDecoderConfigurations();

$response = $interface->GetVideoSourceConfiguration();

$response = $interface->GetVideoEncoderConfiguration();

$response = $interface->GetAudioSourceConfiguration();

$response = $interface->GetAudioEncoderConfiguration();

$response = $interface->GetVideoAnalyticsConfiguration();

$response = $interface->GetMetadataConfiguration();

$response = $interface->GetAudioOutputConfiguration();

$response = $interface->GetAudioDecoderConfiguration();

$response = $interface->GetCompatibleVideoEncoderConfigurations();

$response = $interface->GetCompatibleVideoSourceConfigurations();

$response = $interface->GetCompatibleAudioEncoderConfigurations();

$response = $interface->GetCompatibleAudioSourceConfigurations();

$response = $interface->GetCompatibleVideoAnalyticsConfigurations();

$response = $interface->GetCompatibleMetadataConfigurations();

$response = $interface->GetCompatibleAudioOutputConfigurations();

$response = $interface->GetCompatibleAudioDecoderConfigurations();

$response = $interface->SetVideoSourceConfiguration();

$response = $interface->SetVideoEncoderConfiguration();

$response = $interface->SetAudioSourceConfiguration();

$response = $interface->SetAudioEncoderConfiguration();

$response = $interface->SetVideoAnalyticsConfiguration();

$response = $interface->SetMetadataConfiguration();

$response = $interface->SetAudioOutputConfiguration();

$response = $interface->SetAudioDecoderConfiguration();

$response = $interface->GetVideoSourceConfigurationOptions();

$response = $interface->GetVideoEncoderConfigurationOptions();

$response = $interface->GetAudioSourceConfigurationOptions();

$response = $interface->GetAudioEncoderConfigurationOptions();

$response = $interface->GetMetadataConfigurationOptions();

$response = $interface->GetAudioOutputConfigurationOptions();

$response = $interface->GetAudioDecoderConfigurationOptions();

$response = $interface->GetGuaranteedNumberOfVideoEncoderInstances();

$response = $interface->GetStreamUri();

$response = $interface->StartMulticastStreaming();

$response = $interface->StopMulticastStreaming();

$response = $interface->SetSynchronizationPoint();

$response = $interface->GetSnapshotUri();

$response = $interface->GetVideoSourceModes();

$response = $interface->SetVideoSourceMode();

$response = $interface->GetOSDs();

$response = $interface->GetOSD();

$response = $interface->GetOSDOptions();

$response = $interface->SetOSD();

$response = $interface->CreateOSD();

$response = $interface->DeleteOSD();

DESCRIPTION

SOAP Interface for the Media web service located at http://www.examples.com/Media/.

SERVICE Media

Port MediaPort

METHODS

General methods

new

Constructor.

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

SOAP Service methods

Method synopsis is displayed with hash refs as parameters.

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::AddAudioOutputConfigurationRes.

ONVIF::Media::Interfaces::Media::MediaPort(3pm) User Contributed Perl Documentation ONVIF::Media::Interfaces::Media::MediaPort(3pm)

NAME

ONVIF::Media::Interfaces::Media::MediaPort - SOAP Interface for the Media Web Service

SYNOPSIS

use ONVIF::Media::Interfaces::Media::MediaPort;

my $interface = ONVIF::Media::Interfaces::Media::MediaPort->new();

my $response;

$response = $interface->GetServiceCapabilities();

$response = $interface->GetVideoSources();

$response = $interface->GetAudioSources();

$response = $interface->GetAudioOutputs();

$response = $interface->CreateProfile();

$response = $interface->GetProfile();

$response = $interface->GetProfiles();

$response = $interface->AddVideoEncoderConfiguration();

$response = $interface->AddVideoSourceConfiguration();

$response = $interface->AddAudioEncoderConfiguration();

$response = $interface->AddAudioSourceConfiguration();

$response = $interface->AddPTZConfiguration();

$response = $interface->AddVideoAnalyticsConfiguration();

$response = $interface->AddMetadataConfiguration();

$response = $interface->AddAudioOutputConfiguration();

$response = $interface->AddAudioDecoderConfiguration();

$response = $interface->RemoveVideoEncoderConfiguration();

$response = $interface->RemoveVideoSourceConfiguration();

$response = $interface->RemoveAudioEncoderConfiguration();

$response = $interface->RemoveAudioSourceConfiguration();

$response = $interface->RemovePTZConfiguration();

$response = $interface->RemoveVideoAnalyticsConfiguration();

$response = $interface->RemoveMetadataConfiguration();

$response = $interface->RemoveAudioOutputConfiguration();

$response = $interface->RemoveAudioDecoderConfiguration();

$response = $interface->DeleteProfile();

$response = $interface->GetVideoSourceConfigurations();

$response = $interface->GetVideoEncoderConfigurations();

$response = $interface->GetAudioSourceConfigurations();

$response = $interface->GetAudioEncoderConfigurations();

$response = $interface->GetVideoAnalyticsConfigurations();

$response = $interface->GetMetadataConfigurations();

$response = $interface->GetAudioOutputConfigurations();

$response = $interface->GetAudioDecoderConfigurations();

$response = $interface->GetVideoSourceConfiguration();

$response = $interface->GetVideoEncoderConfiguration();

$response = $interface->GetAudioSourceConfiguration();

$response = $interface->GetAudioEncoderConfiguration();

$response = $interface->GetVideoAnalyticsConfiguration();

$response = $interface->GetMetadataConfiguration();

$response = $interface->GetAudioOutputConfiguration();

$response = $interface->GetAudioDecoderConfiguration();

$response = $interface->GetCompatibleVideoEncoderConfigurations();

$response = $interface->GetCompatibleVideoSourceConfigurations();

$response = $interface->GetCompatibleAudioEncoderConfigurations();

$response = $interface->GetCompatibleAudioSourceConfigurations();

$response = $interface->GetCompatibleVideoAnalyticsConfigurations();

$response = $interface->GetCompatibleMetadataConfigurations();

$response = $interface->GetCompatibleAudioOutputConfigurations();

$response = $interface->GetCompatibleAudioDecoderConfigurations();

$response = $interface->SetVideoSourceConfiguration();

$response = $interface->SetVideoEncoderConfiguration();

$response = $interface->SetAudioSourceConfiguration();

$response = $interface->SetAudioEncoderConfiguration();

$response = $interface->SetVideoAnalyticsConfiguration();

$response = $interface->SetMetadataConfiguration();

$response = $interface->SetAudioOutputConfiguration();

$response = $interface->SetAudioDecoderConfiguration();

$response = $interface->GetVideoSourceConfigurationOptions();

$response = $interface->GetVideoEncoderConfigurationOptions();

$response = $interface->GetAudioSourceConfigurationOptions();

$response = $interface->GetAudioEncoderConfigurationOptions();

$response = $interface->GetMetadataConfigurationOptions();

$response = $interface->GetAudioOutputConfigurationOptions();

$response = $interface->GetAudioDecoderConfigurationOptions();

$response = $interface->GetGuaranteedNumberOfVideoEncoderInstances();

$response = $interface->GetStreamUri();

$response = $interface->StartMulticastStreaming();

$response = $interface->StopMulticastStreaming();

$response = $interface->SetSynchronizationPoint();

$response = $interface->GetSnapshotUri();

$response = $interface->GetVideoSourceModes();

$response = $interface->SetVideoSourceMode();

$response = $interface->GetOSDs();

$response = $interface->GetOSD();

$response = $interface->GetOSDOptions();

$response = $interface->SetOSD();

$response = $interface->CreateOSD();

$response = $interface->DeleteOSD();

DESCRIPTION

SOAP Interface for the Media web service located at http://www.examples.com/Media/.

SERVICE Media

Port MediaPort

METHODS

General methods

new

Constructor.

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

SOAP Service methods

Method synopsis is displayed with hash refs as parameters.

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::AddAudioOutputConfigurationRes.

ONVIF::Media::Interfaces::Media::MediaPort(3pm) User Contributed Perl Documentation ONVIF::Media::Interfaces::Media::MediaPort(3pm)

NAME

ONVIF::Media::Interfaces::Media::MediaPort - SOAP Interface for the Media Web Service

SYNOPSIS

use ONVIF::Media::Interfaces::Media::MediaPort;

my $interface = ONVIF::Media::Interfaces::Media::MediaPort->new();

my $response;

$response = $interface->GetServiceCapabilities();

$response = $interface->GetVideoSources();

$response = $interface->GetAudioSources();

$response = $interface->GetAudioOutputs();

$response = $interface->CreateProfile();

$response = $interface->GetProfile();

$response = $interface->GetProfiles();

$response = $interface->AddVideoEncoderConfiguration();

$response = $interface->AddVideoSourceConfiguration();

$response = $interface->AddAudioEncoderConfiguration();

$response = $interface->AddAudioSourceConfiguration();

$response = $interface->AddPTZConfiguration();

$response = $interface->AddVideoAnalyticsConfiguration();

$response = $interface->AddMetadataConfiguration();

$response = $interface->AddAudioOutputConfiguration();

$response = $interface->AddAudioDecoderConfiguration();

$response = $interface->RemoveVideoEncoderConfiguration();

$response = $interface->RemoveVideoSourceConfiguration();

$response = $interface->RemoveAudioEncoderConfiguration();

$response = $interface->RemoveAudioSourceConfiguration();

$response = $interface->RemovePTZConfiguration();

$response = $interface->RemoveVideoAnalyticsConfiguration();

$response = $interface->RemoveMetadataConfiguration();

$response = $interface->RemoveAudioOutputConfiguration();

$response = $interface->RemoveAudioDecoderConfiguration();

$response = $interface->DeleteProfile();

$response = $interface->GetVideoSourceConfigurations();

$response = $interface->GetVideoEncoderConfigurations();

$response = $interface->GetAudioSourceConfigurations();

$response = $interface->GetAudioEncoderConfigurations();

$response = $interface->GetVideoAnalyticsConfigurations();

$response = $interface->GetMetadataConfigurations();

$response = $interface->GetAudioOutputConfigurations();

$response = $interface->GetAudioDecoderConfigurations();

$response = $interface->GetVideoSourceConfiguration();

$response = $interface->GetVideoEncoderConfiguration();

$response = $interface->GetAudioSourceConfiguration();

$response = $interface->GetAudioEncoderConfiguration();

$response = $interface->GetVideoAnalyticsConfiguration();

$response = $interface->GetMetadataConfiguration();

$response = $interface->GetAudioOutputConfiguration();

$response = $interface->GetAudioDecoderConfiguration();

$response = $interface->GetCompatibleVideoEncoderConfigurations();

$response = $interface->GetCompatibleVideoSourceConfigurations();

$response = $interface->GetCompatibleAudioEncoderConfigurations();

$response = $interface->GetCompatibleAudioSourceConfigurations();

$response = $interface->GetCompatibleVideoAnalyticsConfigurations();

$response = $interface->GetCompatibleMetadataConfigurations();

$response = $interface->GetCompatibleAudioOutputConfigurations();

$response = $interface->GetCompatibleAudioDecoderConfigurations();

$response = $interface->SetVideoSourceConfiguration();

$response = $interface->SetVideoEncoderConfiguration();

$response = $interface->SetAudioSourceConfiguration();

$response = $interface->SetAudioEncoderConfiguration();

$response = $interface->SetVideoAnalyticsConfiguration();

$response = $interface->SetMetadataConfiguration();

$response = $interface->SetAudioOutputConfiguration();

$response = $interface->SetAudioDecoderConfiguration();

$response = $interface->GetVideoSourceConfigurationOptions();

$response = $interface->GetVideoEncoderConfigurationOptions();

$response = $interface->GetAudioSourceConfigurationOptions();

$response = $interface->GetAudioEncoderConfigurationOptions();

$response = $interface->GetMetadataConfigurationOptions();

$response = $interface->GetAudioOutputConfigurationOptions();

$response = $interface->GetAudioDecoderConfigurationOptions();

$response = $interface->GetGuaranteedNumberOfVideoEncoderInstances();

$response = $interface->GetStreamUri();

$response = $interface->StartMulticastStreaming();

$response = $interface->StopMulticastStreaming();

$response = $interface->SetSynchronizationPoint();

$response = $interface->GetSnapshotUri();

$response = $interface->GetVideoSourceModes();

$response = $interface->SetVideoSourceMode();

$response = $interface->GetOSDs();

$response = $interface->GetOSD();

$response = $interface->GetOSDOptions();

$response = $interface->SetOSD();

$response = $interface->CreateOSD();

$response = $interface->DeleteOSD();

DESCRIPTION

SOAP Interface for the Media web service located at http://www.examples.com/Media/.

SERVICE Media

Port MediaPort

METHODS

General methods

new

Constructor.

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

SOAP Service methods

Method synopsis is displayed with hash refs as parameters.

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::AddAudioOutputConfigurationRes.

ONVIF::Media::Interfaces::Media::MediaPort(3pm) User Contributed Perl Documentation ONVIF::Media::Interfaces::Media::MediaPort(3pm)

NAME

ONVIF::Media::Interfaces::Media::MediaPort - SOAP Interface for the Media Web Service

SYNOPSIS

use ONVIF::Media::Interfaces::Media::MediaPort;

my $interface = ONVIF::Media::Interfaces::Media::MediaPort->new();

my $response;

$response = $interface->GetServiceCapabilities();

$response = $interface->GetVideoSources();

$response = $interface->GetAudioSources();

$response = $interface->GetAudioOutputs();

$response = $interface->CreateProfile();

$response = $interface->GetProfile();

$response = $interface->GetProfiles();

$response = $interface->AddVideoEncoderConfiguration();

$response = $interface->AddVideoSourceConfiguration();

$response = $interface->AddAudioEncoderConfiguration();

$response = $interface->AddAudioSourceConfiguration();

$response = $interface->AddPTZConfiguration();

$response = $interface->AddVideoAnalyticsConfiguration();

$response = $interface->AddMetadataConfiguration();

$response = $interface->AddAudioOutputConfiguration();

$response = $interface->AddAudioDecoderConfiguration();

$response = $interface->RemoveVideoEncoderConfiguration();

$response = $interface->RemoveVideoSourceConfiguration();

$response = $interface->RemoveAudioEncoderConfiguration();

$response = $interface->RemoveAudioSourceConfiguration();

$response = $interface->RemovePTZConfiguration();

$response = $interface->RemoveVideoAnalyticsConfiguration();

$response = $interface->RemoveMetadataConfiguration();

$response = $interface->RemoveAudioOutputConfiguration();

$response = $interface->RemoveAudioDecoderConfiguration();

$response = $interface->DeleteProfile();

$response = $interface->GetVideoSourceConfigurations();

$response = $interface->GetVideoEncoderConfigurations();

$response = $interface->GetAudioSourceConfigurations();

$response = $interface->GetAudioEncoderConfigurations();

$response = $interface->GetVideoAnalyticsConfigurations();

$response = $interface->GetMetadataConfigurations();

$response = $interface->GetAudioOutputConfigurations();

$response = $interface->GetAudioDecoderConfigurations();

$response = $interface->GetVideoSourceConfiguration();

$response = $interface->GetVideoEncoderConfiguration();

$response = $interface->GetAudioSourceConfiguration();

$response = $interface->GetAudioEncoderConfiguration();

$response = $interface->GetVideoAnalyticsConfiguration();

$response = $interface->GetMetadataConfiguration();

$response = $interface->GetAudioOutputConfiguration();

$response = $interface->GetAudioDecoderConfiguration();

$response = $interface->GetCompatibleVideoEncoderConfigurations();

$response = $interface->GetCompatibleVideoSourceConfigurations();

$response = $interface->GetCompatibleAudioEncoderConfigurations();

$response = $interface->GetCompatibleAudioSourceConfigurations();

$response = $interface->GetCompatibleVideoAnalyticsConfigurations();

$response = $interface->GetCompatibleMetadataConfigurations();

$response = $interface->GetCompatibleAudioOutputConfigurations();

$response = $interface->GetCompatibleAudioDecoderConfigurations();

$response = $interface->SetVideoSourceConfiguration();

$response = $interface->SetVideoEncoderConfiguration();

$response = $interface->SetAudioSourceConfiguration();

$response = $interface->SetAudioEncoderConfiguration();

$response = $interface->SetVideoAnalyticsConfiguration();

$response = $interface->SetMetadataConfiguration();

$response = $interface->SetAudioOutputConfiguration();

$response = $interface->SetAudioDecoderConfiguration();

$response = $interface->GetVideoSourceConfigurationOptions();

$response = $interface->GetVideoEncoderConfigurationOptions();

$response = $interface->GetAudioSourceConfigurationOptions();

$response = $interface->GetAudioEncoderConfigurationOptions();

$response = $interface->GetMetadataConfigurationOptions();

$response = $interface->GetAudioOutputConfigurationOptions();

$response = $interface->GetAudioDecoderConfigurationOptions();

$response = $interface->GetGuaranteedNumberOfVideoEncoderInstances();

$response = $interface->GetStreamUri();

$response = $interface->StartMulticastStreaming();

$response = $interface->StopMulticastStreaming();

$response = $interface->SetSynchronizationPoint();

$response = $interface->GetSnapshotUri();

$response = $interface->GetVideoSourceModes();

$response = $interface->SetVideoSourceMode();

$response = $interface->GetOSDs();

$response = $interface->GetOSD();

$response = $interface->GetOSDOptions();

$response = $interface->SetOSD();

$response = $interface->CreateOSD();

$response = $interface->DeleteOSD();

DESCRIPTION

SOAP Interface for the Media web service located at http://www.examples.com/Media/.

SERVICE Media

Port MediaPort

METHODS

General methods

new

Constructor.

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

SOAP Service methods

Method synopsis is displayed with hash refs as parameters.

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->AddVideoEncoderConfigurati

perl v5.26.0 2017-08-14 ONVIF::Media::Interfaces::Media::MediaPort(3pm)