Get a step-by-step walkthrough in the video below!

This article provides complete details on “How to Migrate from Appium 2.x to Appium 3”

As a part of this video:

1.Key Architectural Changes in Appium 3

2.Important Breaking Changes

3.How to Migrate/Upgrade from Appium 2.x.x à Appium 3.x

4.Compare Appium2 Vs Appium3

Article inprogess………………….!

Architecture diagram (Appium 2 vs Appium 3):

GitHub Link:

GitHub - AppiumGuide/AppiumGuide

🎬 Explore More! Watch My Latest Videos on YouTube!

AppiumGuide

Visit My Official Blog:

Home-Index Page

Get a step-by-step walkthrough in the video below!

This article provides complete details on “How to Migrate from Appium 2.x to Appium 3”

Article inprogess………………….!

GitHub Link:

GitHub - AppiumGuide/AppiumGuide

🎬 Explore More! Watch My Latest Videos on YouTube!

AppiumGuide

Visit My Official Blog:

Home-Index Page

Get a step-by-step walkthrough in the video below!

GitHub Link:

GitHub - AppiumGuide/AppiumGuide

🎬 Explore More! Watch My Latest Videos on YouTube!

AppiumGuide

Visit My Official Blog:

Home-Index Page

Get a step-by-step walkthrough in the video below!

GitHub Link:

GitHub - AppiumGuide/AppiumGuide

🎬 Explore More! Watch My Latest Videos on YouTube!

AppiumGuide

Visit My Official Blog:

Home-Index Page

Get a step-by-step walkthrough in the video below!

Appium is a powerful open-source automation framework used for testing mobile applications across iOS, Android, and Windows platforms. Built on a client-server architecture, Appium allows testers to write test scripts in their preferred language and execute them on multiple devices using a single, unified API.

This article explores the core architecture of Appium and how it powers cross-platform mobile automation.

📑 Table of Contents

1. Why Use Appium Framework?
2. Key Use Cases of Appium
3. Appium on Android
4. Appium on iOS
5. How Does Appium Work?
6. Advantages of Appium
7. Limitations of Appium
8. Conclusion

Why Use Appium Framework?

Mobile testing tools are essential to ensure mobile apps are reliable, user-friendly, and bug-free. While several tools exist (e.g., Kobiton, Robotium, TestComplete), Appium stands out due to its flexibility and cross-platform capabilities:

• Multi-language Support: Write tests in Java, Python, Ruby, C#, or JavaScript.
• Cross-platform Testing: Same API for Android, iOS, and Windows.
• No App Code Modification: Test native and hybrid apps without altering code.
• Open Source & Free: No licensing fees, with a vibrant community.
• Flexible Integrations: Compatible with CI/CD tools and popular frameworks.

Key Use Cases of Appium

Appium relies on a client-server model to execute tests. Here’s how it functions:

• The Client sends automation commands.
• The Appium Server receives these commands, translates them into device-level actions, and executes them.
• Communication between the client and server follows the WebDriver or JSON Wire Protocol, ensuring smooth execution and feedback loops.

Example: A command to click a button is wrapped in a JSON request by the client, sent to the Appium server, executed on the device, and the result is sent back to the client.

Appium on Android

Appium uses UIAutomator2 to automate Android apps. Here’s a step-by-step flow:

1. The tester writes automation scripts in a supported language.
2. These are converted into JSON format and sent via HTTP to the Appium server.
3. The server communicates with the Android device using the WebDriver protocol.
4. On the device, Bootstrap.jar processes commands and executes them using UI Automator.
5. Execution results are sent back to the server and then to the client.

Key Features:

• Supports gestures, system-level interactions, and multi-version Android testing.
• Executes real-time validations and UI automation reliably.

Appium on iOS

Appium interacts with iOS devices using XCUITest via the WebDriverAgent.app. The process is similar to Android, with some platform-specific nuances:

1. Test commands are sent from the client to the server in JSON format.
2. Appium communicates with the iOS device using WebDriver.
3. WebDriverAgent.app receives and executes commands using XCUITest.
4. The results are returned to the server, which forwards them to the client.

Key Features:

