Uses of Interface
com.craftmend.openaudiomc.api.clients.Client
Package
Description
The OpenAudioMc API
This package contains all the classes that are related to the client system.
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.
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
Modifier and TypeMethodDescription@Nullable Client
Get a client by a player UUID, or null if the player is not online or not registered yetModifier and TypeMethodDescription@NotNull Collection<Client>
ClientApi.getAllClients()
Get all clients that are currently known to the serverModifier and TypeMethodDescriptionvoid
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 trueVoiceApi.createChannel
(String name, Client creator, boolean requiresPermission, @Nullable String requiredPermission) Create a new channelboolean
Register a client as a voice-chat peerboolean
Register a client as a voice-chat peervoid
Play a media for a clientvoid
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.void
Stop all media (except regions and speakers) for a clientvoid
Stop all media (except regions and speakers) for a clientvoid
Stop a specific media by ID for a clientvoid
Stop a specific media by ID for a clientvoid
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
Modifier and TypeMethodDescriptionvoid
Add a member to the channelVoiceChannel.joinPreconditionCheck
(Client client) Check if a client would be allowed to join this channelvoid
VoiceChannel.removeMember
(Client client) Remove a member from the channel -
Uses of Client in com.craftmend.openaudiomc.api.clients
Modifier and TypeMethodDescriptionvoid
Client.kickProximityPeer
(@NotNull Client otherClient) Forcefully remove a player from my proximity chat peers. -
Uses of Client in com.craftmend.openaudiomc.api.events
Modifier and TypeMethodDescriptionClientEvent.getClient()
Get the client that this event is aboutModifierConstructorDescriptionCancellableClientEvent
(Client client) Create a new client eventClientEvent
(Client client) Create a new client event -
Uses of Client in com.craftmend.openaudiomc.api.events.client
ModifierConstructorDescriptionClientConnectEvent
(Client client) Create a new client connect event, representing a client that has connected to the web clientClientDisconnectEvent
(Client client) Create a new client event that represents a client that has disconnected from the web clientClientEnableVoiceEvent
(Client client) ClientPeerAddEvent
(Client client, Client peer, VoicePeerOptions options) Create a new client eventClientPeerRemovedEvent
(Client client, Client peer) Create a new client eventMediaErrorEvent
(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 microphoneMicrophoneUnmuteEvent
(Client client) This is a simple event that gets called whenever a player explicitly unmutes their microphoneVoicechatDeafenEvent
(Client client) This is a simple event that gets called whenever a player explicitly deafens their audioVoicechatReadyEvent
(Client client) Fired whenever a client is ready to use voicechatVoicechatUndeafenEvent
(Client client) This is a simple event that gets called whenever a player explicitly undeafens their audio