Mute or unmute streaming
Updated
Mutes or unmutes the audio of a current Media Gateway stream.
https://api.sd-rtn.com/{region}/{version}/projects/{appId}/rtls/ingress/online-streams/mute/{sid}Use this method to mute or unmute the current streaming.
Path Parameters
Region for the streaming key or stream. Supported values are na for North America, eu for Europe, ap for Asia except mainland China, and cn for mainland China.
Important
Make sure that:
- The
regionvalue is the same as for the input source stream. - The domain names for setting the
regionparameter and streaming are the same. - The
regionvalue is in lowercase.
na | eu | ap | cnThe app ID provided by Agora to each developer. After creating a project in Agora Console, you can get an app ID. The app ID is a unique identifier for a project.
The streaming session ID. Each initiated streaming task generates a unique SID.
Header Parameters
The UUID (Universally Unique Identifier) of the request. After you pass in this field, the Agora server returns this field in the response header. It is recommended to assign X-Request-ID a value. If omitted, the Agora server automatically generates a UUID and returns it.
6d35d43f-f4c5-4b3a-9df4-8f0d7e1d5f0aRequest Body
application/json
Response Body
application/json
application/json
application/json
Response schema
200application/jsonThe request succeeded and sent the mute/unmute command.
The status of this request. success means the request succeeds.
401application/jsonThe request failed. A 401 (Unauthorized) response status code means the request is not authorized.
Response Headers
The UUID (Universally Unique Identifier) of the request. The value is in the X-Request-ID response header. If a request error occurs, print the value in the log to troubleshoot the problem.
200Example6d35d43f-f4c5-4b3a-9df4-8f0d7e1d5f0aNote
-
The successful execution of this request only confirms that the command is sent to the gateway node handling the stream; it does not guarantee that the mute/unmute operation was successful. The operation is executed asynchronously in the background.
-
Typically, the mute/unmute action takes effect within approximately one second. If the operation does not work as expected, retry the API call.
-
By default, each stream starts unmuted (audio and video are published normally). Each API call applies to the current stream. If the streamer disconnects and restarts the stream, the new stream resets to the initial unmuted state.
Request examples
curl --request post \ --url https://api.sd-rtn.com/:region/:version/projects/:appId/rtls/ingress/online-streams/mute/:sid \ --header 'Authorization: Basic <credentials>' \ --header 'X-Request-ID: <string>' \ --data '{ "settings": { "videoMuted": true, "audioMuted": false }}'Response example
{ "status": "success"}{ "status": "error", "message": "Describes why the request failed."}{ "status": "error", "message": "Describes why the request failed."}