package MumbleProto

Get desktop application:
View/edit binary Protocol Buffers messages

• required uint32 channel_id = 1

  Channel ID of the channel this message affects.

• optional bool inherit_acls = 2

  True if the channel inherits its parent's ACLs.

• repeated ACL.ChanGroup groups = 3

  User group specifications.

• repeated ACL.ChanACL acls = 4

  ACL specifications.

• optional bool query = 5

  True if the message is a query for ACLs instead of setting them.

Used in: ACL

• optional bool apply_here = 1

  True if this ACL applies to the current channel.

• optional bool apply_subs = 2

  True if this ACL applies to the sub channels.

• optional bool inherited = 3

  True if the ACL has been inherited from the parent.

• optional uint32 user_id = 4

  ID of the user that is affected by this ACL.

• optional string group = 5

  ID of the group that is affected by this ACL.

• optional uint32 grant = 6

  Bit flag field of the permissions granted by this ACL.

• optional uint32 deny = 7

  Bit flag field of the permissions denied by this ACL.

Used in: ACL

• required string name = 1

  Name of the channel group, UTF-8 encoded.

• optional bool inherited = 2

  True if the group has been inherited from the parent (Read only).

• optional bool inherit = 3

  True if the group members are inherited.

• optional bool inheritable = 4

  True if the group can be inherited by sub channels.

• repeated uint32 add = 5

  Users explicitly included in this group, identified by user_id.

• repeated uint32 remove = 6

  Users explicitly removed from this group in this channel if the group has been inherited, identified by user_id.

• repeated uint32 inherited_members = 7

  Users inherited, identified by user_id.

Used by the client to send the authentication credentials to the server.

• optional string username = 1

  UTF-8 encoded username.

• optional string password = 2

  Server or user password.

• repeated string tokens = 3

  Additional access tokens for server ACL groups.

• repeated int32 celt_versions = 4

  A list of CELT bitstream version constants supported by the client.

• optional bool opus = 5

• optional int32 client_type = 6

  0 = REGULAR, 1 = BOT

Relays information on the bans. The client may send the BanList message to either modify the list of bans or query them from the server. The server sends this list only after a client queries for it.

• repeated BanList.BanEntry bans = 1

  List of ban entries currently in place.

• optional bool query = 2

  True if the server should return the list, false if it should replace old ban list with the one provided.

Used in: BanList

• required bytes address = 1

  Banned IP address.

• required uint32 mask = 2

  The length of the subnet mask for the ban.

• optional string name = 3

  User name for identification purposes (does not affect the ban).

• optional string hash = 4

  The certificate hash of the banned user.

• optional string reason = 5

  Reason for the ban (does not affect the ban).

• optional string start = 6

  Ban start time.

• optional uint32 duration = 7

  Ban duration in seconds.

Sent by the client when it wants a channel removed. Sent by the server when a channel has been removed and clients should be notified.

• required uint32 channel_id = 1

Used to communicate channel properties between the client and the server. Sent by the server during the login process or when channel properties are updated. Client may use this message to update said channel properties.

• optional uint32 channel_id = 1

  Unique ID for the channel within the server.

• optional uint32 parent = 2

  channel_id of the parent channel.

• optional string name = 3

  UTF-8 encoded channel name.

• repeated uint32 links = 4

  A collection of channel id values of the linked channels. Absent during the first channel listing.

• optional string description = 5

  UTF-8 encoded channel description. Only if the description is less than 128 bytes

• repeated uint32 links_add = 6

  A collection of channel_id values that should be added to links.

• repeated uint32 links_remove = 7

  A collection of channel_id values that should be removed from links.

• optional bool temporary = 8

  True if the channel is temporary.

• optional int32 position = 9

  Position weight to tweak the channel position in the channel list.

• optional bytes description_hash = 10

  SHA1 hash of the description if the description is 128 bytes or more.

• optional uint32 max_users = 11

  Maximum number of users allowed in the channel. If this value is zero, the maximum number of users allowed in the channel is given by the server's "usersperchannel" setting.

• optional bool is_enter_restricted = 12

  Whether this channel has enter restrictions (ACL denying ENTER) set

• optional bool can_enter = 13

  Whether the receiver of this msg is considered to be able to enter this channel

Sent by the server to notify the users of the version of the CELT codec they should use. This may change during the connection when new users join.

• required int32 alpha = 1

  The version of the CELT Alpha codec.

• required int32 beta = 2

  The version of the CELT Beta codec.

• required bool prefer_alpha = 3

  True if the user should prefer Alpha over Beta.

• optional bool opus = 4

Sent by the client when it wants to initiate a Context action.

