overwolf.media.replays.stopCapture

Overwolf APIs / overwolf / overwolf / media / replays / stopCapture

Call Signature

function stopCapture(
  replayId: string,
  callback: CallbackFunction<ReplayResult>,
): void;

Finishes capturing a replay and returns a url to the created video file. You can only call this method if replay mode is on and using a valid id of a replay being captured to a file.

Parameters

Parameter	Type	Description
replayId	string	The id of the replay you want to finish capturing.
callback	CallbackFunction<ReplayResult>	A callback function which will be called with the status of the request.

Returns

void

Call Signature

function stopCapture(
  replayType: Video,
  replayId: string,
  callback: CallbackFunction<FileResult>,
): void;

Finishes capturing a replay and returns a url to the created video file. You can only call this method if replay mode is on and using a valid id of a replay being captured to a file.

Parameters

Parameter	Type	Description
replayType	Video	The type of replay to stop capture.
replayId	string	The id of the replay you want to finish capturing.
callback	CallbackFunction<FileResult>	A callback function which will be called with the status of the request.

Returns

void

Deprecated

Since version 0.155.