• Automates both simulators and real devices.
• Uses Apple’s official automation framework for maximum reliability.

How Does Appium Work?

Appium’s architecture revolves around WebDriver Protocol, Client-Server Communication, and Session Management. Here’s a breakdown:

WebDriver Protocol

• Standard for automating user interactions (click, type, swipe).
• Appium exposes APIs that conform to WebDriver specs.

Client-Server Communication

• The Client sends commands over HTTP using RESTful APIs.
• The Appium Server interprets and executes them on the device/emulator.

Appium Session

• Each test initiates a session with defined desired capabilities.
• Actions are executed using platform-specific drivers (UIAutomator2/XCUITest).

JSON Wire Protocol

• Defines the message format between the client and server.
• Commands (e.g., find element, click) and responses are exchanged in JSON.

Advantages of Appium

• Cross-Platform: Write once, run anywhere.
• Open Source: No licensing constraints.
• Flexible Language Support: Java, Python, JS, Ruby, and more.
• Native & Hybrid App Testing: No code changes required.
• Real Device, Emulator & Simulator Support.

Limitations of Appium

• Third-Party Dependencies: Relies on tools like UIAutomator/XCUITest.
• Slower Execution: Compared to native frameworks.
• Complex Setup: Configuration and environment setup can be tricky.
• Brittle Test Scripts: Frequent maintenance may be required.
• Limited Web App Support: Primarily built for mobile testing.

Conclusion

Appium provides a robust and scalable architecture for mobile test automation, allowing seamless testing across platforms using familiar programming languages and standard WebDriver protocols. While it comes with challenges like slower execution and complex setup, its flexibility, cross-platform support, and community-driven enhancements make it a top choice for modern mobile QA teams.

Whether you’re testing a native app or a hybrid solution, Appium’s architecture offers the tools and capabilities needed to ensure your app delivers a seamless user experience.

GitHub Link:

GitHub - AppiumGuide/AppiumGuide

🎬 Explore More! Watch My Latest Videos on YouTube!

AppiumGuide

Visit My Official Blog:

Home-Index Page

Get a step-by-step walkthrough in the video below!

Following Steps will be covered in the Article:
 — — — — — — — — — — — — — — — — — — — — -

To connect Real Device(Physical Device):
 — — — — — — — — — — — — — — — — — — — — —

Step-1: Connect the Real Device with vysor(optional Step).

Step-2: Will Go through the required setting in Developer Options.

Step-3: Mirror the Real Device with Android Studio

Launch Appium Server:
 — — — — — — — — — — — — -

Step-4: Launch Appium Server with Device-Farm

Step-5: Try to connect the Real Device.

Step-6: check the error messages(if any)

Steps to Resolve issue: (Very Important)
 — — — — — — — — — — — — — — — — — — — —

Step-7: Install device-farm.apk

Step-8: Install stream.apk

Step-9: Try to reconnect with Real Device

Step-10: Execute Our First Script on the Real Device:

package com.appiumguide.devicefarm;

import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.RemoteWebElement;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import com.google.common.collect.ImmutableMap;
import io.appium.java_client.AppiumBy;
import io.appium.java_client.android.AndroidDriver;
import io.appium.java_client.android.options.UiAutomator2Options;
import java.net.*;
import java.time.Duration;

/**
 * Script Details - "appium-device-farm”- Step-by-Step Guide to Connect a ‘Real Device’ with “Appium Device Farm”
 * 
 * appium-java-client version: 9.5.0
 * 
 * @author 'Ramesh Kodumuru' for AppiumGuide [appiumguide@gmail.com]
 */

public class devicefarm_FirstScriptOnRealDeviceDemo {
 
 private AndroidDriver driver;
 
 WebElement dragelement,dropelement;
  
