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
          • media.codec.format (Read video encoding format control)
          • media.codec.format (Set video encoding format control)
          • media.codec.audioFormat (Read audio encoding)
          • media.codec.audioFormat (Set audio encoding)
          • media.codec.streamType (Read stream type settings)
          • media.codec.streamType (Set stream type settings)
          • media.codec.streamCount (Read supported stream count)
          • media.codec.autoSwitch (Read auto stream switch)
          • media.codec.autoSwitch (Set auto stream switch)
          • media.codec.bitrateParams (Read stream parameters)
          • media.codec.currentBitrate (Read current stream)
          • media.codec.currentBitrate (Set current stream)
          • media.codec.iFrameSize (Read I-frame size per resolution)
          • media.codec.resolution (Read resolution)
          • media.codec.resolution (Set resolution)
          • media.codec.captureStream (Read snapshot stream aspect ratio)
          • media.codec.playRatio (Read live view play aspect ratio)
        • Display
        • OSD
        • Video source
        • 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.codec.autoSwitch (Read auto stream switch)

media.codec.autoSwitch: Read auto stream switch

media.codec.autoSwitch · Channel scope · Permission Config

What it does

Types:In this capability domain, enum 在 catalog 中常为字符串 0/1;Request/response values may be JSON numbers or strings.

Reads auto stream switch on this channel. 0 off, 1 on.

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

NameTypeRequiredDescription
tokenStringyesAdministrator, sub-user, or sub-account accessToken
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
channelIdStringyesChannel ID; "0" is common on IPCs
propertiesArrayyes["media.codec.autoSwitch"]

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.autoSwitch"
 ]
 }
}

Response data fields

The value is in result.data.properties["media.codec.autoSwitch"].

ValueDescription
0Off
1On

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "media.codec.autoSwitch": 1
 }
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Set auto stream switch · Bitstream

media.codec.streamCount (Read supported stream count)
media.codec.autoSwitch (Set auto stream switch)