Class Recording

Recording service

Hierarchy (View Summary)

default
- Recording

Constructors

constructor

new Recording(onvif: Onvif, service: keyof OnvifServices): Recording
Parameters
- onvif: Onvif
- service: keyof OnvifServices
Returns Recording
Overrides default.constructor
- Defined in recording.ts:55

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

createRecording

createRecording(options: CreateRecording): Promise<string>
Create a new recording.
Parameters
- options: CreateRecording
Returns Promise<string>
- Defined in recording.ts:172

createRecordingJob

createRecordingJob(
options: CreateRecordingJob,
): Promise<CreateRecordingJobResponse>
Create a new recording job.
Parameters
- options: CreateRecordingJob
Returns Promise<CreateRecordingJobResponse>
- Defined in recording.ts:306

createTrack

createTrack(options: CreateTrack): Promise<string>
Create a new track within a recording.
Parameters
- options: CreateTrack
Returns Promise<string>
- Defined in recording.ts:247

deleteRecording

deleteRecording(options: DeleteRecording): Promise<void>
Delete a recording.
Parameters
- options: DeleteRecording
Returns Promise<void>
- Defined in recording.ts:185

deleteRecordingJob

deleteRecordingJob(options: DeleteRecordingJob): Promise<void>
Remove a recording job.
Parameters
- options: DeleteRecordingJob
Returns Promise<void>
- Defined in recording.ts:319

deleteTrack

deleteTrack(options: DeleteTrack): Promise<void>
Remove a track from a recording.
Parameters
- options: DeleteTrack
Returns Promise<void>
- Defined in recording.ts:261

exportRecordedData

exportRecordedData(
options: ExportRecordedData,
): Promise<ExportRecordedDataResponse>
Export selected recordings to a storage target.
Parameters
- options: ExportRecordedData
Returns Promise<ExportRecordedDataResponse>
- Defined in recording.ts:395

getExportRecordedDataState

getExportRecordedDataState(
options: GetExportRecordedDataState,
): Promise<GetExportRecordedDataStateResponse>
Retrieve the state of an ExportRecordedData operation.
Parameters
- options: GetExportRecordedDataState
Returns Promise<GetExportRecordedDataStateResponse>
- Defined in recording.ts:433

getRecordingConfiguration

getRecordingConfiguration(
options: GetRecordingConfiguration,
): Promise<RecordingConfiguration>
Retrieve the recording configuration for a recording.
Parameters
- options: GetRecordingConfiguration
Returns Promise<RecordingConfiguration>
- Defined in recording.ts:221

getRecordingJobConfiguration

getRecordingJobConfiguration(
options: GetRecordingJobConfiguration,
): Promise<RecordingJobConfiguration>
Return the current configuration for a recording job.
Parameters
- options: GetRecordingJobConfiguration
Returns Promise<RecordingJobConfiguration>
- Defined in recording.ts:356

getRecordingJobs

getRecordingJobs(): Promise<GetRecordingJobsResponseItem[]>
Return a list of all recording jobs on the device.

Returns Promise<GetRecordingJobsResponseItem[]>
- Defined in recording.ts:330

getRecordingJobState

getRecordingJobState(options: GetRecordingJobState): Promise<any>
Return the state of a recording job.
Parameters
- options: GetRecordingJobState
Returns Promise<any>
- Defined in recording.ts:382

getRecordingOptions

getRecordingOptions(options: GetRecordingOptions): Promise<RecordingOptions>
Return recording options for a recording token.
Parameters
- options: GetRecordingOptions
Returns Promise<RecordingOptions>
- Defined in recording.ts:234

getRecordings

getRecordings(): Promise<GetRecordingsResponseItem[]>
Return descriptions of all recordings on the device.

Returns Promise<GetRecordingsResponseItem[]>
- Defined in recording.ts:196

getServiceCapabilities

getServiceCapabilities(): Promise<Capabilities>
Returns the capabilities of the recording service.

Returns Promise<Capabilities>
- Defined in recording.ts:161

getTrackConfiguration

getTrackConfiguration(
options: GetTrackConfiguration,
): Promise<TrackConfiguration>
Retrieve the configuration for a specific track.
Parameters
- options: GetTrackConfiguration
Returns Promise<TrackConfiguration>
- Defined in recording.ts:274

overrideSegmentDuration

overrideSegmentDuration(options: OverrideSegmentDuration): Promise<void>
Request a temporary override of the target segment duration for a recording.
Parameters
- options: OverrideSegmentDuration
Returns Promise<void>
- Defined in recording.ts:448

request

request(query: Record<string, any>, options?: LineraseOptions): Promise<any>
Parameters
- query: Record<string, any>
- Optionaloptions: LineraseOptions
Returns Promise<any>
Inherited from default.request
- Defined in service.ts:37

setRecordingConfiguration

setRecordingConfiguration(options: SetRecordingConfiguration): Promise<void>
Change the configuration of a recording.
Parameters
- options: SetRecordingConfiguration
Returns Promise<void>
- Defined in recording.ts:205

setRecordingJobConfiguration

setRecordingJobConfiguration(
options: SetRecordingJobConfiguration,
): Promise<SetRecordingJobConfigurationResponse>
Change the configuration for a recording job.
Parameters
- options: SetRecordingJobConfiguration
Returns Promise<SetRecordingJobConfigurationResponse>
- Defined in recording.ts:339

setRecordingJobMode

setRecordingJobMode(options: SetRecordingJobMode): Promise<void>
Change the mode of a recording job.
Parameters
- options: SetRecordingJobMode
Returns Promise<void>
- Defined in recording.ts:369

setTrackConfiguration

setTrackConfiguration(options: SetTrackConfiguration): Promise<void>
Change the configuration of a track.
Parameters
- options: SetTrackConfiguration
Returns Promise<void>
- Defined in recording.ts:288

stopExportRecordedData

stopExportRecordedData(
options: StopExportRecordedData,
): Promise<StopExportRecordedDataResponse>
Stop an ExportRecordedData operation.
Parameters
- options: StopExportRecordedData
Returns Promise<StopExportRecordedDataResponse>
- Defined in recording.ts:420