 @BeforeClass
 public void setup() throws MalformedURLException {
  UiAutomator2Options cap=new UiAutomator2Options();
  cap.setPlatformName("android");
  cap.setAutomationName("uiautomator2");
  cap.setUdid("E6S8MJPFYHEUZDU8"); //UDID of Real Device
  
       
  driver = new AndroidDriver(new URL("http://127.0.0.1:4723/wd/hub"), cap);
  driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(10));  
 }
 
 @Test
 public void test1() throws InterruptedException {
  
  driver.activateApp("com.wdiodemoapp");
  
  Thread.sleep(5000);
  
  driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().text(\"Drag\")")).click();
  
  
  
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(4)"));
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(10)"));
  
  int eX=(int)(dropelement.getRect().getX());
  int eY=(int)(dropelement.getRect().getY());
  
  //Perform Drag gesture based on element id, endX & endY co-ordinates
  System.out.println("Perform Drag gesture based on element id, endX & endY co-ordinates");
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of("elementId",((RemoteWebElement) dragelement).getId(),
    "endX",eX,
    "endY",eY));
  
  Thread.sleep(3000);
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(7)"));
  
  int sX=(int)(dragelement.getRect().getX());
  int sY=(int)(dragelement.getRect().getY());
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(8)"));
  
  int eX1=(int)(dropelement.getRect().getX());
  int eY1=(int)(dropelement.getRect().getY());
  
  //Perform Drag gesture based on element id, startX,startY,endX & endY co-ordinates 
  System.out.println("Perform Drag gesture based on element id, startX,startY,endX & endY co-ordinates");
  
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of(
    "startX",sX,
    "startY",sY,
    "endX",eX1,
    "endY",eY1));
  
  Thread.sleep(3000);
  
  ////Perform Drag gesture based on element id,endX,endY co-ordinates and Speed
  
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(1)"));
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(10)"));
  
  int eX2=(int)(dropelement.getRect().getX());
  int eY2=(int)(dropelement.getRect().getY());
  
  int speedvalue=(int)(100*2.625);
  System.out.println("Perform Drag gesture based on element id,endX,endY co-ordinates and Speed");
  
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of("elementId",((RemoteWebElement) dragelement).getId(),
    "endX",eX2,
    "endY",eY2,
    "speed",speedvalue));
  
  Thread.sleep(3000);
  
 }  
  
 @AfterClass
 public void teardown() {
  
  if(driver!=null) {
   driver.quit();
   System.out.println("Test Execution Completed");

  }
  
 }

}

Observe that user able to connect Real Device with Device-Farm

GitHub Link:

GitHub - AppiumGuide/AppiumGuide

🎬 Explore More! Watch My Latest Videos on YouTube!

AppiumGuide

Visit My Official Blog:

Home-Index Page

Get a step-by-step walkthrough in the video below!

Allocating a ‘Build Name’ in the Appium Device Farm dashboard is crucial for organizing, tracking, and debugging multiple test sessions effectively. Each build name acts as a label that groups related test executions, enabling better visibility and reporting.

In this guide, you’ll learn:

• What a “Build Name” is
• How to configure it via DesiredCapabilities or config file
• How it reflects in the Device Farm dashboard

What is a “Build Name”?

The df:build is a tag that helps you group test sessions belonging to the same CI job, feature, release, or sprint. It's especially useful in dashboards where many sessions run across different teams or purposes.

Example use cases:

• login-feature-regression
• v1.2.3-smoke-test
• release-candidate-qa

How to Allocate a Build Name

Method 1: Via Desired Capabilities (Recommended)

Add the capability df:build to your test script. Here's how you can configure it in Java:

UiAutomator2Options cap=new UiAutomator2Options();
  cap.setPlatformName("android");
  cap.setAutomationName("uiautomator2");
  cap.setDeviceName("Pixel9");
  
  //To allocate build name
  
  cap.setCapability("df:build","RegressionTest_V2.10");  
  
     
  driver = new AndroidDriver(new URL("http://127.0.0.1:4723/wd/hub"), cap);
  driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(10)); 

// Allocate a custom build name
 cap.setCapability("df:build","RegressionTest_V2.10");

This will tag your session with “RegressionTest_V2.10" under the Builds section in the Device Farm dashboard.

Method 2: In Configuration File (appium-config.json)

If you are running tests via the Appium CLI with Device Farm plugin:

{
  "server": {
    "port": 4723,
    "plugin": {
      "device-farm": {
        "df:build": "RegressionTest_V2.10"
      }
    }
  }
}