• optional uint32 session = 1

  The target User for the action, identified by session.

• optional uint32 channel_id = 2

  The target Channel for the action, identified by channel_id.

• required string action = 3

  The action that should be executed.

Used to add or remove custom context menu item on client-side.

• required string action = 1

  The action identifier. Used later to initiate an action.

• optional string text = 2

  The display name of the action.

• optional uint32 context = 3

  Context bit flags defining where the action should be displayed. Flags can be OR-ed to combine different types.

• optional ContextActionModify.Operation operation = 4

  Choose either to add or to remove the context action. Note: This field only exists after Mumble 1.2.4-beta1 release. The message will be recognized as Add regardless of this field before said release.

• Server = 1

  Action is applicable to the server.

• Channel = 2

  Action can target a Channel.

• User = 4

  Action can target a User.

Used in: ContextActionModify

• Add = 0

• Remove = 1

Used to initialize and resync the UDP encryption. Either side may request a resync by sending the message without any values filled. The resync is performed by sending the message with only the client or server nonce filled.

• optional bytes key = 1

  Encryption key.

• optional bytes client_nonce = 2

  Client nonce.

• optional bytes server_nonce = 3

  Server nonce.

• optional uint32 permission = 1

  The denied permission when type is Permission.

• optional uint32 channel_id = 2

  channel_id for the channel where the permission was denied when type is Permission.

• optional uint32 session = 3

  The user who was denied permissions, identified by session.

• optional string reason = 4

  Textual reason for the denial.

• optional PermissionDenied.DenyType type = 5

  Type of the denial.

• optional string name = 6

  The name that is invalid when type is UserName.

Used in: PermissionDenied

• Text = 0

  Operation denied for other reason, see reason field.

• Permission = 1

  Permissions were denied.

• SuperUser = 2

  Cannot modify SuperUser.

• ChannelName = 3

  Invalid channel name.

• TextTooLong = 4

  Text message too long.

• H9K = 5

  The flux capacitor was spelled wrong.

• TemporaryChannel = 6

  Operation not permitted in temporary channel.

• MissingCertificate = 7

  Operation requires certificate.

• UserName = 8

  Invalid username.

• ChannelFull = 9

  Channel is full.

• NestingLimit = 10

  Channels are nested too deeply.

• ChannelCountLimit = 11

  Maximum channel count reached.

• ChannelListenerLimit = 12

  Amount of listener objects for this channel has been reached

• UserListenerLimit = 13

  Amount of listener proxies for the user has been reached

Sent by the client when it wants permissions for a certain channel. Sent by the server when it replies to the query or wants the user to resync all channel permissions.

• optional uint32 channel_id = 1

  channel_id of the channel for which the permissions are queried.

• optional uint32 permissions = 2

  Channel permissions.

• optional bool flush = 3

  True if the client should drop its current permission information for all channels.

Sent by the client to notify the server that the client is still alive. Server must reply to the packet with the same timestamp and its own good/late/lost/resync numbers. None of the fields is strictly required.

• optional uint64 timestamp = 1

  Client timestamp. Server should not attempt to decode.

• optional uint32 good = 2

  The amount of good packets received.

• optional uint32 late = 3

  The amount of late packets received.

• optional uint32 lost = 4

  The amount of packets never received.

• optional uint32 resync = 5

  The amount of nonce resyncs.

• optional uint32 udp_packets = 6

  The total amount of UDP packets received.

• optional uint32 tcp_packets = 7

  The total amount of TCP packets received.

• optional float udp_ping_avg = 8

  UDP ping average.

• optional float udp_ping_var = 9

  UDP ping variance.

• optional float tcp_ping_avg = 10

  TCP ping average.

• optional float tcp_ping_var = 11

  TCP ping variance.

Used to send plugin messages between clients

• optional uint32 senderSession = 1

  The session ID of the client this message was sent from

• repeated uint32 receiverSessions = 2

  The session IDs of the clients that should receive this message

• optional bytes data = 3

  The data that is sent

• optional string dataID = 4

  The ID of the sent data. This will be used by plugins to check whether they will process it or not

Client may use this message to refresh its registered user information. The client should fill the IDs or Names of the users it wants to refresh. The server fills the missing parts and sends the message back.

• repeated uint32 ids = 1

  user_ids.

• repeated string names = 2

  User names in the same order as ids.

Sent by the server when it rejects the user connection.

• optional Reject.RejectType type = 1

  Rejection type.

• optional string reason = 2

  Human readable rejection reason.

Used in: Reject

• None = 0

  The rejection reason is unknown (details should be available in Reject.reason).

• WrongVersion = 1

  The client attempted to connect with an incompatible version.

