getCaptureData method
Retrieves video data for a specific time range.
May throw AccessDeniedException.
May throw InternalFailureException.
May throw InvalidRequestException.
May throw ResourceNotFoundException.
May throw ThrottlingException.
Parameter endTime :
The end time for the video data range. Must be greater than startTime.
Parameter startTime :
The start time for the video data range.
Parameter workspaceName :
The name of the workspace that contains the capture source.
Parameter formatSettings :
The optional format settings for the output.
Parameter nextToken :
The token from a previous response used to continue retrieving data.
Parameter propertyAlias :
The property alias that identifies the capture source. Mutually exclusive
with timeSeriesId.
Parameter timeSeriesId :
The time series ID that identifies the capture source. Mutually exclusive
with propertyAlias.
Implementation
Future<GetCaptureDataResponse> getCaptureData({
required TimeInNanos endTime,
required TimeInNanos startTime,
required String workspaceName,
FormatSettings? formatSettings,
String? nextToken,
String? propertyAlias,
String? timeSeriesId,
}) async {
final $payload = <String, dynamic>{
'endTime': endTime,
'startTime': startTime,
if (formatSettings != null) 'formatSettings': formatSettings,
if (nextToken != null) 'nextToken': nextToken,
if (propertyAlias != null) 'propertyAlias': propertyAlias,
if (timeSeriesId != null) 'timeSeriesId': timeSeriesId,
};
final response = await _protocol.send(
payload: $payload,
method: 'POST',
requestUri:
'/workspaces/${Uri.encodeComponent(workspaceName)}/get-capture-data',
hostPrefix: 'data.',
exceptionFnMap: _exceptionFns,
);
return GetCaptureDataResponse.fromJson(response);
}