Complete Example with Script & Device-farm Screenshot:

“Complete Code: Optimized and Ready to Use”:

package com.appiumguide.devicefarm;

import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.RemoteWebElement;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import com.google.common.collect.ImmutableMap;
import io.appium.java_client.AppiumBy;
import io.appium.java_client.android.AndroidDriver;
import io.appium.java_client.android.options.UiAutomator2Options;
import java.net.*;
import java.time.Duration;

/**
 * Script Details - "appium-device-farm”- Complete Details on How to Allocate a ‘build name’ in “Appium Device Farm” dashboard
 * 
 * appium-java-client version: 9.5.0
 * 
 * @author 'Ramesh Kodumuru' for AppiumGuide [appiumguide@gmail.com]
 */

public class devicefarm_BuildNameDemo {
 
 private AndroidDriver driver;
 
 WebElement dragelement,dropelement;
  
 @BeforeClass
 public void setup() throws MalformedURLException {
  UiAutomator2Options cap=new UiAutomator2Options();
  cap.setPlatformName("android");
  cap.setAutomationName("uiautomator2");
  cap.setDeviceName("Pixel9");
  
  //To allocate build name
  
  cap.setCapability("df:build","RegressionTest_V2.10");  
  
     
  driver = new AndroidDriver(new URL("http://127.0.0.1:4723/wd/hub"), cap);
  driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(10));  
 }
 
 @Test
 public void test1() throws InterruptedException {
  
  driver.activateApp("com.wdiodemoapp");
  
  Thread.sleep(5000);
  
  driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().text(\"Drag\")")).click();
  
  
  
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(4)"));
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(10)"));
  
  int eX=(int)(dropelement.getRect().getX());
  int eY=(int)(dropelement.getRect().getY());
  
  //Perform Drag gesture based on element id, endX & endY co-ordinates
  System.out.println("Perform Drag gesture based on element id, endX & endY co-ordinates");
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of("elementId",((RemoteWebElement) dragelement).getId(),
    "endX",eX,
    "endY",eY));
  
  Thread.sleep(3000);
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(7)"));
  
  int sX=(int)(dragelement.getRect().getX());
  int sY=(int)(dragelement.getRect().getY());
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(8)"));
  
  int eX1=(int)(dropelement.getRect().getX());
  int eY1=(int)(dropelement.getRect().getY());
  
  //Perform Drag gesture based on element id, startX,startY,endX & endY co-ordinates 
  System.out.println("Perform Drag gesture based on element id, startX,startY,endX & endY co-ordinates");
  
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of(
    "startX",sX,
    "startY",sY,
    "endX",eX1,
    "endY",eY1));
  
  Thread.sleep(3000);
  
  ////Perform Drag gesture based on element id,endX,endY co-ordinates and Speed
  
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(1)"));
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(10)"));
  
  int eX2=(int)(dropelement.getRect().getX());
  int eY2=(int)(dropelement.getRect().getY());
  
  int speedvalue=(int)(100*2.625);
  System.out.println("Perform Drag gesture based on element id,endX,endY co-ordinates and Speed");
  
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of("elementId",((RemoteWebElement) dragelement).getId(),
    "endX",eX2,
    "endY",eY2,
    "speed",speedvalue));
  
  Thread.sleep(3000);
  
 }  
  
 @AfterClass
 public void teardown() {
  
  if(driver!=null) {
   driver.quit();
   System.out.println("Test Execution Completed");

  }
  
 }

}

This will tag your session with “RegressionTest_V2.10” under the Builds section in the Device Farm dashboard.

Observe that in the Device-Farm Dashboard → Under Builds Tab,we able to find Build Name “RegressionTest_V2.10”

GitHub Link:

GitHub - AppiumGuide/AppiumGuide

🎬 Explore More! Watch My Latest Videos on YouTube!

AppiumGuide

Visit My Official Blog:

Home-Index Page

Get a step-by-step walkthrough in the video below!

Appium Device Farm offers a powerful feature set to enhance debugging and monitoring of your test runs. One such feature is Video Recording — it allows you to record the screen of the device throughout the session, which is extremely useful for playback and debugging.

