Back to Neko

Change Screen Configuration

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

3.1.42.4 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={"Change Screen Configuration"}

</Heading>

<MethodEndpoint method={"post"} path={"/api/room/screen"} context={"endpoint"}

</MethodEndpoint>

Update the screen configuration of the room.

<Heading id={"request"} as={"h2"} className={"openapi-tabs__heading"} children={"Request"}

</Heading>

<ParamsDetails parameters={undefined}

</ParamsDetails>

<RequestSchema title={"Body"} body={{"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"}}},"required":true}}

</RequestSchema>

<StatusCodes id={undefined} label={undefined} responses={{"200":{"description":"Screen configuration updated 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"}}}},"422":{"description":"Invalid screen configuration.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}

</StatusCodes>