Back to Neko

Get Screen Configuration

webpage/docs/api/screen-configuration.api.mdx

3.1.41.9 KB
Original Source

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>