Get available resource list for landing scene

1. API Description

This API is used to get available resource list for landing scene, including pictures and videos.

Request mode:

V2.6.0 and above: POST [ip]/mwapi/V2.0/general/get-landing-scene-sources-list
V2.5.0 and below: POST [ip]/mwapi/get-landing-scene-sources-list

Administrator Rights	Logged-in
No	Yes

2. Input Parameters

None

3. Output Parameters

Name	Type	Description
result	Int	Status code
message	String	Status description
info	InfoData	Information of available resources

InfoData

Name	Type	Description
sourceList	Array of SourceData	Array of available resources
totalCount	Int	Total counts of available resources

SourceData

Name	Type	Description
duration	Int	Duration of the resource, only valid for videos and music
filePath	String	Relative path of the resource file, which can be accessed via `http://[Device IP]/file/Relative Path`
height	Int	Height of the resource
homeUrl	String	Homepage address, only valid for web pages
id	Int	Resource ID, the unique identifier of the resource in the device.
name	String	Resource name
rotation	Int	Rotation angle, counterclockwise direction, ranging from 0 to 360
thumbnailPath	String	Relative path of the resource thumbnail, which can be accessed via `http://[Device IP]/file/Relative Path`
totalPageNumber	Int	Number of pages of the file, only valid for PDF files
type	Int	Resource type 0: Preset resources (capture + pictures + videos); 1: Pictures; 2: Videos; 6: Music; 7: Note background images; 10: GFX images; 11: Scene background images; 12: Scene background color; 13: PDF files; 14: Web pages
url	String	Web page address, only valid for web pages
width	Int	Width of the resource

4. Example

Getting available resource list for creating landing scene.

Input Example

None

Output Example

{
    "info": {
        "sourceList": [
            {
                "duration": 0,
                "filePath": "4/4.jpeg",
                "height": 1080,
                "homeUrl": "",
                "id": 4,
                "name": "default",
                "rotation": 0,
                "thumbnailPath": "4/4.thumb.jpeg",
                "totalPageNumber": 0,
                "type": 1,
                "url": "",
                "width": 1920
            },
            {
                "duration": 25858,
                "filePath": "2110/2110.mp4",
                "height": 1080,
                "homeUrl": "",
                "id": 2110,
                "name": "VID_1",
                "rotation": 0,
                "thumbnailPath": "2110/2110.thumb.jpeg",
                "totalPageNumber": 0,
                "type": 2,
                "url": "",
                "width": 1920
            }
        ],
        "totalCount": 2
    },
    "message": "success",
    "result": 0
}

5. Error Code

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

USB Fusion