color

(inner) getColorBits() → {number}

Returns the color depth (bits per pixel) of the connected Android device's screen.
This information is useful when performing image processing, color recognition, or configuring display-based automation.

The color depth is the maximum number of colors supported. It is generally described by "bits".
Common return values:

• 16 — 16-bit color depth
• 24 — 24-bit color depth
• 32 — 32-bit color depth (typical for modern devices)

Example

// Example: Query the screen color depth
var color = require("sigma/color");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (sigmaDevice != null) {
    var ret = sigmaDevice.getColorBits();
    if (ret != 0) {
        print("Congratulations, this API executes successfully.\nReturn value: " + ret);
    } else {
        print("Sorry! " + lastError() + "\nReturn value: " + ret);
    }
} else {
    print("Failed to get the master device object");
}

// Operation Result:
// If successful:
Congratulations, this API executes successfully.
Return value: 32

Returns:

(inner) getColorCount(locationOrX1, x1, y1, x2, y2) → {number}

Counts the number of distinct colors in a specified rectangular region of the screen or memory screenshot.
Supports analyzing the current screen or a previously captured memory image.

If location is provided as the first argument (e.g. "@0"), the function uses the memory image stored at that location.
Otherwise, the function analyzes the current screen content directly.

Supports:
getColorCount(x1, y1, x2, y2)
getColorCount(location, x1, y1, x2, y2)

Note:
When we look for images, find colors, and recognize text, we can reuse the image data stored in the memory location, and it is faster to find, find, and recognize text.
But when we use memory to find colors, first we need to make sure that the memory location @0, @1 or @2 is available;
To ensure that the memory location is available, you can first use the API "screenshotToMemory" to specify the memory location where you want to store the data. The life cycle of in-memory data is the same as the life cycle of the Total Control application on the mobile phone. That is to say, as long as we do not close the Total Control application on the mobile terminal, we only need to use the “screenshotToMemory” API for each memory location to specify the memory location.
For example, take a screenshot to memory and specify the memory location "@0" to store the data.
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
var image = require("image");
sigmaDevice.screenshotToMemory("@0");

Example

// Example 1: Count distinct colors from the current screen region (0, 0, 360, 540)
var color = require("sigma/color");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (sigmaDevice != null) {
    var ret = sigmaDevice.getColorCount(0, 0, 360, 540);
    if (ret > 0) {
        print("Congratulations, this API executes successfully.\nReturn value: " + ret);
    } else {
        print("Sorry! " + lastError() + "\nReturn value: " + ret);
    }
} else {
    print("Failed to get the master device object");
}


// Example 2: Count colors using a screenshot stored in memory location "@0"
var color = require("sigma/color");
var image = require("image");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (sigmaDevice != null) {
    var ret1 = sigmaDevice.screenshotToMemory("@0");
    if (ret1 === 0) {
        var ret = sigmaDevice.getColorCount("@0", 0, 0, 360, 540);
        if (ret > 0) {
            print("Congratulations, this API executes successfully.\nReturn value: " + ret);
        } else {
            print("Sorry! " + lastError() + "\nReturn value: " + ret);
        }
    } else {
        print("screenshotToMemory Error: " + lastError());
    }
} else {
    print("Failed to get the master device object");
}

// Operation Result:
// If it executes successfully:
Congratulations, this API executes successfully.
Return value: 6843

Parameters:

Returns:

// Example 1: Get the color of a pixel at (578, 621) from the current screen
var color = require("sigma/color");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (sigmaDevice != null) {
    var ret = sigmaDevice.getPixelColor(578, 621);
    if (ret != null) {
        print("Congratulations, this API executes successfully.\nReturn value: " + ret);
        print("Red: " + ret.red);
        print("Green: " + ret.green);
        print("Blue: " + ret.blue);
    } else {
        print("Sorry! " + lastError() + "\nReturn value: " + ret);
    }
} else {
    print("Failed to get the master device object");
}


// Example 2: Get pixel color from a memory screenshot ("@0")
var color = require("sigma/color");
var image = require("image");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (sigmaDevice != null) {
    var ret1 = sigmaDevice.screenshotToMemory("@0");
    if (ret1 === 0) {
        var ret = sigmaDevice.getPixelColor("@0", 578, 621);
        if (ret != null) {
            print("Congratulations, this API executes successfully.\nReturn value: " + ret);
            print("Red: " + ret.red);
            print("Green: " + ret.green);
            print("Blue: " + ret.blue);
        } else {
            print("Sorry! " + lastError() + "\nReturn value: " + ret);
        }
    } else {
        print("screenshotToMemory Error: " + lastError());
    }
} else {
    print("Failed to get the master device object");
}

