Class Teamspeak::Client
In: lib/teamspeak-ruby/client.rb
Parent: Object

Methods

command   connect   disconnect   login   new  

Constants

SPECIAL_CHARS = [ ['\\\\', '\\'], ['\\/', '/'], ['\\s', ' '], ['\\p', '|'], ['\\a', '\a'], ['\\b', '\b'], ['\\f', '\f'], ['\\n', '\n'], ['\\r', '\r'], ['\\t', '\t'], ['\\v', '\v']   First is escaped char, second is real char.

Attributes

flood_limit  [W]  Number of commands within flood_time before pausing. Default is 10
flood_protection  [W]  Should commands be throttled? Default is true
flood_time  [W]  Length of time before flood_limit is reset in seconds. Default is 3
sock  [R]  access the raw socket

Public Class methods

new(host = 'localhost', port = 10_011)

Initializes Client 

  connect('voice.domain.com', 88888)

Public Instance methods

command(cmd, params = {}, options = '')

Sends command to the TeamSpeak 3 server and returns the response 

  command('use', {'sid' => 1}, '-away')
connect(host = 'localhost', port = 10_011)

Connects to a TeamSpeak 3 server 

  connect('voice.domain.com', 88888)
disconnect()

Disconnects from the TeamSpeak 3 server

login(user, pass)

Authenticates with the TeamSpeak 3 server 

  login('serveradmin', 'H8YlK1f9')

[Validate]