Package moe.kyokobot.koe

Interface KoeEventListener

All Known Implementing Classes:

EventDispatcher, KoeEventAdapter

public interface KoeEventListener

Method Summary

Modifier and Type	Method	Description
default void	externalIPDiscovered(InetSocketAddress address)
default void	gatewayClosed(int code, @Nullable String reason, boolean byRemote)	Called when the gateway connection is closed.
default void	gatewayError(Throwable cause)
default void	gatewayReady(InetSocketAddress target, int ssrc)
default void	sessionDescription(JsonObject session)
default void	sessionLost(int code, @Nullable String reason)	Called after gatewayClosed(int, java.lang.String, boolean) when the voice server no longer knows the session and Koe couldn't start a new one.
default void	userDisconnected(String id)	Called when one or more users have disconnected from the voice channel.
default void	usersConnected(List<String> userIds)	Called when one or more users have connected to the voice channel.
default void	userStreamsChanged(String id, int audioSSRC, int videoSSRC, int rtxSSRC)	Called when the stream information for a user has changed.

Method Details

gatewayError

default void gatewayError(Throwable cause)

gatewayReady

default void gatewayReady(InetSocketAddress target,
 int ssrc)

gatewayClosed

default void gatewayClosed(int code,
 @Nullable
 @Nullable String reason,
 boolean byRemote)

Called when the gateway connection is closed.

Parameters:

code - the WebSocket close code.

reason - the close reason if present, null otherwise.

byRemote - true if the connection was closed by the gateway, false if it was closed by Koe.

sessionLost

default void sessionLost(int code,
 @Nullable
 @Nullable String reason)

Called after gatewayClosed(int, java.lang.String, boolean) when the voice server no longer knows the session and Koe couldn't start a new one. Koe can't recover from this on its own, the bot has to rejoin the voice channel through the main gateway (opcode 4) to get a new session and pass the new server info to MediaConnection.connect(moe.kyokobot.koe.VoiceServerInfo).

Parameters:

code - the WebSocket close code.

reason - the close reason if present, null otherwise.

userStreamsChanged

default void userStreamsChanged(String id,
 int audioSSRC,
 int videoSSRC,
 int rtxSSRC)

Called when the stream information for a user has changed. Not state tracked by Koe, provides data from moe.kyokobot.koe.gateway.Op#USER_SPEAKING as-is.

Parameters:

id - the user ID of the user whose stream information has changed.

audioSSRC - the SSRC of the user's audio stream, or 0 if not present or just disabled.

videoSSRC - the SSRC of the user's video stream, or 0 if not present or just disabled.

rtxSSRC - the SSRC of the user's retransmission stream, or 0 if not present or just disabled.

usersConnected

default void usersConnected(List<String> userIds)

Called when one or more users have connected to the voice channel. Not state tracked by Koe, provides data from Op.CLIENT_CONNECT as-is.

Parameters:

userIds - the list of user IDs that have connected, as provided by the gateway.

userDisconnected

default void userDisconnected(String id)

Called when one or more users have disconnected from the voice channel. Not state tracked by Koe, provides data from Op.CLIENT_DISCONNECT as-is.

Parameters:

userIds - the list of user IDs that have disconnected, as provided by the gateway.

externalIPDiscovered

default void externalIPDiscovered(InetSocketAddress address)

sessionDescription

default void sessionDescription(JsonObject session)