Crate hydrolink

Crate hydrolink 

Source

Structs§

CPU
Statistics related to Lavalink server CPU usage.
ChannelMix
Mixes both channels (left and right), with a configurable factor on how much each channel affects the other. With the defaults, both channels are kept independent of each other. Setting all factors to 0.5 means both channels get the same audio.
Details
Details about the Route Planner used by the Lavalink server.
Distortion
Distortion effect. It can generate some pretty unique audio effects.
Equalizer
There are 15 bands (0-14) that can be changed. gain is the multiplier for the given band. The default value is 0. Valid values range from -0.25 to 1.0, where -0.25 means the given band is completely muted, and 0.25 means it is doubled. Modifying the gain could also change the volume of the output.
ErrorResponse
Error response returned by Lavalink Server REST API.
Exception
An exception/error produced by the Lavalink server.
FailingAddress
Information about a failed IP address and when it happened.
Filters
Audio filters natively supported by Lavalink.
FrameStats
Statistics related to the connections between Lavalink server and Discord.
Git
Information about the branch and commit used to build the Lavalink server.
IPBlock
IP block information.
Info
Lavalink server information.
Karaoke
Uses equalization to eliminate part of a band, usually targeting vocals.
Lavalink
REST client used to access Lavalink API calls that are not dependent on a session or WebSocket connection.
LowPass
Higher frequencies get suppressed, while lower frequencies pass through this filter, thus the name low pass. Any smoothing values equal to, or less than 1.0 will disable the filter.
Memory
Statistics related to Lavalink server RAM memory usage.
Player
A Lavalink Player associated with a guild and a session.
PlayerState
Player state in the Lavalink server.
PlayerUpdate
Response sent every x seconds by Lavalink about the player state of a guild.
PlaylistInfo
Information about the playlist.
Plugin
Plugin used by Lavalink to extend its functions.
Ready
Response sent by Lavalink when the connection is established.
Rotation
Rotates the sound around the stereo channels/user headphones aka Audio Panning. It can produce an effect similar to https://youtu.be/QB9EB8mTKcc (without the reverb).
RoutePlannerFailedAddress
Request to unmark an IP address failed.
RoutePlannerStatus
Response sent by Lavalink server about Route Planner status.
Session
Lavalink client used to send calls and receive messages from the Lavalink server.
Stats
Lavalink server statistics.
Timescale
Changes the speed, pitch, and rate. All default to 1.0.
Track
A single audio track.
TrackEndEvent
Information about the track that was finished.
TrackExceptionEvent
Emitted when an exception/error occurs while playing a track.
TrackInfo
Information about an audio track.
TrackLoading
Response for a load track request.
TrackStartEvent
Information about the track that was started.
TrackStuckEvent
Emitted when a song is stuck.
Tremolo
Uses amplification to create a shuddering effect, where the volume quickly oscillates.
UpdatePlayer
Request used by the update_player function to update the player on the Lavalink server.
UpdateSession
Request and response used by the update_session function.
Version
Parsed Semantic Versioning 2.0.0. See https://semver.org/ for more info.
Vibrato
VoiceState
Discord client/bot voice state, this will be used by the Lavalink server to connect to the voice chat.
WebSocketClosedEvent
Emitted as soon as any connection between the Lavalink server and Discord is closed, which can be normal or abnormal.

Enums§

Error
Enum that groups all the errors that can occur.
IPBlockType
IP block type/version.
LoadResultType
The type of result that was loaded.
RoutePlannerType
The type/strategy used by the Lavalink server’s Route Planner.
Severity
The severity level of the exception.
TrackEndReason
The reason why a track was finished.

Constants§

VERSION

Traits§

Handler
Event handler used by the Websocket message parser.

Type Aliases§

Result
Just a Result with the error type set to hydrolink::Error.