mirror of
https://github.com/m1k1o/neko.git
synced 2025-04-30 10:56:20 +02:00
63 lines
No EOL
4.1 KiB
Text
63 lines
No EOL
4.1 KiB
Text
---
|
|
id: screen-configuration
|
|
title: "Get Screen Configuration"
|
|
description: "Retrieve the current screen configuration of the room."
|
|
sidebar_label: "Get Screen Configuration"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzVV99v2zYQ/lcOLFBsgiy7yYYNfstcrwvapkPsrg9JMNDUWWJNkSpJOfUM/+/DkZItO25RDHvpk2Xx7rv7jvdLW+Z54dj4jlljqoETFlGzh5Tl6ISVtZdGszG7RW8lrhF8iSAaa1F7iMIgjF7KorGcZMEsgwyhZSxlpsZ4cJ2zMYsak74CS5lFVxvt0LHxll2MRvRzbH52zpJtfcrBNUKgc8tGqQ0ZFUZ71J5weF0rKYLC8KMjsC1zosSK05Pf1MjGzCw+ovAsZbUlf72MrjzK3Jc9Mak9FmhZyvAzr2qFbPzi4tfRaazmJUJQ7WIRWWdsl7ISZVH6r2P+cnEWMqqewbTc49cRL88CWlxadCWQ/hPYXcq89KTcBv/40nY7kvhp9OLpXUXoTw06H36lRQeNQwu88SVq317H/3hRFTrHi34QnLdSF+yU9kv0XCrMAa01Flq9Y7pTOnrbInY8L8/zdGjXaKHROVrnjclj7kf2KSwaCsGycejAm8DfWPkPgvTfEfufz1Xke80XColVgec7wXfDcJeyCn1pqEEVGKxzqns25LUcUiMbtm0xZfHCqV+eBuSNEVy1CcFS1ljFxqz0vh4Ph4rOSuP8+HI0GrHdAwGJxkq/CUi/IbdorxqyevewS7dsYsxKYv/N3KxQ71/0EGYUxBinvtY+VLyWr3HDUibJTRFEWMo0r+j0Zvr63d+z6Wx2/e7mSTivjgoWGid1ARwcOkf/I1boQX0Ge8vEnmIWHGRjtghC32olQoIn3sFGLwJfIPepQbs5cAuq32ouCEPNncMcuAMOAQ1qbnmFHm3MIqmXJthvs+kGVwau/rxmKaPEiCYus1E2emI4iIZe8AEXt/MJcJ3T48yIFXpYoJM5OridzuaESLVVW7OWOXUUrgZeVgj014DzFnkldZECtXvLhZdrBGGU4gsT6y8N+BYr4xFydCtvalg2WtAhV9Jvsnt9r589ewYTYxHmKEptlCkkOjoYQJL8FazNOmtgqNtF75PkXgMMILBSuEbLC3SQJN0xLI09OJ6CMo8DxT1qsUmhlEU5+NQEN1pO5C1vctljl0UTr3GzMNzmQaQyjUPANWrvgFsEb7l2lfQe8+hfmGO8wi7MwmiNgXVwySGvFDp3iJzRWUf4lvydU6BnsqAoUW7oHCamqhrd5UwXhnhzXSQC9e4VyDD08mjyACZ159YPmBVZui8mdJ4vlHRlhdqncD2ZguA6lzlNZ/wsSq4L/DEDiMbehPsuuT8gNDXJunjvqzZmwxivJVdqwcUqRKzkOlddtPY+H2LQJSC5Pl2j3fiSXJ8qhweuJ2X0HGatG2+55gUSiySBAcyoTeG5BSD42TkffKIr7wgmya0xVZB5T7onsBOL3IcCqEwul5vwSMI0cqxRIdjRaNgNqZqolbuegZdtUUyiigvAV/nHxhHy2aHmUqjIETpffSkts87AbOM8VvAHcuVLeA5vaWMV0U67UQdDUayMYqJEsXIBdL88cwVSO9r/ov+xbP8wj3Dt4Uop+GDsysHcFOhLtCTwIuvXYrxyBxXmkh8KLFxxkpy0l7StQ3Ih554nSXavL7KTBEftGlrtOCRJTa3P+ZC5C5lLi22XSZLT8uu1gX4FRl6XWS//kqTrf9RWllLjoLBcatxfcpLEHO7dc9v1KHWOtxGKye+0E1Cvy8Oe4FLazsKMCU2Dvh9C4udGNJRpnSZLmZICtQsrSDtdrmouSoSL0OmPxv3j42PGw2lmbDFsVd3wzfVkejObDi6yUVb6SoWBUhvnK657wK/QQ/vBc/qldDRQtof16r9/n7Vz1ONnP6wVl5ombWCzbdegOxqy9JVmTBWmefeFSAsNHW+3C+7wvVW7Hb2OQ3h895CyNbeS1sS4w7ASeY42bDwr3FAIhcCaFq41V00c5ydLIi06++Xs1XTOdrt/AU/yGp8=
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/v3/api
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import ParamsDetails from "@theme/ParamsDetails";
|
|
import RequestSchema from "@theme/RequestSchema";
|
|
import StatusCodes from "@theme/StatusCodes";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Heading from "@theme/Heading";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"Get Screen Configuration"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/api/room/screen"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Retrieve the current screen configuration of the room.
|
|
|
|
<ParamsDetails
|
|
parameters={undefined}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"Screen configuration retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"width":{"type":"integer","example":1280,"description":"The width of the screen."},"height":{"type":"integer","example":720,"description":"The height of the screen."},"rate":{"type":"integer","example":30,"description":"The refresh rate of the screen."}},"title":"ScreenConfiguration"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"403":{"description":"The server understood the request, but refuses to authorize it.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"500":{"description":"Unable to get screen configuration.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|