vid:save-recording

vid:save-recording filename

Saves the recording to the specified path. If the recorder is not running this will cause an error to be raised. Note that at present the recording will always be saved in the “mp4” format. If the supplied filename does not end in “.mp4”, the “.mp4” suffix will be added. Note that vid:save-recording will overwrite existing files of the same name. vid:save-recording will error if the recorder has not been started or if the file cannot be written since the containing directory does not exist.

Example:

vid:save-recording "foo.mp4"      ; Saves to foo.mp4 in the directory containing the model
vid:save-recording user-new-file  ; Opens a dialog for the user to select a save path
vid:save-recording "/tmp/foo.mp4" ; Saves the recording to the "/tmp" directory

Errors:

• Message "vid: recorder not started": The recorder has not been started. Start the recorder with vid:start-recorder.
• Message "vid: no such directory": The directory containing the specified save file does not exist.
• Message "vid: no frames recorded": You tried to save a recording with no frames recorded. Check that you are recording properly or use vid:reset-recording to to change the recording format without saving.