This article provides complete details on how to enable or disable the video recording feature in Appium Device Farm sessions.

What is Video Recording in Appium Device Farm?

The video recording feature captures a full video of the test session on the connected device. This can be helpful for:

• Test debugging
• Visual validation
• Reviewing failed test cases

By default, video recording may be disabled, but Appium Device Farm gives you full control over this through session configuration.

How to Enable/Disable Video Recording

You can control this feature via capabilities or configuration settings.

Enable/Disable Live Streaming Per Session (via Desired Capabilities)

Appium Device Farm accepts a custom capability:

// To enable & disable video recording under appium-device-farm
  
  //cap.setCapability("df:recordVideo", false);  //To disable video recording   ///Default is disabled i.e false
  
  cap.setCapability("df:recordVideo", true);   //To enable video recording
  
  // To set video recording time limit
  
  cap.setCapability("df:videoTimeLimit", "2400");  //To specify the video time limit to 4 minutes   //Default Video Time Limit is 1800 seconds (3 Mins)

Default Value for Video Recording: Is Always False

//Default is disabled i.e false

To enable for a specific session:

// To enable & disable video recording under appium-device-farm
  
  cap.setCapability("df:recordVideo", true);   //To enable video recording

Example:

To disable for a specific session:

//To Disable Video Recording in Device Farm
  
cap.setCapability("df:recordVideo", false);

Example:

Observe that “Video recording not available” message will be displayed under the Builds Tab.

Java Example:

 @BeforeClass
 public void setup() throws MalformedURLException {
  UiAutomator2Options cap=new UiAutomator2Options();
  cap.setPlatformName("android");
  cap.setAutomationName("uiautomator2");
  cap.setDeviceName("Pixel9");
  
  // To enable & disable video recording under appium-device-farm
  
  //cap.setCapability("df:recordVideo", false);  //To disable video recording   ///Default is disabled i.e false
  
  cap.setCapability("df:recordVideo", true);   //To enable video recording
  
  // To set video recording time limit
  
  cap.setCapability("df:videoTimeLimit", "2400");  //To specify the video time limit to 4 minutes   //Default Video Time Limit is 1800 seconds (3 Mins)
  
     
  driver = new AndroidDriver(new URL("http://127.0.0.1:4723/wd/hub"), cap);
  driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(10));  
 }

JSON (Static Config)

For server config (appium.config.json or programmatic):

{
  "server": {
    "port": 4723,
    "plugin": {
      "device-farm": {
        "df:recordVideo": true // or false
        "df:videoTimeLimit": 2400 //Default Video Time Limit is 1800 seconds (3 Mins)
      }
    }
  }
}

Where to View the Record Videos?

When enabled, the Video Record is accessible through the Device Farm Dashboard UI in the session window.

Device-Farm Dashboard →Builds

Example:

Click Maximize: To view Recorded Video in full scream

It provides options , when user clicks on the 3 dots.

Troubleshooting Tips

1. Stream not showing up?

• Check FFmpeg path and installation.
• Ensure the device screen is active (not locked).

2. Stream is blank or lagging?

