ReviewsGetVideoFramesOptionalParams interface
Optional Parameters.
- Extends
-
RequestOptionsBase
Properties
| abort |
The signal which can be used to abort requests. |
| custom |
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent. |
| filter | Get frames filtered by tags. |
| no |
Number of frames to fetch. |
| on |
Callback which fires upon download progress. |
| on |
Callback which fires upon upload progress. |
| start |
Time stamp of the frame from where you want to start fetching the frames. |
| timeout | The number of milliseconds a request can take before automatically being terminated. |
Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
AbortSignalLike
customHeaders
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
customHeaders?: undefined | [key: string]: string
Property Value
undefined | [key: string]: string
filter
Get frames filtered by tags.
filter?: undefined | string
Property Value
undefined | string
noOfRecords
Number of frames to fetch.
noOfRecords?: undefined | number
Property Value
undefined | number
onDownloadProgress
Callback which fires upon download progress.
onDownloadProgress?: undefined | (progress: TransferProgressEvent) => void
Property Value
undefined | (progress: TransferProgressEvent) => void
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: undefined | (progress: TransferProgressEvent) => void
Property Value
undefined | (progress: TransferProgressEvent) => void
startSeed
Time stamp of the frame from where you want to start fetching the frames.
startSeed?: undefined | number
Property Value
undefined | number
timeout
The number of milliseconds a request can take before automatically being terminated.
timeout?: undefined | number
Property Value
undefined | number