webpage/docs/api/broadcast-status.api.mdx
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 Broadcast Status"}
</Heading>
<MethodEndpoint method={"get"} path={"/api/room/broadcast"} context={"endpoint"}
</MethodEndpoint>
Retrieve the current broadcast status of the room.
<ParamsDetails parameters={undefined}
</ParamsDetails>
<RequestSchema title={"Body"} body={undefined}
</RequestSchema>
<StatusCodes id={undefined} label={undefined} responses={{"200":{"description":"Broadcast status retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","example":"rtmp://localhost/live","description":"The URL of the broadcast."},"is_active":{"type":"boolean","description":"Indicates if the broadcast is active."}},"title":"BroadcastStatus"}}}},"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"}}}}}}
</StatusCodes>