Class Search

Search service

Example

const summary = await cam.search.getRecordingSummary();
const token = await cam.search.findRecordings({
  scope: { includedRecordings: ['RecordingToken_1'] },
  keepAliveTime: 'PT10S',
});
const results = await cam.search.getRecordingSearchResults({ searchToken: token });
await cam.search.endSearch({ searchToken: token });

Hierarchy (View Summary)

default
- Search

Constructors

constructor

new Search(onvif: Onvif): Search
Parameters
- onvif: Onvif
Returns Search
Overrides default.constructor
- Defined in search.ts:57

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

endSearch

endSearch(options: EndSearch): Promise<Date>
Ends a search session.
Parameters
- options: EndSearch
Returns Promise<Date>
- Defined in search.ts:328

findEvents

findEvents(options: FindEvents): Promise<string>
Starts a search for events in recorded data.
Parameters
- options: FindEvents
Returns Promise<string>
- Defined in search.ts:196

findMetadata

findMetadata(options: FindMetadata): Promise<string>
Starts a search for metadata in recorded data.
Parameters
- options: FindMetadata
Returns Promise<string>
- Defined in search.ts:276

findPTZPosition

findPTZPosition(options: FindPTZPosition): Promise<string>
Starts a search for PTZ positions in recorded metadata.
Parameters
- options: FindPTZPosition
Returns Promise<string>
- Defined in search.ts:237

findRecordings

findRecordings(options: FindRecordings): Promise<string>
Starts a search for recordings matching the scope.
Parameters
- options: FindRecordings
Returns Promise<string>
- Defined in search.ts:167

getEventSearchResults

getEventSearchResults(
options: GetEventSearchResults,
): Promise<FindEventResultList>
Returns results from an event search session.
Parameters
- options: GetEventSearchResults
Returns Promise<FindEventResultList>
- Defined in search.ts:223

getMediaAttributes

getMediaAttributes(options: GetMediaAttributes): Promise<MediaAttributes[]>
Returns media attributes valid at a specific point in time.
Parameters
- options: GetMediaAttributes
Returns Promise<MediaAttributes[]>
- Defined in search.ts:148

getMetadataSearchResults

getMetadataSearchResults(
options: GetMetadataSearchResults,
): Promise<FindMetadataResultList>
Returns results from a metadata search session.
Parameters
- options: GetMetadataSearchResults
Returns Promise<FindMetadataResultList>
- Defined in search.ts:301

getPTZPositionSearchResults

getPTZPositionSearchResults(
options: GetPTZPositionSearchResults,
): Promise<FindPTZPositionResultList>
Returns results from a PTZ position search session.
Parameters
- options: GetPTZPositionSearchResults
Returns Promise<FindPTZPositionResultList>
- Defined in search.ts:262

getRecordingInformation

getRecordingInformation(
options: GetRecordingInformation,
): Promise<RecordingInformation>
Returns detailed information about a recording.
Parameters
- options: GetRecordingInformation
Returns Promise<RecordingInformation>
- Defined in search.ts:135

getRecordingSearchResults

getRecordingSearchResults(
options: GetRecordingSearchResults,
): Promise<FindRecordingResultList>
Returns results from a recording search session.
Parameters
- options: GetRecordingSearchResults
Returns Promise<FindRecordingResultList>
- Defined in search.ts:182

getRecordingSummary

getRecordingSummary(_options?: GetRecordingSummary): Promise<RecordingSummary>
Returns a summary of recorded data on the device.
Parameters
- _options: GetRecordingSummary = {}
Returns Promise<RecordingSummary>
- Defined in search.ts:126

getSearchState

getSearchState(options: GetSearchState): Promise<SearchState>
Returns the state of a search session.
Parameters
- options: GetSearchState
Returns Promise<SearchState>
- Defined in search.ts:315

getServiceCapabilities

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

Returns Promise<Capabilities>
- Defined in search.ts:116

request

request<T = any>(
body: Record<string, any>,
options?: LineraseOptions,
): Promise<T>
Type Parameters
- T = any
Parameters
- body: Record<string, any>
- Optionaloptions: LineraseOptions
Returns Promise<T>
Inherited from default.request
- Defined in service.ts:49

Class Search

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Search

Properties

Protected Readonlyonvif

Protected Readonlyservice

Protected Readonlyxmlns

Methods

endSearch

Parameters

Returns Promise<Date>

findEvents

Parameters

Returns Promise<string>

findMetadata

Parameters

Returns Promise<string>

findPTZPosition

Parameters

Returns Promise<string>

findRecordings

Parameters

Returns Promise<string>

getEventSearchResults

Parameters

Returns Promise<FindEventResultList>

getMediaAttributes

Parameters

Returns Promise<MediaAttributes[]>

getMetadataSearchResults

Parameters

Returns Promise<FindMetadataResultList>

getPTZPositionSearchResults

Parameters

Returns Promise<FindPTZPositionResultList>

getRecordingInformation

Parameters

Returns Promise<RecordingInformation>

getRecordingSearchResults

Parameters

Returns Promise<FindRecordingResultList>

getRecordingSummary

Parameters

Returns Promise<RecordingSummary>

getSearchState

Parameters

Returns Promise<SearchState>

getServiceCapabilities

Returns Promise<Capabilities>

request

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page

`Protected` `Readonly`onvif

`Protected` `Readonly`service

`Protected` `Readonly`xmlns