// Operation Result:
Congratulations, this API executes successfully.
Return value: [r=74, g=57, b=74]
Red: 74
Green: 57
Blue: 74

// Example 1: Get color string from pixel (360, 540) on the current screen
var color = require("sigma/color");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (sigmaDevice != null) {
    var ret = sigmaDevice.getPixelColorStr(360, 540);
    if (ret != null) {
        print("Congratulations, this API executes successfully.\nReturn value: " + ret);
    } else {
        print("Sorry! " + lastError() + "\nReturn value: " + ret);
    }
} else {
    print("Failed to get the master device object");
}


// Example 2: Get color string from memory screenshot "@0"
var color = require("sigma/color");
var image = require("image");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (sigmaDevice != null) {
    var ret1 = sigmaDevice.screenshotToMemory("@0");
    if (ret1 === 0) {
        var ret = sigmaDevice.getPixelColorStr("@0", 360, 540);
        if (ret != null) {
            print("Congratulations, this API executes successfully.\nReturn value: " + ret);
        } else {
            print("Sorry! " + lastError() + "\nReturn value: " + ret);
        }
    } else {
        print("screenshotToMemory Error: " + lastError());
    }
} else {
    print("Failed to get the master device object");
}

// Operation Result:
// If it executes successfully:
Congratulations, this API executes successfully.
Return value: 0x4a394a

// Example 1: Single-point color search in full screen
var color = require("sigma/color");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
var coor = sigmaDevice.seekColor({
    primaryColor: "0x000000-0xffffff",
    sim: 1,
    dir: 4,
    seekAll: true
});
if (coor) {
    coor.forEach(c => print("(" + c.x + "," + c.y + ")"));
}


// Example 2: Single-point color search in region
var color = require("sigma/color");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
var coor = sigmaDevice.seekColor(0, 0, 719, 1110, {
    primaryColor: ["0x0000ff", "0x00ff00", "0x0000dd-0x0000ff"],
    sim: 1,
    dir: 4
});
if (coor) {
    print("Found: (" + coor.x + "," + coor.y + ")");
}


// Example 3: Multi-point color search in full screen
var color = require("sigma/color");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
var coor = sigmaDevice.seekColor({
    primaryColor: "0x000000-0xffffff",
    secondaryColor: "-10|5|0x05beef,5|-10|0xaaaaaa-0xbbbbbb",
    sim: 1,
    dir: 4
});
if (coor) {
    print("Coord: (" + coor.x + "," + coor.y + "), Rect: " + JSON.stringify(coor.rect));
}


// Example 4: Search in a memory image region with array-form secondary colors
var color = require("sigma/color");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
var image = require("image");
var ret1 = sigmaDevice.screenshotToMemory("@0");
if (ret1 === 0) {
    var coor = sigmaDevice.seekColor(0, 0, 719, 1110, {
        primaryColor: "000000-ffffff",
        secondaryColor: ["-10|5|0x05beef", "5|-10|0xaaaaaa-0xbbbbbb"],
        sim: 1,
        dir: 4,
        location: "@0"
    });
    if (coor) {
        print("Coord: (" + coor.x + "," + coor.y + "), Rect: " + JSON.stringify(coor.rect));
    }
}

// Operation Result:
Single-point: { x: 719, y: 50 }
Multi-point: { x: 719, y: 50, rect: [685, 26, 733, 74] }

// Example 1: Wait up to 20 seconds for a specific color to appear in a 500x500 region
var color = require("sigma/color");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (sigmaDevice != null) {
    var ret = sigmaDevice.waitForColor(
        0, 0, 500, 500,
        "0xffffff|0xaabbcc-0x000000|0x00ff00-0x101010",
        1, 1.0, 20000
    );
    if (ret != null) {
        print("Congratulations, this API executes successfully.\nReturn value: (" + ret.x + "," + ret.y + ")");
    } else {
        print("Sorry! " + lastError() + "\nReturn value: " + ret);
    }
} else {
    print("Failed to get the master device object");
}

// Operation Result:
// If successful:
Congratulations, this API executes successfully.
Return value: (85,39)

// Example 2: Wait up to 20 seconds for a specific color to appear in a 500x500 region in a memory image region
var color = require("sigma/color");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
var image = require("image");
var screenshot = sigmaDevice.screenshotToMemory("@0");
if (screenshot === 0) {
     var ret = sigmaDevice.waitForColor(
        "@0",
        0, 0, 500, 500,
        "0xffffff|0xaabbcc-0x000000|0x00ff00-0x101010",
        1, 1.0, 20000
    );
    if (ret != null) {
        print("Congratulations, this API executes successfully.\nReturn value: (" + ret.x + "," + ret.y + ")");
    } else {
        print("Sorry! " + lastError() + "\nReturn value: " + ret);
    }
}