The capabilities for the search service is returned in the Capabilities element.
Indicates support for general virtual property events in the FindEvents method.
Scope defines the dataset to consider for this search.
The search will be completed after this many matches. If not specified, the search will continue until reaching the endpoint or until the session expires.
The time the search session will be kept alive after responding to this and subsequent requests. A device shall support at least values up to ten seconds.
Gets results from a particular recording listingession.
The search session to get results from.
The minimum number of results to return in one response.
The maximum number of results to return in one response.
The maximum time before responding to the request, even if the MinResults parameter is not fulfilled.
Starts a search session and specifies the search parameters.
The point of time where the search will start.
The point of time where the search will stop. This can be a time before the StartPoint, in which case the search is performed backwards in time.
Setting IncludeStartState to true means that the server should return virtual events representing the start state for any recording included in the scope. Start state events are limited to the topics defined in the SearchFilter that have the IsProperty flag set to true.
The search will be completed after this many matches. If not specified, the search will continue until reaching the endpoint or until the session expires.
The time the search session will be kept alive after responding to this and subsequent requests. A device shall support at least values up to ten seconds.
A unique reference to the search session created by this request.
Gets results from a particular search session.
The search session to get results from.
The minimum number of results to return in one response.
The maximum number of results to return in one response.
The maximum time before responding to the request, even if the MinResults parameter is not fulfilled.
Starts a search session and specifies the search parameters.
The point of time where the search will start.
The point of time where the search will stop. This can be a time before the StartPoint, in which case the search is performed backwards in time.
The search will be completed after this many matches. If not specified, the search will continue until reaching the endpoint or until the session expires.
The time the search session will be kept alive after responding to this and subsequent requests. A device shall support at least values up to ten seconds.
A unique reference to the search session created by this request.
Gets results from a particular search session.
The search session to get results from.
The minimum number of results to return in one response.
The maximum number of results to return in one response.
The maximum time before responding to the request, even if the MinResults parameter is not fulfilled.
Starts a search session and specifies the search parameters.
The point of time where the search will start.
The point of time where the search will stop. This can be a time before the StartPoint, in which case the search is performed backwards in time.
The search will be completed after this many matches. If not specified, the search will continue until reaching the endpoint or until the session expires.
The time the search session will be kept alive after responding to this and subsequent requests. A device shall support at least values up to ten seconds.
A unique reference to the search session created by this request.
Gets results from a particular search session.
The search session to get results from.
The minimum number of results to return in one response.
The maximum number of results to return in one response.
The maximum time before responding to the request, even if the MinResults parameter is not fulfilled.
Returns the state of an ongoing search session.
The search session to get the state from.
Ends an ongoing search session, freeing any resources.
The search session to end.
The point of time the search had reached when it was ended. It is equal to the EndPoint specified in Find-operation if the search was completed.
Returns the capabilities of the search service. The result is returned in a typed answer.
GetRecordingSummary is used to get a summary description of all recorded data. This
operation is mandatory to support for a device implementing the recording search service.
Returns information about a single Recording specified by a RecordingToken. This operation
is mandatory to support for a device implementing the recording search service.
Returns a set of media attributes for all tracks of the specified recordings at a specified point
in time. Clients using this operation shall be able to use it as a non blocking operation. A
device shall set the starttime and endtime of the MediaAttributes structure to equal values if
calculating this range would causes this operation to block. See MediaAttributes structure for
more information. This operation is mandatory to support for a device implementing the
recording search service.
FindRecordings starts a search session, looking for recordings that matches the scope (See
20.2.4) defined in the request. Results from the search are acquired using the
GetRecordingSearchResults request, specifying the search token returned from this request.
The device shall continue searching until one of the following occurs:
- The entire time range from StartPoint to EndPoint has been searched through.
- The total number of matches has been found, defined by the MaxMatches parameter.
- The session has been ended by a client EndSession request.
- The session has been ended because KeepAliveTime since the last request related to
this session has expired.
The order of the results is undefined, to allow the device to return results in any order they
are found. This operation is mandatory to support for a device implementing the recording
search service.
GetRecordingSearchResults acquires the results from a recording search session previously
initiated by a FindRecordings operation. The response shall not include results already
returned in previous requests for the same session. If MaxResults is specified, the response
shall not contain more than MaxResults results. The number of results relates to the number of recordings.
For viewing individual recorded data for a signal track use the FindEvents method.
GetRecordingSearchResults shall block until:
-
MaxResults results are available for the response if MaxResults is specified.
- MinResults results are available for the response if MinResults is specified.
- WaitTime has expired.
- Search is completed or stopped.
This operation is mandatory to support for a device implementing the recording search service.
FindEvents starts a search session, looking for recording events (in the scope that
matches the search filter defined in the request. Results from the search are
acquired using the GetEventSearchResults request, specifying the search token returned from
this request.
The device shall continue searching until one of the following occurs:
-
The entire time range from StartPoint to EndPoint has been searched through.
- The total number of matches has been found, defined by the MaxMatches parameter.
- The session has been ended by a client EndSession request.
- The session has been ended because KeepAliveTime since the last request related to
this session has expired.
Results shall be ordered by time, ascending in case of forward search, or descending in case
of backward search. This operation is mandatory to support for a device implementing the
recording search service.
GetEventSearchResults acquires the results from a recording event search session previously
initiated by a FindEvents operation. The response shall not include results already returned in
previous requests for the same session. If MaxResults is specified, the response shall not
contain more than MaxResults results.
GetEventSearchResults shall block until:
-
MaxResults results are available for the response if MaxResults is specified.
- MinResults results are available for the response if MinResults is specified.
- WaitTime has expired.
- Search is completed or stopped.
This operation is mandatory to support for a device implementing the recording search service.
FindPTZPosition starts a search session, looking for ptz positions in the scope (See 20.2.4)
that matches the search filter defined in the request. Results from the search are acquired
using the GetPTZPositionSearchResults request, specifying the search token returned from
this request.
The device shall continue searching until one of the following occurs:
-
The entire time range from StartPoint to EndPoint has been searched through.
- The total number of matches has been found, defined by the MaxMatches parameter.
- The session has been ended by a client EndSession request.
- The session has been ended because KeepAliveTime since the last request related to
this session has expired.
This operation is mandatory to support whenever CanContainPTZ is true for any metadata
track in any recording on the device.
GetPTZPositionSearchResults acquires the results from a ptz position search session
previously initiated by a FindPTZPosition operation. The response shall not include results
already returned in previous requests for the same session. If MaxResults is specified, the
response shall not contain more than MaxResults results.
GetPTZPositionSearchResults shall block until:
-
MaxResults results are available for the response if MaxResults is specified.
- MinResults results are available for the response if MinResults is specified.
- WaitTime has expired.
- Search is completed or stopped.
This operation is mandatory to support whenever CanContainPTZ is true for any metadata
track in any recording on the device.
GetSearchState returns the current state of the specified search session. This command is deprecated .
EndSearch stops and ongoing search session, causing any blocking result request to return
and the SearchToken to become invalid. If the search was interrupted before completion, the
point in time that the search had reached shall be returned. If the search had not yet begun,
the StartPoint shall be returned. If the search was completed the original EndPoint supplied
by the Find operation shall be returned. When issuing EndSearch on a FindRecordings request the
EndPoint is undefined and shall not be used since the FindRecordings request doesn't have
StartPoint/EndPoint. This operation is mandatory to support for a device implementing the
recording search service.
FindMetadata starts a search session, looking for metadata in the scope (See 20.2.4) that
matches the search filter defined in the request. Results from the search are acquired using
the GetMetadataSearchResults request, specifying the search token returned from this
request.
The device shall continue searching until one of the following occurs:
-
The entire time range from StartPoint to EndPoint has been searched through.
- The total number of matches has been found, defined by the MaxMatches parameter.
- The session has been ended by a client EndSession request.
- The session has been ended because KeepAliveTime since the last request related to
this session has expired.
This operation is mandatory to support if the MetaDataSearch capability is set to true in the
SearchCapabilities structure return by the GetCapabilities command in the Device service.
GetMetadataSearchResults acquires the results from a recording search session previously
initiated by a FindMetadata operation. The response shall not include results already returned
in previous requests for the same session. If MaxResults is specified, the response shall not
contain more than MaxResults results.
GetMetadataSearchResults shall block until:
-
MaxResults results are available for the response if MaxResults is specified.
- MinResults results are available for the response if MinResults is specified.
- WaitTime has expired.
- Search is completed or stopped.
This operation is mandatory to support if the MetaDataSearch capability is set to true in the
SearchCapabilities structure return by the GetCapabilities command in the Device service.