• Device resolution or encoding issues — try reducing resolution.
• Use wired connections for physical devices (not Wi-Fi only

3. Can’t find video stream URL?

• Make sure the Appium session is initialized and streaming is enabled at either global or session level.

“Complete Code: Optimized and Ready to Use”:

package com.appiumguide.devicefarm;

import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.RemoteWebElement;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import com.google.common.collect.ImmutableMap;
import io.appium.java_client.AppiumBy;
import io.appium.java_client.android.AndroidDriver;
import io.appium.java_client.android.options.UiAutomator2Options;
import java.net.*;
import java.time.Duration;

/**
 * Script Details - "appium-device-farm”- Complete Details on Enable/Disable “live video Streaming” for the Session Under “Appium Device Farm”
 * 
 * appium-java-client version: 9.5.0
 * 
 * @author 'Ramesh Kodumuru' for AppiumGuide [appiumguide@gmail.com]
 */

public class devicefarm_VideoRecordingDemo {
 
 private AndroidDriver driver;
 
 WebElement dragelement,dropelement;
  
 @BeforeClass
 public void setup() throws MalformedURLException {
  UiAutomator2Options cap=new UiAutomator2Options();
  cap.setPlatformName("android");
  cap.setAutomationName("uiautomator2");
  cap.setDeviceName("Pixel9");
  
  // To enable & disable video recording under appium-device-farm
  
  //cap.setCapability("df:recordVideo", false);  //To disable video recording   ///Default is disabled i.e false
  
  cap.setCapability("df:recordVideo", true);   //To enable video recording
  
  // To set video recording time limit
  
  cap.setCapability("df:videoTimeLimit", "2400");  //To specify the video time limit to 4 minutes   //Default Video Time Limit is 1800 seconds (3 Mins)
  
     
  driver = new AndroidDriver(new URL("http://127.0.0.1:4723/wd/hub"), cap);
  driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(10));  
 }
 
 @Test
 public void test1() throws InterruptedException {
  
  driver.activateApp("com.wdiodemoapp");
  
  Thread.sleep(5000);
  
  driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().text(\"Drag\")")).click();
  
  
  
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(4)"));
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(10)"));
  
  int eX=(int)(dropelement.getRect().getX());
  int eY=(int)(dropelement.getRect().getY());
  
  //Perform Drag gesture based on element id, endX & endY co-ordinates
  System.out.println("Perform Drag gesture based on element id, endX & endY co-ordinates");
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of("elementId",((RemoteWebElement) dragelement).getId(),
    "endX",eX,
    "endY",eY));
  
  Thread.sleep(3000);
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(7)"));
  
  int sX=(int)(dragelement.getRect().getX());
  int sY=(int)(dragelement.getRect().getY());
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(8)"));
  
  int eX1=(int)(dropelement.getRect().getX());
  int eY1=(int)(dropelement.getRect().getY());
  
  //Perform Drag gesture based on element id, startX,startY,endX & endY co-ordinates 
  System.out.println("Perform Drag gesture based on element id, startX,startY,endX & endY co-ordinates");
  
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of(
    "startX",sX,
    "startY",sY,
    "endX",eX1,
    "endY",eY1));
  
  Thread.sleep(3000);
  
  ////Perform Drag gesture based on element id,endX,endY co-ordinates and Speed
  
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(1)"));
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(10)"));
  
  int eX2=(int)(dropelement.getRect().getX());
  int eY2=(int)(dropelement.getRect().getY());
  
  int speedvalue=(int)(100*2.625);
  System.out.println("Perform Drag gesture based on element id,endX,endY co-ordinates and Speed");
  
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of("elementId",((RemoteWebElement) dragelement).getId(),
    "endX",eX2,
    "endY",eY2,
    "speed",speedvalue));
  
  Thread.sleep(3000);
  
 }  
  
 @AfterClass
 public void teardown() {
  
  if(driver!=null) {
   driver.quit();
   System.out.println("Test Execution Completed");

  }
  
 }

}

GitHub Link:

GitHub - AppiumGuide/AppiumGuide

🎬 Explore More! Watch My Latest Videos on YouTube!

AppiumGuide

Visit My Official Blog:

Home-Index Page

Get a step-by-step walkthrough in the video below!

Appium Device Farm is a powerful plugin that enables parallel execution across real devices locally or remotely. One of its key features is Live Video Streaming, which allows you to watch the test session in real time — a valuable tool for debugging and monitoring.

In this article, we’ll cover how to enable or disable Live Video Streaming for a test session, both globally (via config) and per-session (via capabilities).

What is Live Video Streaming in Appium Device Farm?

Live video streaming displays the real-time screen output of the device during test execution. It helps:

• Monitor test execution visually
• Debug test failures interactively
• Showcase test runs in demos or reviews

Prerequisites

Before using the live streaming feature:

• You must have installed the Appium Device Farm plugin
• FFmpeg should be installed and available in your system PATH
• Devices should be connected and discoverable by Appium

Youtube Video Link To Install “FFmpeg”:

Start Appium Server with Device-Farm plugin:

