Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

ReplayKit.Discard

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 Discard(): bool;
public static bool Discard();

Returns

bool A boolean value of True if the recording was discarded successfully or False if an error occurred.

Description

Discard the current recording.

Discards the current recording, if it exists. Does nothing if there is no current recording.

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