API Reference
Public TypeScript exports from hoshimi 0.5.6-dev-34608641094.0.
Browse by type
Classes
Class27
DSPXPluginFilterFilterManagerHoshimiLavalinkPluginFilterLyricsManagerFunctions
Function3
createHoshimidefineFilterresumeByLibraryInterfaces
Interface116
ChannelDeleteChannelDeletePacketChannelMixSettingsClientInfoCustomizableFiltersType Aliases
Type63
AnyLavalinkTrackAwaitableCapabilityKeyCustomSearchSourcesCustomSourceNamesEnums
Enum26
AudioOutputDebugLevelsDestroyReasonsEventNamesFilterScopeVariables
Variable12
AudioOutputDataDefaultFilterPresetFilterRegistryHoshimiAgentHoshimiDefaultOptionsFeatured exports
HoshimiClassClass representing the Hoshimi manager.createHoshimiFunctionCreate a new Hoshimi instance.PlayerClassClass representing a Hoshimi player.QueueClassClass representing a queue.NodeClassClass representing a Lavalink node.NodeManagerClassClass representing a node manager.RestClassClass representing the REST for the node.TrackClassClass representing a Hoshimi track.FilterManagerClassClass representing a filter manager for a player. A filter is active when its key is present in the payload, and inactive when it is absent: there is no neutral "off" payload. {@link FilterManager.set} writes a key, {@link FilterManager.clear} removes it, and {@link FilterManager.isEnabled} is presence. {@link FilterRegistry} routes the filters it knows to their envelope (top level, flat `pluginFilters`, or nested under a plugin) and validates them against the node. Filters it does not know can still be set: their envelope comes from {@link SetFilterOptions} instead, so no registration is required. The commit/envelope internals live in {@link FilterPayload } (util/functions/filters), which takes the manager as an argument rather than through `this` — no private members, matching the project convention.LyricsManagerClassClass representing a LyricsManager.