User - Rantanen/node-mumble GitHub Wiki

Params

• data Object - User data.
• client MumbleClient - Mumble client that owns this user.

Single user on the server.

• User(data, client)
  • Methods
    • ban([reason])
    • canHear()
    • canTalk()
    • inputStream()
    • isRegistered()
    • kick([reason])
    • moveToChannel(channel)
    • outputStream([noEmptyFrames])
    • sendMessage(message)
    • setComment(comment)
    • setSelfDeaf(isSelfDeaf)
    • setSelfMute(isSelfMute)
  • Properties
    • channel
    • deaf
    • hash
    • id
    • mute
    • name
    • prioritySpeaker
    • recording
    • selfDeaf
    • selfMute
    • session
    • suppress
  • Events
    • 'disconnect'
    • 'move' (oldChannel, newChannel, actor)
    • 'mute' (status)
    • 'priority-speaker' (status)
    • 'recording' (status)
    • 'self-deaf' (status)
    • 'self-mute' (status)
    • 'suppress' (status)

Attempts to ban the user.

Params

• [reason] string - The reason to ban the user for.

Checks whether the user can hear other people.

Returns: Boolean - True if the user can hear.

Checks whether the user can talk or not.

Returns: Boolean - True if the user can talk.

Returns an input stream for sending audio to the user.

Returns: MumbleInputStream - Input stream.

true when the user is registered on the server.

Returns: Boolean - true if the user is registered.

Attempts to kick the user.

Params

• [reason] string - The reason to kick the user for.

Moves the user to a channel

Params

• channel Channel | string - Channel name or a channel object

Returns an output stream for listening to the user audio.

Params

• [noEmptyFrames] Boolean - True to cut the output stream during silence. If the output stream isn't cut it will keep emitting zero-values when the user isn't talking.

Returns: MumbleOutputStream - Output stream.

Sends a message to the user.

Params

• message string - The message to send.

Set the user's comment. Displayed when user's name is hovered over in client.

Params

• comment String - The new comment

Change a user's self deafened state. (Obviously) only works on yourself.

Params

• isSelfDeaf Boolean - The new self deafened state

Change a user's self muted state. (Obviously) only works on yourself.

Params

• isSelfMute Boolean - The new self muted state

User's current channel.

true when the user is deafened by an admin.

The hash of the user certificate

User ID

See: User#session

User ID is specified only for users who are registered on the server. The user ID won't change when the user reconnects.

true when the user is muted by an admin.

User name

true when the user is a priority speaker.

true when the user is recording the conversation.

true when the user has deafened themselves.

true when the user has muted themselves.

Session ID

See: User#id

Session ID is present for all users. The ID specifies the current user session and will change when the user reconnects.

true when the user is suppressed due to lack of permissions.

The user will be suppressed by the server if they don't have permissions to speak on the current channel.

Emitted when the user disconnects

Also available through the client user-disconnect event.

Emitted when the user moves between channels.

Params

• oldChannel Channel - The channel where the user was moved from.
• newChannel Channel - The channel where the user was moved to.
• actor User - The user who moved the channel or undefined for server.

Emitted when the user is muted or unmuted by the server.

Params

• status Boolean - True when the user is muted, false when unmuted.

Also available through the client user-mute event.

Emitted when the user gains or loses priority speaker status.

Params

• status Boolean - True when the user gains priority speaker status. False when they lose it.

Also available through the client user-priority-speaker event.

Emitted when the user starts or stops recording.

Params

• status Boolean - True when the user starts recording. False when they stop.

Also available through the client user-recording event.

Emitted when the user deafens or undeafens themselves.

Params

• status Boolean - True when the user deafens themselves. False when undeafening.

Also available through the client user-self-deaf event.

Emitted when the user mutes or unmutes themselves.

Params

• status Boolean - True when the user mutes themselves. False when unmuting.

Also available through the client user-self-mute event.

Emitted when the user is suppressed or unsuppressed.

Params

• status Boolean - True when the user is suppressed. False when unsuppressed.

Also available through the client user-suppress event.