Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ReplayKit.StopRecording

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function StopRecording(): bool;
public static bool StopRecording();

Returns

bool A boolean value of True if recording stopped successfully or False if an error occurred.

Description

Stop the current recording.

Stops the current recording, and makes it available for preview or discard, provided there are no errors. To show the recording, call Preview().

If ReplayKit.APIAvailable is false, this method does nothing and returns false.