Class: Discordrb::VoiceRegion

Inherits:

Object

• Object
• Discordrb::VoiceRegion

Defined in:

lib/discordrb/data/voice_region.rb

Overview

Voice regions are the locations of servers that handle voice communication in Discord

Instance Attribute Summary

• #custom ⇒ true, false readonly

  Whether this is a custom voice region (used for events/etc).

• #deprecated ⇒ true, false readonly

  Whether this is a deprecated voice region (avoid switching to these).

• #id ⇒ String (also: #to_s) readonly

  Unique ID for the region.

• #name ⇒ String readonly

  Name of the region.

• #optimal ⇒ true, false readonly

  If this voice server is the closest to the client.

• #sample_hostname ⇒ String readonly

  An example hostname for the region.

• #sample_port ⇒ Integer readonly

  An example port for the region.

• #vip ⇒ true, false readonly

  If this is a VIP-only server.

Instance Attribute Details

#custom ⇒ true, false (readonly)

# File 'lib/discordrb/data/voice_region.rb', line 29

def custom
  @custom
end

#deprecated ⇒ true, false (readonly)

# File 'lib/discordrb/data/voice_region.rb', line 26

def deprecated
  @deprecated
end

#id ⇒ String (readonly) Also known as: to_s

# File 'lib/discordrb/data/voice_region.rb', line 7

def id
  @id
end

#name ⇒ String (readonly)

# File 'lib/discordrb/data/voice_region.rb', line 11

def name
  @name
end

#optimal ⇒ true, false (readonly)

# File 'lib/discordrb/data/voice_region.rb', line 23

def optimal
  @optimal
end

#sample_hostname ⇒ String (readonly)

# File 'lib/discordrb/data/voice_region.rb', line 14

def sample_hostname
  @sample_hostname
end

#sample_port ⇒ Integer (readonly)

# File 'lib/discordrb/data/voice_region.rb', line 17

def sample_port
  @sample_port
end

#vip ⇒ true, false (readonly)

# File 'lib/discordrb/data/voice_region.rb', line 20

def vip
  @vip
end