Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

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

ReplayKit.StartRecording

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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 StartRecording(enableMicrophone: bool = false): bool;
public static bool StartRecording(bool enableMicrophone = false);

Parameters

enableMicrophone Enable or disable the microphone while making a recording. Enabling the microphone allows you to include user commentary while recording. The default value is false.

Returns

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

Description

Start a new recording.

When StartRecording() is first called, an alert window displays asking the user to confirm recording. The alert window displays again if 8 minutes or more have passed since the last time StartRecording() was called.

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

Copyright © 2016 Unity Technologies. Publication 5.4b-R
Tutorials Community Answers Knowledge Base Forums Asset Store