Enable video recording for Appium tests

Enable video recording for your Appium test executions on BrowserStack App Automate. Test your apps on a real device cloud.

Every test session executed on BrowserStack is recorded, as tests are performed on our remote device. Video recordings show all the steps as a video to retrace the steps that led to the test failure. You can download or view the video logs in full-screen mode from the dashboard.

Video recording is enabled by default. To disable the video recording use the capability as shown below.

DesiredCapabilities capabilities = new DesiredCapabilities();
HashMap<String, Object> browserstackOptions = new HashMap<String, Object>();
browserstackOptions.put("video", "false");

var capabilities = {
	'bstack:options' : {
		"video" : "false",
	},
}

AppiumOptions capabilities = new AppiumOptions();
Dictionary<string, object> browserstackOptions = new Dictionary<string, object>();
browserstackOptions.Add("video", "false");

$caps = array(
    'bstack:options' => array(
        "video" => "false",
    ),
)

desired_cap = {
	'bstack:options' : {
		"video" : "false",
	},
}

capabilities = {
    'bstack:options' => {
        "video" => "false",
    },
}

DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setCapability("browserstack.video", "false");

var capabilities = {
	'browserstack.video' : 'false'
}

AppiumOptions capabilities = new AppiumOptions();
capabilities.AddAdditionalCapability("browserstack.video", "false");

$caps = array(
"browserstack.video" => "false"
)

desired_cap = {
"browserstack.video" : "false"
}

caps = Selenium::WebDriver::Remote::Capabilities.new
caps["browserstack.video"] = "false"

Access video recording from the dashboard

Video recording can be viewed from the test sessions details page on the App Automate Dashboard.

Retrieve video recording URL

You can retrieve video recording URL for any test session using our REST API :

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/sessions/<session-id>.json"

Audio recording

Audio recording captures the audio played during your test session. By default, BrowserStack records video without audio. To capture audio, enable the audio capability. This requires video recording, because the audio track is embedded in the recorded video.

To enable audio recording, add the following capability to your browserstack.yml file:

audio: true

The audio recording is disabled by default.

Audio recording is available for Appium tests on the following platforms:

When audio recording is enabled, the downloaded video file includes the audio track. When disabled, the downloaded file contains video only. This applies to downloads from both the App Automate dashboard and the REST API.