Interfaces
Interfaces
116 public interfaces exported by hoshimi.
Interface116interfaceshoshimi0.5.5
Interfaces
116
ChannelDeleteInterfaceThe channel deleted data packet.ChannelDeletePacketInterfaceThe channel delete packet.ChannelMixSettingsInterfaceThe settings for the channel mix filter.ClientInfoInterfaceThe client data for the manager.CustomizableFiltersInterfaceCustom filters for Hoshimi: the key is the filter name, the value is the payload it takes. Extend this interface via module augmentation to get autocompletion for the name and a checked payload in `FilterManager.set` / `FilterManager.get`. Registering the filter is a separate, optional step that buys envelope routing and node validation; this only adds types.CustomizableFilterSettingsInterfaceCustom top-level filter settings for Hoshimi. Extend this interface via module augmentation to declare typed top-level filter keys provided by a fork (e.g. Nodelink) or by code that integrates with Hoshimi. Runtime registration via {@link FilterRegistry} works without augmenting this interface; augmentation only adds compile-time autocompletion and type-checking for the new keys.CustomizablePlayerStorageInterfaceInterface representing the customizable player storage.CustomizablePluginCapabilitiesInterfaceCustom plugin capabilities for Hoshimi. Extend this interface via module augmentation to provide custom capabilities.CustomizablePluginNamesInterfaceCustom plugin names for Hoshimi. Extend this interface via module augmentation to provide custom plugin names with autocompletion.CustomizablePluginPayloadsInterfaceCustom plugin filter payloads for Hoshimi. Extend this interface via module augmentation to declare typed plugin payload keys (either nested under a plugin name, e.g. `"my-plugin"`, or flat filter keys placed directly under `pluginFilters`). Runtime registration via {@link FilterRegistry} works without augmenting this interface; augmentation only adds compile-time autocompletion and type-checking for the new keys.CustomizableSourcesInterfaceCustom sources for Hoshimi. Extend this interface via module augmentation to provide custom sources/search sources.CustomizableStructuresInterfaceCustom structures for Hoshimi.CustomizableTrackInterfaceInterface representing an extendable track.DecodeMethodsInterfaceThe methods for decoding base64 encoded tracks.DestroyOptionsInterfaceDisconnectPlayerActionsInterfaceThe options for error actions.DistortionSettingsInterfaceThe settings for the distortion filter.EchoSettingsInterfaceThe settings for the echo filter.EmptyResultInterfaceThe empty result.EQBandSettingsInterfaceThe band settings for the equalizer.ErrorPlayerActionsInterfaceThe options for actions taken when a track throws an error.ErrorResultInterfaceThe error result.ExceptionInterfaceThe exception of the result.FetchOptionsInterfaceThe fetch options for the request.FilterPayloadsInterfaceThe payload each built-in filter takes, used to type `FilterManager.set` and `FilterManager.get`. Keep an entry per {@link FilterType} member. A name missing from here (and from `CustomizableFilters`) resolves to `unknown`, which is what lets unregistered filters be set with any payload. Note `Echo` and `DSPXEcho` differ: both are written to the wire as `echo`, but the `lavalink-filter-plugin` one takes `{delay, decay }` and the `lavadspx-plugin` one `{echoLength, decay }`.FilterPluginPassSettingsInterfaceFilterRegistrationInterfaceRegistration options for a filter.FilterSettingsInterfaceThe options for the filters.FreqSettingsInterfaceThe settings for frequency-based filters.GatewayPayloadInterfaceGateway payload.GatewaySendPayloadInterfaceGateway send payload.HoshimiEventsInterfaceThe events for the manager.HoshimiNodeOptionsInterfaceThe manager node options.HoshimiOptionsInterfaceThe options for the manager.HoshimiPlayerOptionsInterfaceThe Hoshimi player options.HoshimiQueueOptionsInterfaceThe queue options.HoshimiRestOptionsInterfaceThe rest options.KaraokeSettingsInterfaceThe settings for the karaoke filter.LavalinkFilterPluginEchoSettingsInterfaceThe settings for the echo filter in plugins.LavalinkFilterPluginReverbSettingsInterfaceThe settings for the reverb filter in plugins.LavalinkFilterPluginSettingsInterfaceThe settings for the lavalink filter plugin.LavalinkPlayerInterfaceThe player response from the Lavalink REST API.LavalinkPlayerStateInterfaceThe state of the player.LavalinkPlayOptionsInterfaceThe options for playing a track with Lavalink.LavalinkRestErrorInterfaceThe error for the REST.LavalinkSessionInterfaceThe updated session of the current session.LavalinkTrackInterfaceThe track.LowPassSettingsInterfaceThe settings for the low pass filter.LyricsFoundEventInterfaceThe event for when lyrics are found.LyricsLineInterfaceThe interface of the node lyrics line.LyricsLineEventInterfaceThe event for when a lyrics line is sent.LyricsMethodsInterfaceThe lyrics methods for the player.LyricsNotFoundEventInterfaceThe event for when lyrics are not found.LyricsResultInterfaceThe interface of the node lyrics result.NodeCpuInterfaceThe node cpu information.NodeDestroyInfoInterfaceThe interface of the node destroy object.NodeFrameStatsInterfaceThe node frame stats.NodeHeartbeatOptionsInterfaceThe heartbeat options for liveness detection.NodeInfoInterfaceThe information of the node.NodeInfoGitInterfaceThe git information of the node.NodeInfoPluginInterfaceThe plugin information of the node.NodeInfoVersionInterfaceThe information of the node version.NodeJSONInterfaceThe interface of the node json object.NodeMemoryInterfaceThe node memory information.NodeOptionsInterfaceThe node options.NodePlayerMoveOptionsInterfaceNodeSessionOptionsInterfaceThe node session options.NormalizationSettingsInterfaceThe settings for the normalization filter.ParsedQueryInterfaceInterface representing a parsed query with an explicit source prefix.PlayerEventInterfaceThe base interface for player events.PlayerJSONInterfaceThe JSON representation of the player.PlayerOptionsInterfaceThe options for the player.PlayerUpdateInterfaceThe update for the player state.PlayerUpdateStateInterfacePlayerVoiceInterfacePlaylistInterfaceThe playlist information.PlaylistInfoInterfacePlaylistResultInterfaceThe playlist result.PlayOptionsInterfaceThe options for playing a track.PluginFilterSettingsInterfaceThe settings for plugin filters.PluginInfoInterfaceThe plugin information.PluginRegistrationInterfaceRegistration options for a plugin.QueryResultInterfaceThe manager search result.QueueJSONInterfaceThe queue json.ReadyInterfaceThe ready event for the node.RestOptionsInterfaceThe options for the REST.ResumableHeadersInterfaceThe headers for resumable requests.RotationSettingsInterfaceThe settings for the rotation filter.SearchOptionsInterfaceThe query options.SearchQueryInterfaceThe search query to use.SearchResultInterfaceThe search result.SessionResumingOptionsInterfaceThe options for resuming a session.SetFilterOptionsInterfaceOptions for `FilterManager.set`, controlling where the payload is written and whether the node is checked for support. | given | envelope | `validate` default | | --- | --- | --- | | nothing, registered filter | whatever the registry resolves | `true` | | nothing, unknown filter | `pluginFilters[name]` (flat) | `false` | | `plugin: true` | `pluginFilters[name]` (flat) | `false` | | `plugin: "some-plugin"` | `pluginFilters["some-plugin"][name]` | `false` | | `top: true` | `filters[name]` (top level) | `false` | Passing a routing option always wins over the registry, so an explicit envelope can be forced for a registered name too.SkipOptionsInterfaceSourceRegistrationInterfaceRegistration options for a source.StatsInterfaceThe stats event for the node.StopOptionsInterfaceSyncOptionsInterfaceThe sync options for the queue.TimescaleSettingsInterfaceThe settings for the timescale filter.TrackEndEventInterfaceThe event for when a track ends.TrackExceptionEventInterfaceThe event for when a track encounters an exception.TrackInfoInterfaceThe track information.TrackJSONInterfaceThe type for any lavalink track, including partial and unresolved tracks.TrackResultInterfaceThe track result.TrackStartEventInterfaceThe event for when a track starts playing.TrackStuckEventInterfaceThe event for when a track gets stuck.TremoloSettingsInterfaceTypedEmitterInterfaceThe typed surface of the emitter. Class representing an event emitter described by a map, where an unknown event name is a compile error and a listener's parameters are inferred.UnresolvedLavalinkTrackInterfaceUpdatePlayerInfoInterfaceThe options to update the player.ValidateFilterOptionsInterfaceOptions for validating that a node can host a registered filter.ValidatePluginsOptionsInterfaceOptions for validating that a node has the required plugin capabilities.VoicePacketInterfaceThe voice packet.VoiceServerInterfaceThe voice server packet.VoiceStateInterfaceThe voice state packet.WebSocketClosedEventInterfaceThe event for when the WebSocket connection is closed.