• InvalidUsername = 2

  The user name supplied by the client was invalid.

• WrongUserPW = 3

  The client attempted to authenticate as a user with a password but it was wrong.

• WrongServerPW = 4

  The client attempted to connect to a passworded server but the password was wrong.

• UsernameInUse = 5

  Supplied username is already in use.

• ServerFull = 6

  Server is currently full and cannot accept more users.

• NoCertificate = 7

  The user did not provide a certificate but one is required.

• AuthenticatorFail = 8

• NoNewConnections = 9

  The server is currently not accepting new connections

Used by the client to request binary data from the server. By default large comments or textures are not sent within standard messages but instead the hash is. If the client does not recognize the hash it may request the resource when it needs it. The client does so by sending a RequestBlob message with the correct fields filled with the user sessions or channel_ids it wants to receive. The server replies to this by sending a new UserState/ChannelState message with the resources filled even if they would normally be transmitted as hashes.

• repeated uint32 session_texture = 1

  sessions of the requested UserState textures.

• repeated uint32 session_comment = 2

  sessions of the requested UserState comments.

• repeated uint32 channel_description = 3

  channel_ids of the requested ChannelState descriptions.

Sent by the server when it informs the clients on server configuration details.

• optional uint32 max_bandwidth = 1

  The maximum bandwidth the clients should use.

• optional string welcome_text = 2

  Server welcome text.

• optional bool allow_html = 3

  True if the server allows HTML.

• optional uint32 message_length = 4

  Maximum text message length.

• optional uint32 image_message_length = 5

  Maximum image message length.

• optional uint32 max_users = 6

  The maximum number of users allowed on the server.

• optional bool recording_allowed = 7

  Whether using Mumble's recording feature is allowed on the server

ServerSync message is sent by the server when it has authenticated the user and finished synchronizing the server state.

• optional uint32 session = 1

  The session of the current user.

• optional uint32 max_bandwidth = 2

  Maximum bandwidth that the user should use.

• optional string welcome_text = 3

  Server welcome text.

• optional uint64 permissions = 4

  Current user permissions in the root channel. Note: The permissions data type usually is uin32 (e.g. in PermissionQuery and PermissionDenied messages). Here it is uint64 because of an oversight in the past. Nonetheless it should never exceed the uin32 range. See also: https://github.com/mumble-voip/mumble/issues/5139

Sent by the server to inform the clients of suggested client configuration specified by the server administrator.

• optional uint32 version_v1 = 1

  Suggested client version in the legacy format.

