media.codec.resolution (Set resolution)
media.codec.resolution: Set resolution
media.codec.resolution · Channel scope · Permission Config
What it does
Sets resolution on this channel (struct array, up to 100 entries). Not the 480P/720P/1080P scalar preset. Out-of-range values are rejected, not clamped.
Request URL
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.set
Minimum permission
The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config. Omitting channelId on a channel-scope capability returns DV2007. Mixing device and channel in one request returns DV2008. A write timeout does not mean the operation did not run.
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
token | String | yes | Administrator, sub-user, or sub-account accessToken |
deviceId | String | yes | Device serial number |
productId | String | no | Optional. If sent and it does not match the device model → DV2009 |
channelId | String | yes | Channel ID; "0" is common on IPCs |
properties | Object | yes | Key is media.codec.resolution |
Array limit 100. Below are array element fields (no item. prefix in JSON):
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
name | Name. | text | yes | string |
imageSize | Resolution (device-side mapping value). Range 0–999999, step 1. | int | yes | 0–999999, step 1 |
stream | Stream. 0 main stream, 1 sub stream. | enum | yes | 0 main stream; 1 sub stream |
width | Width (aspect ratio). Range 0–255, step 1. | int | yes | 0–255, step 1 |
high | Height (aspect ratio). Range 0–255, step 1. | int | yes | 0–255, step 1 |
use | Whether this resolution is in use. | int | yes | integer |
track | Close-up tracking at this resolution. 0 not supported, 1 supported. | enum | yes | 0 not supported; 1 supported |
Common request fields and the signature are in Development specification.
Request example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"system": {
"ver": "1.0",
"appId": "lcdxxxxxxxxx",
"sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
"time": 1706511734,
"nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
},
"params": {
"token": "<yourAccessToken>",
"deviceId": "TESTIPC000012345",
"channelId": "0",
"properties": {
"media.codec.resolution": [
{
"name": "example",
"imageSize": 0,
"stream": "0",
"width": 0,
"high": 0,
"use": 1,
"track": "0"
}
]
}
}
}
Response data fields
On success, code is "0" and data is {}.
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {}
}
}
Error codes
Gateway and device error codes are in Global return codes.