Module tcp 

TCP control-channel messages (proto2, package MumbleProto).

Modules

acl

Nested message and enum types in ACL.

ban_list

Nested message and enum types in BanList.

context_action_modify

Nested message and enum types in ContextActionModify.

permission_denied

Nested message and enum types in PermissionDenied.

reject

Nested message and enum types in Reject.

user_list

Nested message and enum types in UserList.

user_state

Nested message and enum types in UserState.

user_stats

Nested message and enum types in UserStats.

voice_target

Nested message and enum types in VoiceTarget.

Structs

Acl

Authenticate

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

BanList

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.

ChannelRemove

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.

ChannelState

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.

CodecVersion

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.

ContextAction

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

ContextActionModify

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

CryptSetup

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.

PermissionDenied

PermissionQuery

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.

Ping

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.

PluginDataTransmission

Used to send plugin messages between clients

QueryUsers

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.

Reject

Sent by the server when it rejects the user connection.

RequestBlob

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.

ServerConfig

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

ServerSync

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

SuggestConfig

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

TextMessage

Used to send and broadcast text messages.

UdpTunnel

Not used. Not even for tunneling UDP through TCP.

UserList

Lists the registered users.

UserRemove

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.

UserState

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.

UserStats

Used to communicate user stats between the server and clients.

Version

VoiceTarget

Sent by the client when it wants to register or clear whisper targets.