neko/webpage/docs/api/broadcast-status.api.mdx
2025-03-22 17:52:56 +01:00

63 lines
No EOL
3.8 KiB
Text

---
id: broadcast-status
title: "Get Broadcast Status"
description: "Retrieve the current broadcast status of the room."
sidebar_label: "Get Broadcast Status"
hide_title: true
hide_table_of_contents: true
api: eJzVV9uO2zYQ/ZUBAxStIMtO0ie/bTZussilxXrTPCRBMZbGEmOKVDiUN+7C/14MKfmWFCiKvvTJtjiac+Zwbn5QAWtW8w/KO9dOVt5hVSIH9SlXFXHpdRe0s2qubil4TVuC0BCUvfdkAxzsgQOGnsGt47k4K1SuXEcexcFNpebqYL2MxipXnrhzlonV/EE9mc3k4xz22SWCH3hUwH1ZEvO6N2YnYKWzgWwQH9h1RpcRefqZxdGD4rKhFuVb2HWk5sqtPlMZVK46LzyDTjR6b06MOHhta5Ur+optZ+SRD203n06NK9E0jsPU6C2pS73uGoJ3t69HRQ6xF2qfK81/YBnktSPSyjlDaL9xdGMrCYUY9IUr0AzJTaH2+1wFHSLBZxc67/dy+vPs8bfyCktPX3riED+1J4aeyQP2oSEbBhX/Q31bYsaavqfxObfnFFAbqoC8dx6G985DXcjRm8HjGOfT78fJ5LfkobcVeQ7OVSlVU/Q5rHqRYN0zMQQX43de/0mgw/8m+n2uWgqNk2qrKaJjaNRcTbHTU6nK6bHEc5UUkfK/1Ou1JPegmMpTTagmhLPEnz+dzWZq/0kclb3XYRc9PSP05K96Af7waZ8/qGvnNppOn9y5DdnDgxMPS9ExSXX61kEt7PQr2qlcaaFZRhOVK4utnL5dvPr1j+Viubz59e03il6dZTT0rG0NCEzM8jv5iuV5GsEBWaIXzSJBqddo9E9RkksIEnfEOFHgb4L70pPfHWOLr/5TuGgMHTJTBciAEL1Bhx5bCuRTImm7dhF/SKi3tHFw9duNypUkRoJ4WsyK2TfA0TQWy3ta3d5dA9pKvi5duaEAK2JdEcPtYnknHqWkOu+2upKSQzMJuiWQnw44eMJW2zoHbQP51NOgdMbgyqUBkkf/nloXCCriTXAdrHtbyiEaHXbFR/vRPnr0CK6dJ7ijsrHOuFoTy8EEsuz3iLYc0cBJO0jss+yjBZhAjMrQljzWxJBl4zGsnT8Sz8G4+4nBQLbc5dDoupl86SONISZhi32lT6IrEsQr2q0c+iqatK5nAtqSDQzoCYJHy60OgarET3oUY0ujzKWzlmLUkRITtoaYj8o5W4wB3wrfOxF6qWtRSXLDVnDt2ra3Y86MMqSbG5WIoY+PZNL0kkoR8uhM25HWj1TURX4oJuKAK6O5acmGHG6uF1CirXSFgYC+lg3amn4qABLY63jfDYajh74TW073vhk0mya91mjMCstNVKxBW5lRrQPnowZjAgr1xZb8LjRCfWGYjrFelNEPsBxovEGLNUkUWQYTWEqbou9NyMhzJB85yZWPAWbZrXNttHkn7164vfaEIRZA6yq93sWvYixTxzsTxU6gceeRapJuzicAz4eiuE6vcHR8VX3uWTwDl55Iupxd67pPRcU5tEJEzjd/l5bFCLDccaAWXhKa0MAP8EY2sTLhDNthBEpmTTIrGyo3HJ0elkE0oC3rugmJfyrbl+4ebgJcGQPvnd8w3LmaQkNeDB4Xp7WYrpyhpUrjscDiFWfZRXvJhzoUChUGzLLio31SXCQ4We5l90HIsk5aH4eYuStdaU9Dl8myy/I7aQOnFZjielqc5F+Wjf1P2spaW5rUHrWlwyVnWcrhk3seup6kztnFxez+RdYC6XVVXBU4l/UlzpjYNGQvjolfubKXTBvfVLkyuiTLcQsZpstVh2VD8CR2+rNxf39/X2A8LZyvp8OrPH19c714u1xMnhSzogmtiQOlcxxatCeOX1CA4xJ/2PzPhsnDcbv6d/8zhvkZ6GuYdga1lQk7LPJpA/ogw1X+cTjXqlyd/dGRXUYsHh5WyPTOm/1eHqf5O//wKVdb9BpXMiJlfVENYUU+Ljsb2ol6ZUmdbFRbNH2a5Bcrouw4h9XsxeJO7fd/AesDr1g=
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 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>