pub const AUDIO_FRAME_RATE: usize = 50;Number of audio frames/packets to be sent per second.
+pub const CHILD_BUFFER_LEN: usize = _; // 25usizeMaximum number of audio frames/packets to be sent per second to be buffered.
+pub const DEFAULT_BITRATE: Bitrate;Default bitrate for audio.
+pub const FRAME_LEN_MS: usize = _; // 20usizeLength (in milliseconds) of any audio frame.
+pub const MONO_FRAME_BYTE_SIZE: usize = _; // 3_840usizeNumber of bytes in one complete frame of raw f32-encoded mono audio.
pub const MONO_FRAME_SIZE: usize = _; // 960usizeNumber of samples in one complete frame of audio per channel.
+pub const RTP_PROFILE_TYPE: RtpType;Profile type used by Discord’s Opus audio traffic.
+pub const RTP_PROFILE_TYPE: RtpType;Profile type used by Discord’s Opus audio traffic.
pub const RTP_VERSION: u8 = 2;The one (and only) RTP version.
+pub const SAMPLE_RATE: SampleRate;Sample rate of audio to be sent to Discord.
+pub const SAMPLE_RATE: SampleRate;Sample rate of audio to be sent to Discord.
pub const SAMPLE_RATE_RAW: usize = 48_000;Sample rate of audio to be sent to Discord.
+pub const SILENT_FRAME: [u8; 3];Opus silent frame, used to signal speech start and end (and prevent audio glitching).
+pub const STEREO_FRAME_BYTE_SIZE: usize = _; // 7_680usizeNumber of bytes in one complete frame of raw f32-encoded stereo audio.
pub const STEREO_FRAME_SIZE: usize = _; // 1_920usizeNumber of individual samples in one complete frame of stereo audio.
+pub const TIMESTEP_LENGTH: Duration;Length of time between any two audio frames.
+pub const UDP_KEEPALIVE_GAP: Duration;Type-converted delay between sends of UDP keepalive frames.
+pub const UDP_KEEPALIVE_GAP_MS: u64 = 5_000;Delay between sends of UDP keepalive frames.
+pub const VOICE_GATEWAY_VERSION: u8 = crate::model::constants::GATEWAY_VERSION; // 4u8The voice gateway version used by the library.
+pub const VOICE_PACKET_MAX: usize = 1460;Maximum packet size for a voice packet.
+Constants affecting driver function and API handling.
+Constants affecting driver function and API handling.
f32-encoded mono audio.f32-encoded stereo audio.pub enum Bitrate {
+Bitrate in songbird::driver - Rust Enum Bitrate
pub enum Bitrate {
BitsPerSecond(i32),
Max,
Auto,
diff --git a/current/songbird/driver/enum.Channels.html b/current/songbird/driver/enum.Channels.html
index e4fbd8e32..6f04e5593 100644
--- a/current/songbird/driver/enum.Channels.html
+++ b/current/songbird/driver/enum.Channels.html
@@ -1,4 +1,4 @@
-Channels in songbird::driver - Rust #[non_exhaustive]pub enum Channels {
+Channels in songbird::driver - Rust #[non_exhaustive]pub enum Channels {
Mono,
Stereo,
}
Expand description
The channel layout of output audio when using DecodeMode::Decode.
diff --git a/current/songbird/driver/enum.CryptoMode.html b/current/songbird/driver/enum.CryptoMode.html
index 7682d56d8..468b66c91 100644
--- a/current/songbird/driver/enum.CryptoMode.html
+++ b/current/songbird/driver/enum.CryptoMode.html
@@ -1,4 +1,4 @@
-CryptoMode in songbird::driver - Rust #[non_exhaustive]pub enum CryptoMode {
+CryptoMode in songbird::driver - Rust #[non_exhaustive]pub enum CryptoMode {
Aes256Gcm,
XChaCha20Poly1305,
Normal,
diff --git a/current/songbird/driver/enum.DecodeMode.html b/current/songbird/driver/enum.DecodeMode.html
index 1dfe30b08..716e820a5 100644
--- a/current/songbird/driver/enum.DecodeMode.html
+++ b/current/songbird/driver/enum.DecodeMode.html
@@ -1,4 +1,4 @@
-DecodeMode in songbird::driver - Rust #[non_exhaustive]pub enum DecodeMode {
+DecodeMode in songbird::driver - Rust #[non_exhaustive]pub enum DecodeMode {
Pass,
Decrypt,
Decode,
diff --git a/current/songbird/driver/enum.MixMode.html b/current/songbird/driver/enum.MixMode.html
index 977d3814f..0ce26fc06 100644
--- a/current/songbird/driver/enum.MixMode.html
+++ b/current/songbird/driver/enum.MixMode.html
@@ -1,4 +1,4 @@
-MixMode in songbird::driver - Rust pub enum MixMode {
+MixMode in songbird::driver - Rust pub enum MixMode {
Mono,
Stereo,
}
Expand description
Mixing behaviour for sent audio sources processed within the driver.
diff --git a/current/songbird/driver/enum.SampleRate.html b/current/songbird/driver/enum.SampleRate.html
index 55bcdc026..cf71c8dbb 100644
--- a/current/songbird/driver/enum.SampleRate.html
+++ b/current/songbird/driver/enum.SampleRate.html
@@ -1,4 +1,4 @@
-SampleRate in songbird::driver - Rust #[non_exhaustive]pub enum SampleRate {
+SampleRate in songbird::driver - Rust #[non_exhaustive]pub enum SampleRate {
Hz8000,
Hz12000,
Hz16000,
diff --git a/current/songbird/driver/enum.SchedulerError.html b/current/songbird/driver/enum.SchedulerError.html
index 433c4d244..1ac1d4183 100644
--- a/current/songbird/driver/enum.SchedulerError.html
+++ b/current/songbird/driver/enum.SchedulerError.html
@@ -1,4 +1,4 @@
-SchedulerError in songbird::driver - Rust #[non_exhaustive]pub enum SchedulerError {
+SchedulerError in songbird::driver - Rust #[non_exhaustive]pub enum SchedulerError {
Disconnected,
}
Expand description
Errors encountered when communicating with the internals of a Scheduler.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.§Disconnected
The scheduler exited or crashed while awating the request.
diff --git a/current/songbird/driver/enum.SchedulerMode.html b/current/songbird/driver/enum.SchedulerMode.html
index 8026a39bc..7a629ac2c 100644
--- a/current/songbird/driver/enum.SchedulerMode.html
+++ b/current/songbird/driver/enum.SchedulerMode.html
@@ -1,4 +1,4 @@
-SchedulerMode in songbird::driver - Rust #[non_exhaustive]pub enum SchedulerMode {
+SchedulerMode in songbird::driver - Rust #[non_exhaustive]pub enum SchedulerMode {
MaxPerThread(NonZeroUsize),
}
Expand description
Strategies for mapping live mixer tasks to individual threads.
Defaults to MaxPerThread(16).
diff --git a/current/songbird/driver/index.html b/current/songbird/driver/index.html
index 915f2330e..f9d025006 100644
--- a/current/songbird/driver/index.html
+++ b/current/songbird/driver/index.html
@@ -1,4 +1,4 @@
-songbird::driver - Rust Expand description
Runner for a voice connection.
+songbird::driver - Rust Expand description
Runner for a voice connection.
Songbird’s driver is a mixed-sync system, using:
- Asynchronous connection management, event-handling, and gateway integration.
diff --git a/current/songbird/driver/retry/enum.Strategy.html b/current/songbird/driver/retry/enum.Strategy.html
index e0fd65d6f..e02e414fb 100644
--- a/current/songbird/driver/retry/enum.Strategy.html
+++ b/current/songbird/driver/retry/enum.Strategy.html
@@ -1,4 +1,4 @@
-Strategy in songbird::driver::retry - Rust #[non_exhaustive]pub enum Strategy {
+Strategy in songbird::driver::retry - Rust #[non_exhaustive]pub enum Strategy {
Every(Duration),
Backoff(ExponentialBackoff),
}
Expand description
Logic used to determine how long to wait between retry attempts.
diff --git a/current/songbird/driver/retry/index.html b/current/songbird/driver/retry/index.html
index 7e80c2405..265e6117e 100644
--- a/current/songbird/driver/retry/index.html
+++ b/current/songbird/driver/retry/index.html
@@ -1,2 +1,2 @@
-songbird::driver::retry - Rust Expand description
Configuration for connection retries.
+songbird::driver::retry - Rust ExponentialBackoff in songbird::driver::retry - Rust pub struct ExponentialBackoff {
+ExponentialBackoff in songbird::driver::retry - Rust pub struct ExponentialBackoff {
pub min: Duration,
pub max: Duration,
pub jitter: f32,
diff --git a/current/songbird/driver/retry/struct.Retry.html b/current/songbird/driver/retry/struct.Retry.html
index 4aff364f9..b0dd56e7e 100644
--- a/current/songbird/driver/retry/struct.Retry.html
+++ b/current/songbird/driver/retry/struct.Retry.html
@@ -1,4 +1,4 @@
-Retry in songbird::driver::retry - Rust pub struct Retry {
+Retry in songbird::driver::retry - Rust pub struct Retry {
pub strategy: Strategy,
pub retry_limit: Option<usize>,
}
Expand description
Configuration to be used for retrying driver connection attempts.
diff --git a/current/songbird/driver/static.DEFAULT_SCHEDULER.html b/current/songbird/driver/static.DEFAULT_SCHEDULER.html
index 556ceee59..132fd5fe5 100644
--- a/current/songbird/driver/static.DEFAULT_SCHEDULER.html
+++ b/current/songbird/driver/static.DEFAULT_SCHEDULER.html
@@ -1,4 +1,4 @@
-DEFAULT_SCHEDULER in songbird::driver - Rust pub static DEFAULT_SCHEDULER: Lazy<Scheduler>
Expand description
The default shared scheduler instance.
+DEFAULT_SCHEDULER in songbird::driver - Rust pub static DEFAULT_SCHEDULER: Lazy<Scheduler>
Expand description
The default shared scheduler instance.
This is built using the default value of ScheduleMode. Users desiring
a custom strategy should avoid calling Config::default.
Connect in songbird::driver - Rust pub struct Connect { /* private fields */ }
Expand description
Future for a call to Driver::connect.
+Connect in songbird::driver - Rust pub struct Connect { /* private fields */ }
Expand description
Future for a call to Driver::connect.
This future awaits the result of a connection; the driver
is messaged at the time of the call.
Trait Implementations§
Source§impl Future for Connect
Source§fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>
Attempts to resolve the future to a final value, registering
diff --git a/current/songbird/driver/struct.DisposalThread.html b/current/songbird/driver/struct.DisposalThread.html
index cad2c3601..ce10ad261 100644
--- a/current/songbird/driver/struct.DisposalThread.html
+++ b/current/songbird/driver/struct.DisposalThread.html
@@ -1,4 +1,4 @@
-DisposalThread in songbird::driver - Rust pub struct DisposalThread(/* private fields */);
Implementations§
Trait Implementations§
Source§impl Clone for DisposalThread
Source§fn clone(&self) -> DisposalThread
Returns a copy of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for DisposalThread
Auto Trait Implementations§
§impl Freeze for DisposalThread
§impl RefUnwindSafe for DisposalThread
§impl Send for DisposalThread
§impl Sync for DisposalThread
§impl Unpin for DisposalThread
§impl UnwindSafe for DisposalThread
Blanket Implementations§