Channel - Rantanen/node-mumble GitHub Wiki

Params

• data Object - Channel data.
• client MumbleClient - Mumble client that owns the channel.

Single channel on the server.

• Channel(data, client)
  • Methods
    • addSubChannel(name, options)
    • getPermissions(callback)
    • join()
    • remove()
    • sendMessage(message)
  • Properties
    • children
    • links
    • users
  • Events
    • 'links-add' (newChannels)
    • 'links-remove' (linksRemove)
    • 'move' (oldParent, newParent)
    • 'permissions-update' (query)
    • 'remove'

Adds a sub-channel to the current channel.

Params

• name string - New sub-channel name.
• options Object - Channel options.

Retrieves the channel permissions

Params

• callback function - Result callback

Join the channel

Removes the current channel.

Sends a message to the channel.

Params

• message string - The message to send.

Child channels

Linked channels

Users in the channel

Emitted when this channel is linked to new ones.

Params

• newChannels Array.<Channel> - The newly linked channels.

Also available through the client channel-links-add event.

Emitted when channel links are removed.

Params

• linksRemove Array.<Channel> - The removed channels.

Also available through the client channel-links-remove event.

Emitted when the channel is moved in the channel hierarchy.

Params

• oldParent Channel - Old parent channel.
• newParent Channel - New parent channel.

Also available through the client channel-move event.

Emitted when the channel permissions are updated.

Params

• query Permissions - The new permissions

Also available through the client channel-permissions-update event.

Emitted when the channel is removed from the channel tree.

Descripion: Also available through the client channel-remove event.