Stop Screen Recording

Stops recording a screen.

Command availability: IBM RPA SaaS and IBM RPA on premises


Stops screen recording previously started with the Start Screen Recording (startRecording) command.

Script Syntax

IBM RPA's proprietary script language has a syntax similar to other programming languages. The script syntax defines the command's syntax in the script file. You can work with this syntax in IBM RPA Studio's Script mode.

stopRecording (List<String>)=value

Output parameter

Designer mode label Script mode name Accepted variable types Description
Paths value List<Text> Returns a list of recorded video paths.


In the following example, you record a video of your script opening a browser window and navigating to the IBM website and closing the browser window. The video is saved to the "My Videos" folder.

defVar --name recordedVideosPath --type List --innertype String
defVar --name videoPath --type String
// Obtains the folder "My Videos" where the recording will be saved.
getSpecialFolder --folder "MyVideos" videoPath=value
// Starts recording the screen.
startRecording --folder "${videoPath}" --screen 1 --fps 60
	webStart --name chromeBrowser --type "Chrome"
	webNavigate --url ""
	// Close Browser
	webClose --name chromeBrowser
	// Ends the recording.
stopRecording recordedVideosPath=value
// Returns the path to the file with the recorded video.
logMessage --message "${recordedVideosPath}" --type "Info"


The command depends on the operating system capability to render images to record the video. If a RDP session is not active on a VM, the operating system might not render images and the command will not be able to record videos.

Disconnecting from a VM by using IBM RPA Always On keeps the IBM RPA active on a Windows™ console session, but deactivate the RPD session.