Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
        • Bitstream
        • Display
        • OSD
        • Video source
          • media.source.names (Read device channel names)
          • media.source.names (Set device channel names)
          • media.source.order (Read video channel order)
        • Watermark
      • Network
      • Power
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Request URL
Minimum permission
Request parameters
Request example
Response data fields
Response example
Error codes

media.source.order (Read video channel order)

media.source.order: Read video channel order

media.source.order · Device scope · Permission Config

What it does

Reads video channel order on the device. Up to 100 entries.

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.

Request parameters

NameTypeRequiredDescription
tokenStringyesAdministrator, sub-user, or sub-account accessToken
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
propertiesArrayyes["media.source.order"]

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",
 "properties": [
 "media.source.order"
 ]
 }
}

Response data fields

The value is in result.data.properties["media.source.order"].

NameDescriptionTypeRequiredValues
item.chanChannel ID. Range 0–255, step 1.intyes0–255, step 1
item.mainMain channel. 0 no, 1 yes.enumyes0 no; 1 yes
item.typeChannel type.enumyes1 mobile lens; 2 fixed lens; 3 telephoto lens; 4 wide-angle lens

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "media.source.order": [
 {
 "chan": 0,
 "main": "0",
 "type": "1"
 }
 ]
 }
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Video source

media.source.names (Set device channel names)
media.watermark.enabled (Read watermark switch)