Skip to main content

1.Get Screenshot

Get real-time screenshot of specified device, supports various image formats and quality settings.

Endpoint Description

Endpoint Type

Parameters

Response Payload

Returns binary image data:

Basic Usage

2.Crop Screen Shot

Crop a specified area from the device screenshot and return the cropped image. Important Note This method only returns BMP image format, other formats are not supported.

Endpoint Description

Endpoint Type

Parameters

Response Payload

Returns cropped image binary data (BMP format):

Basic Usage

Notes

  1. Format Limitation: This method always returns BMP format, other formats cannot be specified
  2. Coordinate Range: Coordinates and dimensions in rect parameter must not exceed screen bounds
  3. Parameter Format: rect must be an array of 4 numbers: [x1, y1, x2, y2], where (x1, y1) is the top-left coordinate and (x2, y2) is the bottom-right coordinate

3.Screen Image Push

Push specified screen area image directly to custom API service for processing, suitable for various image recognition scenarios.

Application Scenarios

This interface is particularly suitable for the following scenarios:
  • 🔤 OCR Text Recognition - Integrate third-party OCR services (such as PaddleOCR, Tesseract, etc.)
  • 🎯 Captcha Recognition - Use specialized captcha recognition services
  • 🖼️ Image Classification - Identify image content, object detection
  • 🤖 AI Recognition - Integrate any custom image AI model
💡 How It Works Streaming End → Capture Image → Direct POST → Your API → Return Result Images are sent directly from the streaming end to your API, saving decoding and redundant transmission steps, improving efficiency.

Difference from getScreenShot

Comparison

Endpoint Description

Endpoint Type

Parameters

Request Format

iClick will send POST request to your API. To save unnecessary resources, after the streaming end successfully pushes, it will not wait for the result and return it to the caller. screenPush will always return true, and you need to implement your own business callback logic. Request Headers:
Request Body:
If args parameter is provided, all fields will be passed as additional form fields:

Basic Usage

4.Device Video Stream

Pull a device’s real-time video stream directly via WebSocket. Suitable for custom players, recording, real-time analysis, and similar scenarios.

Endpoint

Connect directly to local port 23158 to pull the video stream.

Output

After a successful connection, the server continuously pushes an H.264 baseline raw stream to the client.

Basic Usage (Node.js Example)

⚠️ Important Behavior

The kernel server continuously monitors all stream-pulling connections for a device (including the iClick console):
  • When a device has no stream-pulling clients, the kernel instructs the device to stop pushing, saving bandwidth and compute resources on both ends.
  • When your business no longer needs the cast screen data, actively close the WebSocket connection to free device and host-side resources.