Class: Discordrb::Voice::VoiceWS

Inherits:
Object
  • Object
show all
Defined in:
lib/discordrb/voice/network.rb

Overview

Represents a websocket client connection to the voice server. The websocket connection (sometimes called vWS) is used to manage general data about the connection, such as sending the speaking packet, which determines the green circle around users on Discord, and obtaining UDP connection info.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(channel, bot, token, session, endpoint) ⇒ VoiceWS

Makes a new voice websocket client, but doesn't connect it (see #connect for that)

Parameters:

  • channel (Channel) —

    The voice channel to connect to

  • bot (Bot) —

    The regular bot to which this vWS is bound

  • token (String) —

    The authentication token which is also used for REST requests

  • session (String) —

    The voice session ID Discord sends over the regular websocket

  • endpoint (String) —

    The endpoint URL to connect to



127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/discordrb/voice/network.rb', line 127

def initialize(channel, bot, token, session, endpoint)
  raise 'RbNaCl is unavailable - unable to create voice bot! Please read https://github.com/meew0/discordrb/wiki/Installing-libsodium' unless RBNACL_AVAILABLE

  @channel = channel
  @bot = bot
  @token = token
  @session = session

  @endpoint = endpoint.gsub(':80', '')

  @udp = VoiceUDP.new
end

Instance Attribute Details

#udp ⇒ VoiceUDP (readonly)

Returns the UDP voice connection over which the actual audio data is sent.

Returns:

  • (VoiceUDP) —

    the UDP voice connection over which the actual audio data is sent.



119
120
121
 
# File 'lib/discordrb/voice/network.rb', line 119

def udp
  @udp
end

Instance Method Details

#connect ⇒ Object

Communication goes like this: me discord | | websocket connect -> | | | | <- websocket opcode 2 | | UDP discovery -> | | | | <- UDP reply packet | | websocket opcode 1 -> | | | ...



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/discordrb/voice/network.rb', line 248

def connect
  # Connect websocket
  @thread = Thread.new do
    Thread.current[:discordrb_name] = 'vws'
    init_ws
  end

  @bot.debug('Started websocket initialization, now waiting for UDP discovery reply')

  # Now wait for opcode 2 and the resulting UDP reply packet
  ip, port = @udp.receive_discovery_reply
  @bot.debug("UDP discovery reply received! #{ip} #{port}")

  # Send UDP init packet with received UDP data
  send_udp_connection(ip, port, @udp_mode)

  @bot.debug('Waiting for op 4 now')

  # Wait for op 4, then finish
  sleep 0.05 until @ready
end

#destroy ⇒ Object

Disconnects the websocket and kills the thread



271
272
273
 
# File 'lib/discordrb/voice/network.rb', line 271

def destroy
  @heartbeat_running = false
end

#send_heartbeat ⇒ Object

Send a heartbeat (op 3), has to be done every @heartbeat_interval seconds or the connection will terminate



176
177
178
179
180
181
182
183
184
 
# File 'lib/discordrb/voice/network.rb', line 176

def send_heartbeat
  millis = Time.now.strftime('%s%L').to_i
  @bot.debug("Sending voice heartbeat at #{millis}")

  @client.send({
    op: 3,
    d: nil
  }.to_json)
end

#send_init(server_id, bot_user_id, session_id, token) ⇒ Object

Send a connection init packet (op 0)

Parameters:

  • server_id (Integer) —

    The ID of the server to connect to

  • bot_user_id (Integer) —

    The ID of the bot that is connecting

  • session_id (String) —

    The voice session ID

  • token (String) —

    The Discord authentication token



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/discordrb/voice/network.rb', line 145

def send_init(server_id, bot_user_id, session_id, token)
  @client.send({
    op: 0,
    d: {
      server_id: server_id,
      user_id: bot_user_id,
      session_id: session_id,
      token: token
    }
  }.to_json)
end

#send_speaking(value) ⇒ Object

Send a speaking packet (op 5). This determines the green circle around the avatar in the voice channel

Parameters:

  • value (true, false) —

    Whether or not the bot should be speaking



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/discordrb/voice/network.rb', line 188

def send_speaking(value)
  @bot.debug("Speaking: #{value}")
  @client.send({
    op: 5,
    d: {
      speaking: value,
      delay: 0
    }
  }.to_json)
end

#send_udp_connection(ip, port, mode) ⇒ Object

Sends the UDP connection packet (op 1)

Parameters:

  • ip (String) —

    The IP to bind UDP to

  • port (Integer) —

    The port to bind UDP to

  • mode (Object) —

    Which mode to use for the voice connection



161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/discordrb/voice/network.rb', line 161

def send_udp_connection(ip, port, mode)
  @client.send({
    op: 1,
    d: {
      protocol: 'udp',
      data: {
        address: ip,
        port: port,
        mode: mode
      }
    }
  }.to_json)
end