Get info of USB out

1. API Description

This API is used to get the information of USB out port.

Request mode:

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

2. Input Parameters

None

3. Output Parameters

Name Type Description
status Int Status code
uvc-formats Array of UVCData The UVC format list
uac-formats Array of UACData The UAC format list
UvcData
Name Type Description
fourcc String Video format, supporting NV12, YUYV, ARGB
resolutions ResolutionData Resolution parameters
ResolutionData
Name Type Description
width Int Video width, in px
height Int Video height, in px
fps Int Frame rate (fps X 100)
UACData
Name Type Description
sample-rate Int Audio sampling rate, in Hz
channels Int Number of audio channels
bits-count Int Audio bitrate, in bit

4. Example

Getting the information of USB out port.

Input Example
None
Output Example
{
    "status": 0,
    "uvc-formats": [
        {
            "fourcc": "NV12",
            "resolutions": [
                {
                    "width": 1920,
                    "height": 1080,
                    "fps": 6000
                },
                {
                    "width": 1920,
                    "height": 1080,
                    "fps": 3000
                },
                {
                    "width": 1920,
                    "height": 1080,
                    "fps": 1500
                },
                {
                    "width": 1280,
                    "height": 720,
                    "fps": 6000
                },
                {
                    "width": 1280,
                    "height": 720,
                    "fps": 3000
                },
                {
                    "width": 1280,
                    "height": 720,
                    "fps": 1500
                },
                {
                    "width": 640,
                    "height": 480,
                    "fps": 6000
                },
                {
                    "width": 640,
                    "height": 480,
                    "fps": 3000
                },
                {
                    "width": 640,
                    "height": 480,
                    "fps": 1500
                }
            ]
        },
        {
            "fourcc": "YUYV",
            "resolutions": [
                {
                    "width": 1920,
                    "height": 1080,
                    "fps": 6000
                },
                {
                    "width": 1920,
                    "height": 1080,
                    "fps": 3000
                },
                {
                    "width": 1920,
                    "height": 1080,
                    "fps": 1500
                },
                {
                    "width": 1280,
                    "height": 720,
                    "fps": 6000
                },
                {
                    "width": 1280,
                    "height": 720,
                    "fps": 3000
                },
                {
                    "width": 1280,
                    "height": 720,
                    "fps": 1500
                },
                {
                    "width": 640,
                    "height": 480,
                    "fps": 6000
                },
                {
                    "width": 640,
                    "height": 480,
                    "fps": 3000
                },
                {
                    "width": 640,
                    "height": 480,
                    "fps": 1500
                }
            ]
        },
        {
            "fourcc": "ARGB",
            "resolutions": [
                {
                    "width": 1920,
                    "height": 1080,
                    "fps": 3000
                },
                {
                    "width": 1920,
                    "height": 1080,
                    "fps": 1500
                },
                {
                    "width": 1280,
                    "height": 720,
                    "fps": 6000
                },
                {
                    "width": 1280,
                    "height": 720,
                    "fps": 3000
                },
                {
                    "width": 1280,
                    "height": 720,
                    "fps": 1500
                },
                {
                    "width": 640,
                    "height": 480,
                    "fps": 6000
                },
                {
                    "width": 640,
                    "height": 480,
                    "fps": 3000
                },
                {
                    "width": 640,
                    "height": 480,
                    "fps": 1500
                }
            ]
        }
    ],
    "uac-formats": [
        {
            "sample-rate": 48000,
            "channels": 2,
            "bits-count": 16
        }
    ]
}

5. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Status Definition Description
49 MW_STATUS_INVALID_DATA Failed to read configuration

results matching ""

    No results matching ""