Get App settings
1. API Description
This API is used to get the App settings.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/app/get-app-settings
- V2.5.0 and below: POST [ip]/mwapi/get-app-settings
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
None
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
| pairingMode | Int | The login mode. 0: Free login 1: Password to login 2: Pairing to login |
| pairingEnable | Int | Whether "Pairing to login" is enabled. 0: No, 1: Yes |
| pairingCode | String | The pairing code, in plaintext |
| encodeMode | Int | The preview quality of scenes on the App. 0: 720p; 1: 1080p; 2: Auto; 3: Customize |
| resolution | String | The resolution |
| duration | Int | The frame rate |
| video-bitrate | Int | The encoding bitrate |
| ssdp-port | Int | The SSDP discovery port |
| control-port | Int | The TCP control port |
| stream-port | Int | The SRT stream port |
| observerCount | Int | The number of watchers 0: None; 1: 1; 2: 2 |
| observerLocked | Boolean | Lock the scene for the watcher to view. true: lock; false: unlock |
| observerAnnotateEnable | Boolean | Allow the watcher to telestrate. true: allow; false: not allow |
4. Example
Getting the App settings.
Input Example
None
Output Example
{
"status": 0,
"pairingMode": 0,
"pairingEnable": 0,
"pairingCode": "",
"isLogged": 0,
"ssdp-port": 1900,
"control-port": 9000,
"stream-port": 9110,
"encodeMode": 0,
"resolution": "1280x720",
"duration": 333333,
"video-bitrate": 2048,
"observerCount": 0,
"observerLocked": false,
"observerAnnotateEnable": true
}
5. Error Code
No error code related to the API business logic. For other error codes, see Common Error Codes.