Class VoiceChannelEffect

java.lang.Object

net.dv8tion.jda.api.entities.channel.VoiceChannelEffect

public class VoiceChannelEffect
extends Object

Represents an emoji effect or a soundboard sound effect.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VoiceChannelEffect.Animation	Represents the animation of a voice channel effect.

Constructor Summary

Constructors

Constructor	Description
VoiceChannelEffect(VoiceChannel channel, long userId, EmojiUnion emoji, VoiceChannelEffect.Animation animation, long soundboardSoundId, double soundVolume)

Method Summary

Modifier and Type	Method	Description
VoiceChannelEffect.Animation	getAnimation()	The animation of the emoji, this is present for both emoji and soundboard sound effects.
VoiceChannel	getChannel()	The voice channel this effect was sent to.
EmojiUnion	getEmoji()	The emoji sent with the effect, this is present for both emoji and soundboard sound effects.
Member	getMember()	The member which sent this effect.
SoundboardSound	getSoundboardSound()	The soundboard sound sent with the effect, this is only present for guild soundboard sound effects.
String	getSoundboardSoundId()	The ID of the soundboard sound sent with the effect, this is only present for soundboard sound effects.
long	getSoundboardSoundIdLong()	The ID of the soundboard sound sent with the effect, this is only present for soundboard sound effects.
double	getSoundVolume()	The volume at which a soundboard sound was sent, this is 0 if this isn't a soundboard sound effect.
User	getUser()	The user which sent this effect.
String	getUserId()	The ID of the user which sent this effect.
long	getUserIdLong()	The user which sent this effect.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VoiceChannelEffect

public VoiceChannelEffect(VoiceChannel channel,
 long userId,
 EmojiUnion emoji,
 VoiceChannelEffect.Animation animation,
 long soundboardSoundId,
 double soundVolume)

Method Details

getChannel

@Nonnull
public VoiceChannel getChannel()

The voice channel this effect was sent to.

Returns:

The voice channel this effect was sent to.

getUserId

@Nonnull
public String getUserId()

The ID of the user which sent this effect.

Returns:

ID of the user which sent this effect.

getUserIdLong

public long getUserIdLong()

The user which sent this effect.

Returns:

ID of the user which sent this effect.

getUser

@Nullable
public User getUser()

The user which sent this effect.
This may be null if the user is not cached.

Returns:

The user which sent this effect, or null.

getMember

@Nullable
public Member getMember()

The member which sent this effect.
This may be null if the member is not cached.

Returns:

The member which sent this effect, or null.

getEmoji

@Nullable
public EmojiUnion getEmoji()

The emoji sent with the effect, this is present for both emoji and soundboard sound effects.

Returns:

The emoji sent with the effect, or null

getAnimation

@Nullable
public VoiceChannelEffect.Animation getAnimation()

The animation of the emoji, this is present for both emoji and soundboard sound effects.

Returns:

The animation of the emoji, or null

getSoundboardSoundId

@Nullable
public String getSoundboardSoundId()

The ID of the soundboard sound sent with the effect, this is only present for soundboard sound effects.

Returns:

The soundboard sound ID, or null

getSoundboardSoundIdLong

public long getSoundboardSoundIdLong()

The ID of the soundboard sound sent with the effect, this is only present for soundboard sound effects.

Returns:

The soundboard sound ID, or 0

getSoundboardSound

@Nullable
public SoundboardSound getSoundboardSound()

The soundboard sound sent with the effect, this is only present for guild soundboard sound effects.
This may be null for default sounds or uncached guild sounds, you can use getSoundboardSoundId() in these cases.

Returns:

The soundboard sound sent with the effect, or null

getSoundVolume

public double getSoundVolume()

The volume at which a soundboard sound was sent, this is 0 if this isn't a soundboard sound effect.

Returns:

The soundboard sound's volume, or 0