# StartScreenRecording

## Description

Starts recording the screen and saving it to a file. Currently only supported on iOS 9.0 and above and Android 5.0 and above. On iOS the filename is ignored as the device will always save the recording in the camera roll.
On Android the microphone parameter can be set to 1 to record audio from the device microphone during the recording. A value of 0 will produce a silent video as Android does not support recording audio directly from the app. However the audio output from the app may be audible through the microphone when using mode 1. Recording through the microphone requires that you enable the "RecordAudio" permission when exporting your APK.
On iOS a microphone value of 1 will record both the app audio output and the microphone, a value of 0 will only record the app audio.
On Android 6 and below the recording may stop at any time, for example if the app is sent to the background, or if another activity is activated such as an In App Purchase. On Android 7 and above the recording will pause when the app is in the background and resume when the app resumes. On iOS the recording will continue after such interruptions, until StopScreenRecording is called.

## Definition

StartScreenRecording( szFilename, microphone )

void agk::StartScreenRecording( const char *szFilename, int microphone )

## Parameters

- szFilename - The path to save the video, should end in .mp4, can be a "raw:" file path
- microphone - 1 to record from the microphone, 0 to record from the device