Command:

appium server -ka 800 --use-plugins=device-farm -pa /wd/hub --plugin-device-farm-platform=android

Example:

Enable/Disable Live Streaming Per Session (via Desired Capabilities)

You can also control streaming at a session level using the following capability:

Default Value for Live Streaming: Is Always True

//Default value for live video Streaming is true  

To enable for a specific session:

  //To Enable Live video streaming in Device Farm
  
   cap.setCapability("df:liveVideo", true);  //Live Video Streaming is enabled    //Default value for live video Streaming is true

Example:

Click Maximize: To view Live Streaming in full scream

To disable for a specific session:

 
//To Disable live video streaming in Device Farm
  
cap.setCapability("df:liveVideo", false);  
  
  

Java Example:

@BeforeClass
 public void setup() throws MalformedURLException {
  UiAutomator2Options cap=new UiAutomator2Options();
  cap.setPlatformName("android");
  cap.setAutomationName("uiautomator2");
  cap.setDeviceName("Pixel9");
  
  //To Enable & Disable the live video streaming in Device Farm
  
  cap.setCapability("df:liveVideo", false);  //Live Video Streaming is disabled
  
  //cap.setCapability("df:liveVideo", true);  //Live Video Streaming is enabled    //Default value for live video Streaming is true
  
     
  driver = new AndroidDriver(new URL("http://127.0.0.1:4723/wd/hub"), cap);
  driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(10));  
 }

Enable Live Streaming Globally (via Plugin Config):

You can enable/disable live streaming globally in your Appium server config file.

JSON Config Example (appium-config.json)

{
  "server": {
    "port": 4723,
    "plugin": {
      "df:liveVideo": "true"
     }
  }
}

Where to View the Stream?

When enabled, the live video stream is accessible through the Device Farm Dashboard UI in the session window. You can monitor the test visually in real time.

Device-Farm Dashboard →Builds

Example:

Click Maximize: To view Live Streaming in full scream

Troubleshooting Tips

1. Stream not showing up?

• Check FFmpeg path and installation.
• Ensure the device screen is active (not locked).

2. Stream is blank or lagging?

