Recording

Recording service implementation.

`Recording`

Bases: ONVIFService

Recording service client.

Property	Details
First introduced	ONVIF Release 2.1 (June 2011) Split from Core 2.0
Binding name	`RecordingBinding` (`ver10/recording.wsdl`)
Operations	recording.wsdl
Specification	RecordingControl.xml

`GetServiceCapabilities()`

Returns the capabilities of the recording service.

The result is returned in a typed answer.

`CreateRecording(RecordingConfiguration)`

CreateRecording shall create a new recording.

The new recording shall be created with a track for each supported TrackType see Recording Control Spec.

This method is optional. It shall be available if the Recording/DynamicRecordings capability is TRUE.

When successfully completed, CreateRecording shall have created three tracks with the following configurations:

TrackToken TrackType
VIDEO001 Video
AUDIO001 Audio
META001 Metadata

All tracks created as response to a CreateRecording request shall have the MaximumRetentionTime set to 0 (unlimited), and the Description set to the empty string, by default.

`DeleteRecording(RecordingToken)`

DeleteRecording shall delete a recording object.

Whenever a recording is deleted, the device shall delete all the tracks that are part of the recording, and it shall delete all the Recording Jobs that record into the recording. For each deleted recording job, the device shall also delete all the receiver objects associated with the recording job that are automatically created using the AutoCreateReceiver field of the recording job configuration structure and are not used in any other recording job.

This method is optional. It shall be available if the Recording/DynamicRecordings capability is TRUE.

`GetRecordings()`

GetRecordings shall return a description of all the recordings in the device.

This description shall include a list of all the tracks for each recording.

`SetRecordingConfiguration(RecordingToken, RecordingConfiguration)`

SetRecordingConfiguration shall change the configuration of a recording.

`GetRecordingConfiguration(RecordingToken)`

GetRecordingConfiguration shall retrieve the recording configuration for a recording.

`GetRecordingOptions(RecordingToken)`

GetRecordingOptions returns information for a recording identified by the RecordingToken.

The information includes the number of additonal tracks as well as recording jobs that can be configured.

`CreateTrack(RecordingToken, TrackConfiguration)`

This method shall create a new track within a recording.

This method is optional. It shall be available if the Recording/DynamicTracks capability is TRUE.

A TrackToken in itself does not uniquely identify a specific track. Tracks within different recordings may have the same TrackToken.

`DeleteTrack(RecordingToken, TrackToken)`

DeleteTrack shall remove a track from a recording.

All the data in the track shall be deleted.

This method is optional. It shall be available if the Recording/DynamicTracks capability is TRUE.

`GetTrackConfiguration(RecordingToken, TrackToken)`

GetTrackConfiguration shall retrieve the configuration for a specific track.

`SetTrackConfiguration(RecordingToken, TrackToken, TrackConfiguration)`

SetTrackConfiguration shall change the configuration of a track.

`CreateRecordingJob(JobConfiguration)`

CreateRecordingJob shall create a new recording job.

The JobConfiguration returned from CreateRecordingJob shall be identical to the JobConfiguration passed into CreateRecordingJob, except for the ReceiverToken and the AutoCreateReceiver. In the returned structure, the ReceiverToken shall be present and valid and the AutoCreateReceiver field shall be omitted.

`DeleteRecordingJob(JobToken)`

DeleteRecordingJob removes a recording job.

It shall also implicitly delete all the receiver objects associated with the recording job that are automatically created using the AutoCreateReceiver field of the recording job configuration structure and are not used in any other recording job.

`GetRecordingJobs()`

GetRecordingJobs shall return a list of all the recording jobs in the device.

`SetRecordingJobConfiguration(JobToken, JobConfiguration)`

SetRecordingJobConfiguration shall change the configuration for a recording job.

SetRecordingJobConfiguration shall implicitly delete any receiver objects that were created automatically if they are no longer used as a result of changing the recording job configuration.

`GetRecordingJobConfiguration(JobToken)`

GetRecordingJobConfiguration shall return the current configuration for a recording job.

`SetRecordingJobMode(JobToken, Mode)`

SetRecordingJobMode shall change the mode of the recording job.

Using this method shall be equivalent to retrieving the recording job configuration, and writing it back with a different mode.

`GetRecordingJobState(JobToken)`

GetRecordingJobState returns the state of a recording job.

It includes an aggregated state, and state for each track of the recording job.

`ExportRecordedData(SearchScope, FileFormat, StorageDestination, StartPoint=None, EndPoint=None)`

Exports the selected recordings (from existing recorded data) to the given storage target based on the requested file format.

`StopExportRecordedData(OperationToken)`

Stops the selected ExportRecordedData operation.

`GetExportRecordedDataState(OperationToken)`

Retrieves the status of selected ExportRecordedData operation.

`OverrideSegmentDuration(TargetSegmentDuration, Expiration, RecordingConfiguration)`

Requests a temporary override of the target segment duration for a recording configuration.

`ListRecordedSegments(Time, RecordingToken, MaxResults=None)`

Lists available recorded segments related to the specified RecordingToken.

`ExportRecordedSegments(Time, RecordingToken, Alias=None, StorageToken=None, Track=None)`

Exports the selected recorded segments (from existing recorded data) to the storage attached to the given recording configuration.

`StopExportRecordedSegments(OperationToken)`

Stops the selected ExportRecordedSegments operation.