Uses of Interface
com.craftmend.openaudiomc.api.clients.Client

Packages that use Client

Package	Description
com.craftmend.openaudiomc.api	The OpenAudioMc API
com.craftmend.openaudiomc.api.channels
com.craftmend.openaudiomc.api.clients	This package contains all the classes that are related to the client system.
com.craftmend.openaudiomc.api.events	This package contains our internal event system, which is used to listen to events that are fired by the OpenAudioMc Events provided by OA should be listened to through this system, not bukkit/spigot's event system because OA's events are cross-platform and can be fired from the web interface as well.
com.craftmend.openaudiomc.api.events.client	This package contains all events that are related to the client, such as the client connecting, disconnecting, or changing settings.

Uses of Client in com.craftmend.openaudiomc.api

Methods in com.craftmend.openaudiomc.api that return Client

Modifier and Type	Method	Description
@Nullable Client	ClientApi.getClient(UUID clientUuid)	Get a client by a player UUID, or null if the player is not online or not registered yet

Methods in com.craftmend.openaudiomc.api that return types with arguments of type Client

Modifier and Type	Method	Description
@NotNull Collection<Client>	ClientApi.getAllClients()	Get all clients that are currently known to the server

Methods in com.craftmend.openaudiomc.api with parameters of type Client

Modifier and Type	Method	Description
void	VoiceApi.addStaticPeer(Client client, Client peerToAdd, boolean visible, boolean mutual)	Add a peer (partner) to someone's voice chat.
void	VoiceApi.addStaticPeer(Client client, Client peerToAdd, boolean visible, boolean mutual, DisplayOverride displayOverride)	Add a peer (partner) to someone's voice chat.
void	MediaApi.clearPreloadedMedia(Client client)	Clear all preloaded media for a client, including entries with keepCopy set to true
VoiceChannel	VoiceApi.createChannel(String name, Client creator, boolean requiresPermission, @Nullable String requiredPermission)	Create a new channel
boolean	VoiceApi.hasPeer(Client haystack, Client needle)	Register a client as a voice-chat peer
boolean	VoiceApi.hasPeer(Client haystack, UUID needle)	Register a client as a voice-chat peer
boolean	VoiceApi.isClientModerating(Client client)	Check if a client has voicechat moderation enabled
void	MediaApi.playFor(@NotNull Media media, @NotNull Client... clients)	Play a media for a client
void	MediaApi.preloadMedia(Client client, Media media, boolean keepCopy)	Force a client to preload a media, so it's ready to play when needed.
void	MediaApi.preloadMediaSource(Client client, String mediaSource, boolean keepCopy)	Force a client to preload a media source, so it's ready to play when needed.
void	VoiceApi.removeStaticPeer(Client client, Client peerToRemove, boolean mutual)	Remove a global peer from someone's voice chat.
boolean	VoiceApi.startClientModeration(Client client)	Start a moderation session for a client, bypassing permission checks.
void	VoiceApi.stopClientModeration(Client client)	Stop a moderation session for a client
void	MediaApi.stopFor(int fadeTime, @NotNull Client... clients)	Stop all media (except regions and speakers) for a client
void	MediaApi.stopFor(@NotNull Client... clients)	Stop all media (except regions and speakers) for a client
void	MediaApi.stopFor(@NotNull String id, int fadeTime, @NotNull Client... clients)	Stop a specific media by ID for a client
void	MediaApi.stopFor(@NotNull String id, @NotNull Client... clients)	Stop a specific media by ID for a client
void	VoiceApi.updatePeerOptions(Client client, Client peerToUpdate, VoicePeerOptions options)	Push new options for a peer, changing how its rendered in the client

Uses of Client in com.craftmend.openaudiomc.api.channels

Methods in com.craftmend.openaudiomc.api.channels that return types with arguments of type Client

Modifier and Type	Method	Description
Collection<Client>	VoiceChannel.getMembers()	Get the members of the channel

Methods in com.craftmend.openaudiomc.api.channels with parameters of type Client

Modifier and Type	Method	Description
void	VoiceChannel.addMember(Client client)	Add a member to the channel
ChannelJoinResponse	VoiceChannel.joinPreconditionCheck(Client client)	Check if a client would be allowed to join this channel
void	VoiceChannel.removeMember(Client client)	Remove a member from the channel

Uses of Client in com.craftmend.openaudiomc.api.clients

Methods in com.craftmend.openaudiomc.api.clients with parameters of type Client

Modifier and Type	Method	Description
void	Client.kickProximityPeer(@NotNull Client otherClient)	Forcefully remove a player from my proximity chat peers.

Uses of Client in com.craftmend.openaudiomc.api.events

Methods in com.craftmend.openaudiomc.api.events that return Client

Modifier and Type	Method	Description
Client	ClientEvent.getClient()	Get the client that this event is about

Constructors in com.craftmend.openaudiomc.api.events with parameters of type Client

Modifier	Constructor	Description
	CancellableClientEvent(Client client)	Create a new client event
	ClientEvent(Client client)	Create a new client event

Uses of Client in com.craftmend.openaudiomc.api.events.client

Methods in com.craftmend.openaudiomc.api.events.client that return Client

Modifier and Type	Method	Description
Client	ClientPeerAddEvent.getPeer()
Client	ClientPeerRemovedEvent.getPeer()

Constructors in com.craftmend.openaudiomc.api.events.client with parameters of type Client

Modifier	Constructor	Description
	ClientConnectEvent(Client client)	Create a new client connect event, representing a client that has connected to the web client
	ClientDisconnectEvent(Client client)	Create a new client event that represents a client that has disconnected from the web client
	ClientEnableVoiceEvent(Client client)
	ClientPeerAddEvent(Client client, Client peer, VoicePeerOptions options)	Create a new client event
	ClientPeerRemovedEvent(Client client, Client peer)	Create a new client event
	MediaErrorEvent(Client client, String mediaSource, MediaError mediaError)	This event resembles an internal error in the web client (like bad or failed HTTP media requests).
	MicrophoneMuteEvent(Client client)	This is a simple event that gets called whenever a player explicitly mutes their microphone
	MicrophoneUnmuteEvent(Client client)	This is a simple event that gets called whenever a player explicitly unmutes their microphone
	VoicechatDeafenEvent(Client client)	This is a simple event that gets called whenever a player explicitly deafens their audio
	VoicechatReadyEvent(Client client)	Fired whenever a client is ready to use voicechat
	VoicechatUndeafenEvent(Client client)	This is a simple event that gets called whenever a player explicitly undeafens their audio