• Device resolution or encoding issues — try reducing resolution.
• Use wired connections for physical devices (not Wi-Fi only

3. Can’t find video stream URL?

• Make sure the Appium session is initialized and streaming is enabled at either global or session level.

“Complete Code: Optimized and Ready to Use”:

package com.appiumguide.devicefarm;

import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.RemoteWebElement;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import com.google.common.collect.ImmutableMap;
import io.appium.java_client.AppiumBy;
import io.appium.java_client.android.AndroidDriver;
import io.appium.java_client.android.options.UiAutomator2Options;
import java.net.*;
import java.time.Duration;

/**
 * Script Details - "appium-device-farm”- Complete Details on Enable/Disable “live video Streaming” for the Session Under “Appium Device Farm”
 * 
 * appium-java-client version: 9.5.0
 * 
 * @author 'Ramesh Kodumuru' for AppiumGuide [appiumguide@gmail.com]
 */

public class devicefarm_LiveVideoDemo {
 
 private AndroidDriver driver;
 
 WebElement dragelement,dropelement;
  
 @BeforeClass
 public void setup() throws MalformedURLException {
  UiAutomator2Options cap=new UiAutomator2Options();
  cap.setPlatformName("android");
  cap.setAutomationName("uiautomator2");
  cap.setDeviceName("Pixel9");
  
  //To Enable & Disable the live video streaming in Device Farm
  
  //cap.setCapability("df:liveVideo", false);  //Live Video Streaming is disabled
  
  cap.setCapability("df:liveVideo", true);  //Live Video Streaming is enabled    //Default value for live video Streaming is true
  
     
  driver = new AndroidDriver(new URL("http://127.0.0.1:4723/wd/hub"), cap);
  driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(10));  
 }
 
 @Test
 public void test1() throws InterruptedException {
  
  driver.activateApp("com.wdiodemoapp");
  
  driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().text(\"Drag\")")).click();
  
  
  
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(4)"));
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(10)"));
  
  int eX=(int)(dropelement.getRect().getX());
  int eY=(int)(dropelement.getRect().getY());
  
  //Perform Drag gesture based on element id, endX & endY co-ordinates
  System.out.println("Perform Drag gesture based on element id, endX & endY co-ordinates");
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of("elementId",((RemoteWebElement) dragelement).getId(),
    "endX",eX,
    "endY",eY));
  
  Thread.sleep(3000);
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(7)"));
  
  int sX=(int)(dragelement.getRect().getX());
  int sY=(int)(dragelement.getRect().getY());
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(8)"));
  
  int eX1=(int)(dropelement.getRect().getX());
  int eY1=(int)(dropelement.getRect().getY());
  
  //Perform Drag gesture based on element id, startX,startY,endX & endY co-ordinates 
  System.out.println("Perform Drag gesture based on element id, startX,startY,endX & endY co-ordinates");
  
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of(
    "startX",sX,
    "startY",sY,
    "endX",eX1,
    "endY",eY1));
  
  Thread.sleep(3000);
  
  ////Perform Drag gesture based on element id,endX,endY co-ordinates and Speed
  
  dragelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.widget.ImageView\").instance(1)"));
  
  dropelement=driver.findElement(AppiumBy.androidUIAutomator("new UiSelector().className(\"android.view.ViewGroup\").instance(10)"));
  
  int eX2=(int)(dropelement.getRect().getX());
  int eY2=(int)(dropelement.getRect().getY());
  
  int speedvalue=(int)(100*2.625);
  System.out.println("Perform Drag gesture based on element id,endX,endY co-ordinates and Speed");
  
  ((JavascriptExecutor) driver).executeScript("mobile: dragGesture",ImmutableMap.of("elementId",((RemoteWebElement) dragelement).getId(),
    "endX",eX2,
    "endY",eY2,
    "speed",speedvalue));
  
 }  
  
 @AfterClass
 public void teardown() {
  
  if(driver!=null) {
   driver.quit();
   System.out.println("Test Execution Completed");

  }
  
 }

}

GitHub Link:

GitHub - AppiumGuide/AppiumGuide

🎬 Explore More! Watch My Latest Videos on YouTube!

AppiumGuide

Visit My Official Blog:

Home-Index Page

Get a step-by-step walkthrough in the video below!

FFmpeg is a powerful command-line tool used to record, convert, and stream audio and video. Whether you’re building automation workflows, creating screen recordings, compressing video, or converting media formats — FFmpeg is the go-to utility.

In this article, we’ll walk you through how to download and install FFmpeg on all major operating systems.

What is FFmpeg?

FFmpeg is a free, open-source multimedia framework that can:

• Convert between different video/audio formats (e.g., MP4 to MP3)
• Record screen or webcam
• Extract frames from video
• Compress media files
• Merge, split, or trim video/audio files

Installing FFmpeg on Windows

Step 1: Download FFmpeg ZIP

1. Go to the official FFmpeg download page:
   👉 https://ffmpeg.org/
2. Click on the “Download” button

3. Click on Windows ➜ Choose “Windows builds from gyan.dev”

4. Download the latest release build ZIP (e.g., ffmpeg-git-full.zip)

Step 2: Extract the ZIP File

• Right-click the ZIP ➜ Extract All
• Navigate to the extracted folder

Step 3: Add FFmpeg to System PATH

1. Copy the extracted folder & paste in C:\
2. Rename the folder to ‘ffmpeg’

3. Open the cmd prompt as ‘Run As Administor’

4. Copy the bin folder path (e.g., C:\ffmpeg\bin) & Type the below command and click enter

Step 4: Verify Installation

Open Command Prompt and run:

ffmpeg -version

You should see FFmpeg version details.

Example:

Step 5: Verify the installation with ‘appium-doctor’

Appium-Doctor logs — Before FFMPEG installation:

Appium-Doctor logs — After FFMPEG installation:

GitHub Link:

GitHub - AppiumGuide/AppiumGuide

🎬 Explore More! Watch My Latest Videos on YouTube!

AppiumGuide

Visit My Official Blog:

Home-Index Page