Cross Platform Screen Recorder Kit
  • Introduction
  • Installation
  • Version 2 vs Version 1
  • Plugin Structure
    • Settings
    • Folder Paths
  • API
    • Create
    • Can Record (Service Availability)
    • Register Listeners
    • Is Recording
    • Is Paused or Recording
    • Prepare Recording
    • Start Recording
    • Stop Recording
    • Open Recording
    • Discard Recording
    • Save Recorded Video
    • Share Recorded Video
    • Flush
  • Limitations
    • Android
  • Misc
    • Using in Native Android Projects (UaaL)
  • Upgrades
    • 2.4.2
    • 2.4.1
    • 2.4.0
    • 2.3.1
    • 2.3.0
    • 2.2.0
    • 2.1.0
    • 2.0.0
    • 1.7.0
    • 1.6
    • 1.5
  • Release Notes
    • 2.4.2
    • 2.4.1
    • 2.4.0
    • 2.3.1
    • 2.3.0
    • 2.2.0
    • 2.1.0
    • 2.0.0
    • 1.7.0
    • 1.6
    • 1.5
    • 1.4
    • 1.3
    • 1.0
Powered by GitBook
On this page

Was this helpful?

  1. API

Prepare Recording

This shows the required permissions and gets everything ready for actual recording. Gif recording doesn't need any permissions but video recording on native platforms will request user to allow recording.

recorder.PrepareRecording(callback: (success, error) =>
{
    if (success)
    {
        Debug.Log("Prepare recording successful.");
        //Call StartRecording here.
    }
    else
    {
        Debug.Log($"Prepare recording failed with error [{error}]");
    }
});

Once after calling PrepareRecording, you can go ahead with StartRecording.

It's not mandatory to call PrepareRecording before StartRecording as StartRecording will internally call prepare if it's not done . PrepareRecording helps in cases where you want to show the recording permissions a head so that you inform the user about the recording permissions or to avoid any flickering when using vuforia/AR frameworks at the time of recording.

Example

using VoxelBusters.ScreenRecorderKit;

IScreenRecorder recorder;
//... Create instance for IScreenRecorder via ScreenRecorderBuilder

public void PrepareRecording()
{
    recorder.PrepareRecoring(PrepareRecordingComplete);
}

private void PrepareRecordingComplete(bool status, Error error)
{
    if (success)
    {
        Debug.Log("Prepare recording successful.");
        //Call StartRecording here.
    }
    else
    {
        Debug.Log($"Prepare recording failed with error [{error}]");
    }
}

PreviousIs Paused or RecordingNextStart Recording

Last updated 5 months ago

Was this helpful?