Get preview quality

1. API Description

This API is used get the encoding parameters for preview.

Request mode:

  • V2.6.0 and above: POST [ip]/mwapi/V2.0/app/get-encoder-params
  • V2.5.0 and below: POST [ip]/mwapi/get-encoder-params
Administrator Rights Logged-in
No Yes

2. Input Parameters

None

3. Output Parameters

Name Type Description
status Int Status code
resolutions Array of ResolutionData Array of resolution data
durations Array of DurationData Array of frame interval
video-bitrates Array of VideoBitrateData Array of video bitrate
ResolutionData
Name Type Description
name String The displayed name of resolution
value String The resolution value, width x height
DurationData
Name Type Description
name String The displayed name of frame interval
value String The value of frame interval
VideoBitrateData
Name Type Description
name String The displayed name of video bitrate
value String The value of video bitrate

4. Example

Getting the encoding parameters for preview.

Input Example
None
Output Example
{
    "status": 0,
    "resolutions": [
        {
            "name": "1080P",
            "value": "1920x1080"
        },
        {
            "name": "720P",
            "value": "1280x720"
        }
    ],
    "durations": [
        {
            "name": "60 FPS",
            "value": "166667"
        },
        {
            "name": "10 FPS",
            "value": "1000000"
        }
    ],
    "video-bitrates": [
        {
            "name": "20 Mbps",
            "value": "20480"
        },
        {
            "name": "256 Kbps",
            "value": "256"
        }
    ]
}

5. Error Code

No error code related to the API business logic. For other error codes, see Common Error Codes.

results matching ""

    No results matching ""