Package net.dv8tion.jda.api.events.guild.voice

Class GuildVoiceStreamEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.guild.GenericGuildEvent

net.dv8tion.jda.api.events.guild.voice.GenericGuildVoiceEvent

net.dv8tion.jda.api.events.guild.voice.GuildVoiceStreamEvent

All Implemented Interfaces:

GenericEvent

public class GuildVoiceStreamEvent
extends GenericGuildVoiceEvent

Indicates that a Member started or ended a stream.

Can be used to detect when a user goes live or stops streaming.

Requirements

This event requires the VOICE_STATE CacheFlag to be enabled, which requires the GUILD_VOICE_STATES intent.
createLight(String) disables that CacheFlag by default!

Additionally, this event requires the MemberCachePolicy to cache the updated members. Discord does not specifically tell us about the updates, but merely tells us the member was updated and gives us the updated member object. In order to fire a specific event like this we need to have the old member cached to compare against.

Constructor Summary

Constructors

Constructor	Description
GuildVoiceStreamEvent(JDA api, long responseNumber, Member member, boolean stream)

Method Summary

Modifier and Type	Method	Description
boolean	isStream()	True if this user started streaming.

Methods inherited from class net.dv8tion.jda.api.events.guild.voice.GenericGuildVoiceEvent

getMember, getVoiceState

Methods inherited from class net.dv8tion.jda.api.events.guild.GenericGuildEvent

getGuild

Methods inherited from class net.dv8tion.jda.api.events.Event

getJDA, getResponseNumber

Methods inherited from class java.lang.Object

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

Constructor Detail

GuildVoiceStreamEvent

public GuildVoiceStreamEvent(@Nonnull
                             JDA api,
                             long responseNumber,
                             @Nonnull
                             Member member,
                             boolean stream)

Method Detail

isStream

public boolean isStream()

True if this user started streaming. False if the user stopped streaming.

Returns:

True, if the stream started