Package moe.kyokobot.koe

Interface KoeEventListener

All Known Implementing Classes:

EventDispatcher, KoeEventAdapter

public interface KoeEventListener

Method Summary

Modifier and Type	Method	Description
void	externalIPDiscovered(InetSocketAddress address)
void	gatewayClosed(int code, String reason, boolean byRemote)	Called when the gateway connection is closed.
void	gatewayError(Throwable cause)
void	gatewayReady(InetSocketAddress target, int ssrc)
void	sessionDescription(JsonObject session)
void	userDisconnected(String id)	Called when one or more users have disconnected from the voice channel.
void	usersConnected(List<String> userIds)	Called when one or more users have connected to the voice channel.
void	userStreamsChanged(String id, int audioSSRC, int videoSSRC, int rtxSSRC)	Called when the stream information for a user has changed.

Method Details

gatewayError

void gatewayError(Throwable cause)

gatewayReady

void gatewayReady(InetSocketAddress target,
 int ssrc)

gatewayClosed

void gatewayClosed(int code,
 @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.

userStreamsChanged

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

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

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

void externalIPDiscovered(InetSocketAddress address)

sessionDescription

void sessionDescription(JsonObject session)