Uses of Interface
com.craftmend.openaudiomc.api.clients.Client
Packages that use 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
Methods in com.craftmend.openaudiomc.api that return ClientModifier and TypeMethodDescription@Nullable ClientGet a client by a player UUID, or null if the player is not online or not registered yetMethods in com.craftmend.openaudiomc.api that return types with arguments of type ClientModifier and TypeMethodDescription@NotNull Collection<Client>ClientApi.getAllClients()Get all clients that are currently known to the serverMethods in com.craftmend.openaudiomc.api with parameters of type ClientModifier and TypeMethodDescriptionvoidVoiceApi.addStaticPeer(Client client, Client peerToAdd, boolean visible, boolean mutual) Add a peer (partner) to someone's voice chat.voidVoiceApi.addStaticPeer(Client client, Client peerToAdd, boolean visible, boolean mutual, DisplayOverride displayOverride) Add a peer (partner) to someone's voice chat.voidMediaApi.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 channelbooleanRegister a client as a voice-chat peerbooleanRegister a client as a voice-chat peervoidPlay a media for a clientvoidMediaApi.preloadMedia(Client client, Media media, boolean keepCopy) Force a client to preload a media, so it's ready to play when needed.voidMediaApi.preloadMediaSource(Client client, String mediaSource, boolean keepCopy) Force a client to preload a media source, so it's ready to play when needed.voidVoiceApi.removeStaticPeer(Client client, Client peerToRemove, boolean mutual) Remove a global peer from someone's voice chat.voidStop all media (except regions and speakers) for a clientvoidStop all media (except regions and speakers) for a clientvoidStop a specific media by ID for a clientvoidStop a specific media by ID for a clientvoidVoiceApi.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 ClientMethods in com.craftmend.openaudiomc.api.channels with parameters of type ClientModifier and TypeMethodDescriptionvoidAdd a member to the channelVoiceChannel.joinPreconditionCheck(Client client) Check if a client would be allowed to join this channelvoidVoiceChannel.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 ClientModifier and TypeMethodDescriptionvoidClient.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 ClientModifier and TypeMethodDescriptionClientEvent.getClient()Get the client that this event is aboutConstructors in com.craftmend.openaudiomc.api.events with parameters of type ClientModifierConstructorDescriptionCancellableClientEvent(Client client) Create a new client eventClientEvent(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 ClientConstructors in com.craftmend.openaudiomc.api.events.client with parameters of type ClientModifierConstructorDescriptionClientConnectEvent(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