# social.colibri.beta.voice.moderate

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.voice.moderate)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.voice.moderate/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.voice.moderate/examples)

## Definitions

### `social.colibri.beta.voice.moderate`

**Type**: `procedure`

Acts on someone in a voice channel. An absent field leaves the current value unchanged.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `muted` | `boolean` | No | Whether the subject's microphone is muted. Absent leaves the current value unchanged. |
| `channel` | `string` (space-ref) | Yes | The voice channel the subject is in. |
| `subject` | `string` (did) | Yes | Who to act on. |
| `deafened` | `boolean` | No | Whether the subject cannot hear others. Absent leaves the current value unchanged. |
| `disconnect` | `boolean` | No | Whether to disconnect the subject from the channel. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|

#### Errors

- **AuthRequired**: The request has no valid service auth.
- **Forbidden**: The requesting user lacks the voice.moderate permission.
- **ChannelNotFound**: No channel matches the given space reference.
- **NotInVoice**: The subject is not currently connected to the channel.
- **VoiceUnavailable**: This AppView has no voice SFU running.

## Raw Schema

```json
{
  "id": "social.colibri.beta.voice.moderate",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "channel",
            "subject"
          ],
          "properties": {
            "muted": {
              "type": "boolean",
              "description": "Whether the subject's microphone is muted. Absent leaves the current value unchanged."
            },
            "channel": {
              "type": "string",
              "format": "space-ref",
              "description": "The voice channel the subject is in."
            },
            "subject": {
              "type": "string",
              "format": "did",
              "description": "Who to act on."
            },
            "deafened": {
              "type": "boolean",
              "description": "Whether the subject cannot hear others. Absent leaves the current value unchanged."
            },
            "disconnect": {
              "type": "boolean",
              "description": "Whether to disconnect the subject from the channel."
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "AuthRequired",
          "description": "The request has no valid service auth."
        },
        {
          "name": "Forbidden",
          "description": "The requesting user lacks the voice.moderate permission."
        },
        {
          "name": "ChannelNotFound",
          "description": "No channel matches the given space reference."
        },
        {
          "name": "NotInVoice",
          "description": "The subject is not currently connected to the channel."
        },
        {
          "name": "VoiceUnavailable",
          "description": "This AppView has no voice SFU running."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "properties": {}
        },
        "encoding": "application/json"
      },
      "description": "Acts on someone in a voice channel. An absent field leaves the current value unchanged."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```