onvif
    Preparing search index...

    Interface Search

    Search service (Profile G) — recording / event / PTZ position search.

    Example: Summarize recordings, run a find, page results, then end the search:

    import { Onvif } from 'onvif';

    const onvif = new Onvif({ hostname: '192.168.1.13', username: 'admin', password: 'admin' });
    await onvif.connect();

    const summary = await onvif.search.getRecordingSummary();
    console.log(summary.numberRecordings, summary.dataFrom, summary.dataUntil);

    const recordings = await onvif.recording.getRecordings();
    const searchToken = await onvif.search.findRecordings({
      scope: { includedRecordings: [recordings[0]!.recordingToken] },
      keepAliveTime: 'PT30S',
    });

    const results = await onvif.search.getRecordingSearchResults({
      searchToken,
      maxResults: 20,
    });
    console.log(results.recordingInformation);
    await onvif.search.endSearch({ searchToken });
    interface Search {
        onvif: Onvif;
        service: keyof OnvifServices;
        xmlns: string;
        endSearch(options: EndSearch): Promise<Date>;
        findEvents(options: FindEvents): Promise<string>;
        findMetadata(options: FindMetadata): Promise<string>;
        findPTZPosition(options: FindPTZPosition): Promise<string>;
        findRecordings(options: FindRecordings): Promise<string>;
        getEventSearchResults(
            options: GetEventSearchResults,
        ): Promise<FindEventResultList>;
        getMediaAttributes(options: GetMediaAttributes): Promise<MediaAttributes[]>;
        getMetadataSearchResults(
            options: GetMetadataSearchResults,
        ): Promise<FindMetadataResultList>;
        getPTZPositionSearchResults(
            options: GetPTZPositionSearchResults,
        ): Promise<FindPTZPositionResultList>;
        getRecordingInformation(
            options: GetRecordingInformation,
        ): Promise<RecordingInformation>;
        getRecordingSearchResults(
            options: GetRecordingSearchResults,
        ): Promise<FindRecordingResultList>;
        getRecordingSummary(
            _options?: GetRecordingSummary,
        ): Promise<RecordingSummary>;
        getSearchState(options: GetSearchState): Promise<SearchState>;
        getServiceCapabilities(): Promise<Capabilities>;
        request<T = any>(
            body: OnvifSoapBody,
            options?: LineraseOptions,
        ): Promise<T>;
    }

    Hierarchy (View Summary)

    Index
    onvif service xmlns
    endSearch findEvents findMetadata findPTZPosition findRecordings getEventSearchResults getMediaAttributes getMetadataSearchResults getPTZPositionSearchResults getRecordingInformation getRecordingSearchResults getRecordingSummary getSearchState getServiceCapabilities request
    onvif: Onvif
    service: keyof OnvifServices
    xmlns: string

    • Starts a search for events in recorded data.

      Parameters

      Returns Promise<string>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods