media.codec.bitrateParams (Read stream parameters)
media.codec.bitrateParams: Read stream parameters
media.codec.bitrateParams · Channel scope · Permission Config
What it does
Reads supported stream parameters on the device (read-only). item.gop is an int array (valid GOP 2–8 s per stream, up to 10). Do not confuse with the scalar gop on current stream (2–10 s, writable). Up to 5 streams.
Request URL
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get
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.
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 | Array | yes | ["media.codec.bitrateParams"] |
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.bitrateParams"
]
}
}
Response data fields
The value is in result.data.properties["media.codec.bitrateParams"].
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
item.streamType | Stream type. 0 main stream, 1 sub stream. | enum | yes | 0 main stream; 1 sub stream |
item.gop | GOP (I-frame interval). Up to 10 entries, integers 2–8, step 1, unit s. | array | yes | Up to 10 entries, 2–8, unit s |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"media.codec.bitrateParams": [
{
"streamType": "0",
"gop": []
}
]
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.