overwolf.media.replays.capture

Overwolf APIs / overwolf / overwolf / media / replays / capture

Call Signature

function capture(
  pastDuration: number,
  futureDuration: number,
  captureFinishedCallback: CallbackFunction<ReplayResult>,
  callback: CallbackFunction<StartReplayResult>,
): void;

Starts capturing a replay to a file. A replay id will be returned in the callback which is needed to finish capturing the replay. You can only call this method if replay mode is on and no other replay is currently being captured to a file.

Parameters

Parameter	Type	Description
pastDuration	number	The replay length, in milliseconds to include prior to the time of this call.
futureDuration	number	The replay lengh, in milliseconds to include after the time of this call. To ignore it, simply give it a non-positive value
captureFinishedCallback	CallbackFunction<ReplayResult>	A callback function which will be called when capturing is finished, at the end of the future duration supplied to this call.
callback	CallbackFunction<StartReplayResult>	A callback function which will be called with the status of the request.

Returns

void

Call Signature

function capture(
  replayType: Video,
  pastDuration: number,
  futureDuration: number,
  captureFinishedCallback: CallbackFunction<ReplayResult>,
  callback: CallbackFunction<Result>,
): void;

Starts capturing a replay to a file. A replay id will be returned in the callback which is needed to finish capturing the replay. You can only call this method if replay mode is on and no other replay is currently being captured to a file.

Parameters

Parameter	Type	Description
replayType	Video	The type of replay to capture.
pastDuration	number	The replay length, in milliseconds to include prior to the time of this call.
futureDuration	number	The replay length, in milliseconds to include after the time of this call. To ignore it, simply give it a non-positive value
captureFinishedCallback	CallbackFunction<ReplayResult>	A callback function which will be called when capturing is finished, at the end of the future duration supplied to this call.
callback	CallbackFunction<Result>	A callback function which will be called with the status of the request.

Returns

void

Deprecated

Since version 0.155.