MumbleClient class abstract
A client that handles all the communication with a Mumble server. Register a MumbleClientListener to get notified on events.
- Implemented types
Constructors
Properties
- audio → AudioClient
-
The audio client which can be used to transmitt audio.
no setter
- closed → bool
-
If this client is closed.
no setter
- cryptState → CryptState
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
no setterinherited
-
listeners
→ Iterable<
MumbleClientListener> -
no setterinherited
- options → ConnectionOptions
-
The connection options used while this client was connected to a server.
no setter
- rootChannel → Channel
-
The servers root channel
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- self → Self
-
The object representing the user which belongs to this client.
no setter
- serverInfo → ServerInfo
-
The info the connected server send.
no setter
Methods
-
add(
MumbleClientListener listener) → void -
inherited
-
close(
) → Future< void> - Closes the connection to a Mumble server.
-
createChannel(
{required String name, int? position, int? maxUsers, String? description, bool? temporary, Channel? parent}) → void -
Creates a new channel. On success
onChannelAddedwill be invoked on all registered listeners. -
getChannels(
) → Map< int, Channel> -
Lists all
Channels in this Mumble server, mapped to their id. -
getUsers(
) → Map< int, User> -
Lists all
Users connected to the Mumble server, mapped to their id, but does not include self. -
listUsers(
) → void -
Requests a list of all registered users and invokes
onUserListReceivedon all registered listeners if successfull. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
queryBans(
) → void -
Queries the banlist of this server and invokes
onBanListReceivedon all registered listeners if successfull. -
queryUsersByIds(
{required List< int> ids}) → void -
Queries the names of the users with the given ids and invokes
onQueryUsersResulton all registered listeners if successfull. -
queryUsersByNames(
{required List< String> names}) → void -
Queries the ids of the users with the given names and invokes
onQueryUsersResulton all registered listeners if successfull. -
registerVoiceTarget(
{required VoiceTarget target}) → void - Register a VoiceTarget on the server to whisper it afterwards.
-
remove(
MumbleClientListener listener) → void -
inherited
-
requestCryptStateResync(
) → void - Requests that the internal udp crypt state (the nonce) is resynced.
-
sendMessage(
{required OutgoingTextMessage message}) → void - Sends a OutgoingTextMessage to users or channels.
-
setBanList(
List< BanEntry> bans) → void - Sets the balist for this server.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateTokens(
{required List< String> tokens}) → void - Sets new tokens for this connection. Tokens are like passwords and used to enter password protected channels.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
connect(
{required ConnectionOptions options, OnBadCertificate? onBadCertificate, bool useUdp = true, Object? localUdpBindAddress, int localUdpBindPort = 0}) → Future< MumbleClient> - Connects a mumble server.