mirror of
https://github.com/m1k1o/neko.git
synced 2025-04-30 02:46:21 +02:00
71 lines
No EOL
4.7 KiB
Text
71 lines
No EOL
4.7 KiB
Text
---
|
|
id: broadcast-start
|
|
title: "Start Broadcast"
|
|
description: "Start broadcasting the room's content."
|
|
sidebar_label: "Start Broadcast"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzVWFtv28YS/iuDDdDTEhSlOu2L3hxVBzXiJIUltw+JUYzIkbjRcpfZWdpRDf33YnYpiZaTgzycl/hFEjmX75ud2/pRBdywmr5X3rlmtPIOqxI5qLtcVcSl123QzqqpWgT0AY4C2m4g1ASi9h+G0tlANhQqV64lj6J0VampOipEfZUrT9w6y8Rq+qguJr/Ix1NPrw4qwKJDFXBXlsS87ozZFWqfq18mk+d6bzSzwDq6hNuba0HUgxMNbFujywhv/JFF7VFxWVOD8i3sWlJT5VYfqRSsrRcyQSewDTHjhgaCHLy2G3Ueqt8ooDZUAXnvPPR6hdrvcxV0MKI6l1dveov7/T6S+vk5qaXEmD51xCF+ak8MHZMH7EJNNvRsviueL7/Mk8nfk4fOVuQ5OFelDEvsc1h1EoJ1x8QQXOTvvP6HQIfvif3FxXP2i8RcM6DxhNXuSaF9R+x+/VJh3lpcGZIz46dN5Lshtpe+FdPwlat24uT/BLvz5kuQ6TM2bYTiQ9NOx2PjSjS14zA2+p6ekZLqub25BreOJTMI8D5Xmv/GMojaydPKOUNonxm6spVQIQZ9ZiomZzTzNFavBg0+dKyOwdKeKjUNvqN9rhoKtZN50DqOUcBQq6kaY6vHMkLGRz9j7gdF6gYym87z6VqC0XcLlacYqjqEJ4GavpxMJmp/J4bKzuuwi5ZeEXryl524f3+3zx/VzLmtpuGTpduSPT4YWFjIqaaDG2odo4qtfk07lSstMMsoonJlsZG3b+ev3/29mC8WV+/ePgv85ZNuDl2cZAhMzPI72YrHOWRw9CzsJWYRoJxvFPpWL8kkBOEdfQwi8BVynzryuxO3qPqt7qIwtMhMFSADQrQGLXpsKJBPGSa1dHOquvmhJvqq+WppDPK9zz5t1y4y6XP2LW0dXP5xpXIlKZbAviwmxeQZhSgaR85ftLpZzgBtJV8XrtxSgBWxrojhZr5YikVpcq1397qSwYVmFHRDID+l+XnCRttNDtoG8gkklM4YXLm0M+XRvqfGBYKKeBtcC+vOlvISjQ674oP9YF+8eAEz5wmWVNbWGbfRxPJiBFn2Z/S2OHgDJ6Mloc+yDxZgBJGVoXvyuCGGLDu8hrXzJ+A5GPcwMhjIlrscar2pR5+6CKPnJGixq/SAXZFcvKbdyqGvokjjOiage7KBAT1B8Gi50UG2u4hPeg1jQ4cwl85aiqwjJCZsDDGfIudscSB8I3iXEuiF3kiUJMtsBTPXNJ09ZN8hDOnkDpGI1A+PpMd1kpTR5cmYtgdYP1KxKfJjWRIHXBnNdUM25HA1m0OJttIVBgL6XNZoN/RTAZCcXcfzrjGcLHStyHI6920fs3GK1xqNWWG5jRGr0VbmEK0j5lMMDgko0Of35HehFuhzw3TielaQP8Cih/EGLW5IWGQZjGAhDY++tGdGnAfwEZMc+YFglt0410SZW9E9MzvzhCEWQOMqvd7FryIs09Q7E4OdnMaFX6pJpgMPHPzWF8UsqXA0fFl97NKdhEtPJP3SrvWmS0XFOTQCRN5vv5aWxcHBYseBGvid0IQafoA3FLwuk58b+U730VESq5NYWVO55Wj0eP9BA9qy3tQh4U9l+7t7gKsAl8bAX85vGZZuQ6EmLwI/F8NaTEfO0FCl8VRg8Yiz7Ky95H0dCoQKA2ZZ8cFeFGcJTpY7uUEgZFkrrY9DzNyVrrSnvstk2Xn5DdrAsAITr5fFIP+y7ND/pK2staXRxqO2dDzkLEs5PDjnvutJ6jw5uJjd/5UtTXpdFTc3zuUSEKdVbBpyKYyJX7myk0w7aKpcGV2S5Tgy+jl12WJZE1zETv9kcXh4eCgwvi2c34x7VR5fX83mbxfz0UUxKerQmDiaZItp0A4Mp+vxcRk6nyODhfHbb9L94A30OYxbg9rKaO43xrRAvZepLJdq5xqVny7bsgrENeouVzIaRfLxcYVMt97s9/I4DfDp+7tc3aPXsqGn/UfVhBX5uC1taaemapYgjZaCR8RNlxaCs71XdqekcVmW1Ib/KXs3WAr/eLdYCvx+t25cFVdffBBq+KCmKv5fIaacCMRnj8qg3XRx6VfJpvz9CzE/2co=
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/neko-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={"Start Broadcast"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"post"}
|
|
path={"/api/room/broadcast/start"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Start broadcasting the room's content.
|
|
|
|
<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":{"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"}}},"required":true}}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"204":{"description":"Broadcast started successfully."},"400":{"description":"Missing broadcast URL.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"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":"Server is already broadcasting.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"500":{"description":"Unable to start broadcast.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|