media.codec.format (Set video encoding format control)
media.codec.format: Set video encoding format control
media.codec.format · Channel scope · Permission Config
What it does
Sets video encoding format on this channel. Up to 100 entries with channel, streamType, and code (0 H.264, 1 H.265). 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.format |
Array limit 100.
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
item.channel | Channel. Range 0–65535, step 1. | int | yes | 0–65535, step 1 |
item.streamType | Stream type. | enum | yes | 0 main stream; 1 sub stream 1; 2 sub stream 2 |
item.code | Encoding format.0 H.264，1 H.265. | enum | yes | 0 H.264；1 H.265 |
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.format": [
{
"channel": 0,
"streamType": "0",
"code": "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.