• optional uint64 version_v2 = 4

  Suggested client version in the new format. Necessary since patch level may exceed 255. (See https://github.com/mumble-voip/mumble/issues/5827)

• optional bool positional = 2

  True if the administrator suggests positional audio to be used on this server.

• optional bool push_to_talk = 3

  True if the administrator suggests push to talk to be used on this server.

Used to send and broadcast text messages.

• optional uint32 actor = 1

  The message sender, identified by its session.

• repeated uint32 session = 2

  Target users for the message, identified by their session.

• repeated uint32 channel_id = 3

  The channels to which the message is sent, identified by their channel_ids.

• repeated uint32 tree_id = 4

  The root channels when sending message recursively to several channels, identified by their channel_ids.

• required string message = 5

  The UTF-8 encoded message. May be HTML if the server allows.

Not used. Not even for tunneling UDP through TCP.

• required bytes packet = 1

  Not used.

Lists the registered users.

• repeated UserList.User users = 1

  A list of registered users.

Used in: UserList

• required uint32 user_id = 1

  Registered user ID.

• optional string name = 2

  Registered user name.

• optional string last_seen = 3

• optional uint32 last_channel = 4

Used to communicate user leaving or being kicked. May be sent by the client when it attempts to kick a user. Sent by the server when it informs the clients that a user is not present anymore.

• required uint32 session = 1

  The user who is being kicked, identified by their session, not present when no one is being kicked.

• optional uint32 actor = 2

  The user who initiated the removal. Either the user who performs the kick or the user who is currently leaving.

• optional string reason = 3

  Reason for the kick, stored as the ban reason if the user is banned.

• optional bool ban = 4

  True if the kick should result in a ban.

Sent by the server when it communicates new and changed users to client. First seen during login procedure. May be sent by the client when it wishes to alter its state.

• optional uint32 session = 1

  Unique user session ID of the user whose state this is, may change on reconnect.

• optional uint32 actor = 2

  The session of the user who is updating this user.

• optional string name = 3

  User name, UTF-8 encoded.

• optional uint32 user_id = 4

  Registered user ID if the user is registered.

• optional uint32 channel_id = 5

  Channel on which the user is.

• optional bool mute = 6

  True if the user is muted by admin.

• optional bool deaf = 7

  True if the user is deafened by admin.

• optional bool suppress = 8

  True if the user has been suppressed from talking by a reason other than being muted.

• optional bool self_mute = 9

  True if the user has muted self.

• optional bool self_deaf = 10

  True if the user has deafened self.

• optional bytes texture = 11

  User image if it is less than 128 bytes.

• optional bytes plugin_context = 12

  The positional audio plugin identifier. Positional audio information is only sent to users who share identical plugin contexts. This value is not transmitted to clients.

• optional string plugin_identity = 13

  The user's plugin-specific identity. This value is not transmitted to clients.

• optional string comment = 14

  User comment if it is less than 128 bytes.

• optional string hash = 15

  The hash of the user certificate.

• optional bytes comment_hash = 16

  SHA1 hash of the user comment if it 128 bytes or more.

• optional bytes texture_hash = 17

  SHA1 hash of the user picture if it 128 bytes or more.

• optional bool priority_speaker = 18

  True if the user is a priority speaker.

• optional bool recording = 19

  True if the user is currently recording.

• repeated string temporary_access_tokens = 20

  A list of temporary access tokens to be respected when processing this request.

• repeated uint32 listening_channel_add = 21

  A list of channels the user wants to start listening to.

• repeated uint32 listening_channel_remove = 22

  a list of channels the user does no longer want to listen to.

• repeated UserState.VolumeAdjustment listening_volume_adjustment = 23

  A list of volume adjustments the user has applied to listeners

Used in: UserState

• optional uint32 listening_channel = 1

• optional float volume_adjustment = 2

Used to communicate user stats between the server and clients.

• optional uint32 session = 1

  User whose stats these are.

• optional bool stats_only = 2

  True if the message contains only mutable stats (packets, ping).

• repeated bytes certificates = 3

  Full user certificate chain of the user certificate in DER format.

• optional UserStats.Stats from_client = 4

  Packet statistics for packets received from the client.

• optional UserStats.Stats from_server = 5

  Packet statistics for packets sent by the server.

• optional uint32 udp_packets = 6

  Amount of UDP packets sent.

• optional uint32 tcp_packets = 7

  Amount of TCP packets sent.

• optional float udp_ping_avg = 8

  UDP ping average.

• optional float udp_ping_var = 9

  UDP ping variance.

• optional float tcp_ping_avg = 10

  TCP ping average.

• optional float tcp_ping_var = 11

  TCP ping variance.

• optional Version version = 12

  Client version.

• repeated int32 celt_versions = 13

  A list of CELT bitstream version constants supported by the client of this user.

• optional bytes address = 14

  Client IP address.

• optional uint32 bandwidth = 15

  Bandwidth used by this client.

• optional uint32 onlinesecs = 16

  Connection duration.

• optional uint32 idlesecs = 17

  Duration since last activity.

• optional bool strong_certificate = 18

  True if the user has a strong certificate.

• optional bool opus = 19

• optional UserStats.RollingStats rolling_stats = 20

  Rolling packet statistics

Used in: UserStats

• optional uint32 time_window = 1

  Rolling packet statistics time window as defined on the server.

• optional Stats from_client = 2

  Rolling packet statistics for packets received from the client.

• optional Stats from_server = 3

  Rolling packet statistics for packets sent by the server.

Used in: UserStats, RollingStats

• optional uint32 good = 1

  The amount of good packets received.

• optional uint32 late = 2

  The amount of late packets received.

• optional uint32 lost = 3

  The amount of packets never received.

• optional uint32 resync = 4

  The amount of nonce resyncs.

Used in: UserStats

• optional uint32 version_v1 = 1

  Legacy version number format.

• optional uint64 version_v2 = 5

  New version number format. Necessary since patch level may exceed 255. (See https://github.com/mumble-voip/mumble/issues/5827)

• optional string release = 2

  Client release name.

• optional string os = 3

  Client OS name.

• optional string os_version = 4

  Client OS version.

Sent by the client when it wants to register or clear whisper targets. Note: The first available target ID is 1 as 0 is reserved for normal talking. Maximum target ID is 30.

• optional uint32 id = 1

  Voice target ID.

• repeated VoiceTarget.Target targets = 2

  The receivers that this voice target includes.

Used in: VoiceTarget

• repeated uint32 session = 1

  Users that are included as targets.

• optional uint32 channel_id = 2

  Channel that is included as a target.

• optional string group = 3

  ACL group that is included as a target.

• optional bool links = 4

  True if the voice should follow links from the specified channel.

• optional bool children = 5

  True if the voice should also be sent to children of the specific channel.