Start a screen recording. Only one recording per ID can be registered at a time.
post/recording/start
Request body
maxFileSizeInMBinteger
Maximum file size in MB (overrides server default)
framerateinteger
Recording framerate in fps (overrides server default)
maxDurationInSecondsinteger
Maximum recording duration in seconds (overrides server default)
recordAudioboolean
Capture audio alongside video. Requires the server to have an audio source and PulseAudio socket configured (the image sets both by default). When false the recording is video-only.
idstring
Optional identifier for this recording session, used to target it from the other /recording endpoints (stop, mark, download, delete) and allowing multiple concurrent recordings. Alphanumeric or hyphen. When omitted, the default recording session is started.