diff --git a/current/songbird/all.html b/current/songbird/all.html index 96d15dbde..1f1b131aa 100644 --- a/current/songbird/all.html +++ b/current/songbird/all.html @@ -1 +1 @@ -List of all items in this crate

List of all items

Structs

Enums

Traits

Functions

Type Aliases

Statics

Constants

\ No newline at end of file +List of all items in this crate

List of all items

Structs

Enums

Traits

Functions

Type Aliases

Statics

Constants

\ No newline at end of file diff --git a/current/songbird/constants/constant.AUDIO_FRAME_RATE.html b/current/songbird/constants/constant.AUDIO_FRAME_RATE.html index d261969af..8216d8b9d 100644 --- a/current/songbird/constants/constant.AUDIO_FRAME_RATE.html +++ b/current/songbird/constants/constant.AUDIO_FRAME_RATE.html @@ -1,2 +1,2 @@ -AUDIO_FRAME_RATE in songbird::constants - Rust
songbird::constants

Constant AUDIO_FRAME_RATE

Source 
pub const AUDIO_FRAME_RATE: usize = 50;
Expand description

Number of audio frames/packets to be sent per second.

+AUDIO_FRAME_RATE in songbird::constants - Rust
songbird::constants

Constant AUDIO_FRAME_RATE

Source 
pub const AUDIO_FRAME_RATE: usize = 50;
Expand description

Number of audio frames/packets to be sent per second.

\ No newline at end of file diff --git a/current/songbird/constants/constant.CHILD_BUFFER_LEN.html b/current/songbird/constants/constant.CHILD_BUFFER_LEN.html index d09e8eef8..0fea6cb56 100644 --- a/current/songbird/constants/constant.CHILD_BUFFER_LEN.html +++ b/current/songbird/constants/constant.CHILD_BUFFER_LEN.html @@ -1,2 +1,2 @@ -CHILD_BUFFER_LEN in songbird::constants - Rust
songbird::constants

Constant CHILD_BUFFER_LEN

Source 
pub const CHILD_BUFFER_LEN: usize = _; // 25usize
Expand description

Maximum number of audio frames/packets to be sent per second to be buffered.

+CHILD_BUFFER_LEN in songbird::constants - Rust
songbird::constants

Constant CHILD_BUFFER_LEN

Source 
pub const CHILD_BUFFER_LEN: usize = _; // 25usize
Expand description

Maximum number of audio frames/packets to be sent per second to be buffered.

\ No newline at end of file diff --git a/current/songbird/constants/constant.DEFAULT_BITRATE.html b/current/songbird/constants/constant.DEFAULT_BITRATE.html index 33988633c..7d356c8e5 100644 --- a/current/songbird/constants/constant.DEFAULT_BITRATE.html +++ b/current/songbird/constants/constant.DEFAULT_BITRATE.html @@ -1,2 +1,2 @@ -DEFAULT_BITRATE in songbird::constants - Rust
songbird::constants

Constant DEFAULT_BITRATE

Source 
pub const DEFAULT_BITRATE: Bitrate;
Expand description

Default bitrate for audio.

+DEFAULT_BITRATE in songbird::constants - Rust
songbird::constants

Constant DEFAULT_BITRATE

Source 
pub const DEFAULT_BITRATE: Bitrate;
Expand description

Default bitrate for audio.

\ No newline at end of file diff --git a/current/songbird/constants/constant.FRAME_LEN_MS.html b/current/songbird/constants/constant.FRAME_LEN_MS.html index 57ac8cb3b..2c89fb3db 100644 --- a/current/songbird/constants/constant.FRAME_LEN_MS.html +++ b/current/songbird/constants/constant.FRAME_LEN_MS.html @@ -1,2 +1,2 @@ -FRAME_LEN_MS in songbird::constants - Rust
songbird::constants

Constant FRAME_LEN_MS

Source 
pub const FRAME_LEN_MS: usize = _; // 20usize
Expand description

Length (in milliseconds) of any audio frame.

+FRAME_LEN_MS in songbird::constants - Rust
songbird::constants

Constant FRAME_LEN_MS

Source 
pub const FRAME_LEN_MS: usize = _; // 20usize
Expand description

Length (in milliseconds) of any audio frame.

\ No newline at end of file diff --git a/current/songbird/constants/constant.MONO_FRAME_BYTE_SIZE.html b/current/songbird/constants/constant.MONO_FRAME_BYTE_SIZE.html index 0b3bab374..573b674ef 100644 --- a/current/songbird/constants/constant.MONO_FRAME_BYTE_SIZE.html +++ b/current/songbird/constants/constant.MONO_FRAME_BYTE_SIZE.html @@ -1,2 +1,2 @@ -MONO_FRAME_BYTE_SIZE in songbird::constants - Rust
songbird::constants

Constant MONO_FRAME_BYTE_SIZE

Source 
pub const MONO_FRAME_BYTE_SIZE: usize = _; // 3_840usize
Expand description

Number of bytes in one complete frame of raw f32-encoded mono audio.

+MONO_FRAME_BYTE_SIZE in songbird::constants - Rust
songbird::constants

Constant MONO_FRAME_BYTE_SIZE

Source 
pub const MONO_FRAME_BYTE_SIZE: usize = _; // 3_840usize
Expand description

Number of bytes in one complete frame of raw f32-encoded mono audio.

\ No newline at end of file diff --git a/current/songbird/constants/constant.MONO_FRAME_SIZE.html b/current/songbird/constants/constant.MONO_FRAME_SIZE.html index e457b8bba..a9573bf77 100644 --- a/current/songbird/constants/constant.MONO_FRAME_SIZE.html +++ b/current/songbird/constants/constant.MONO_FRAME_SIZE.html @@ -1,3 +1,3 @@ -MONO_FRAME_SIZE in songbird::constants - Rust
songbird::constants

Constant MONO_FRAME_SIZE

Source 
pub const MONO_FRAME_SIZE: usize = _; // 960usize
Expand description

Number of samples in one complete frame of audio per channel.

+MONO_FRAME_SIZE in songbird::constants - Rust
songbird::constants

Constant MONO_FRAME_SIZE

Source 
pub const MONO_FRAME_SIZE: usize = _; // 960usize
Expand description

Number of samples in one complete frame of audio per channel.

This is equally the number of stereo (joint) samples in an audio frame.

\ No newline at end of file diff --git a/current/songbird/constants/constant.RTP_PROFILE_TYPE.html b/current/songbird/constants/constant.RTP_PROFILE_TYPE.html index b1cd1fbbc..596e78a56 100644 --- a/current/songbird/constants/constant.RTP_PROFILE_TYPE.html +++ b/current/songbird/constants/constant.RTP_PROFILE_TYPE.html @@ -1,2 +1,2 @@ -RTP_PROFILE_TYPE in songbird::constants - Rust
songbird::constants

Constant RTP_PROFILE_TYPE

Source 
pub const RTP_PROFILE_TYPE: RtpType;
Expand description

Profile type used by Discord’s Opus audio traffic.

+RTP_PROFILE_TYPE in songbird::constants - Rust
songbird::constants

Constant RTP_PROFILE_TYPE

Source 
pub const RTP_PROFILE_TYPE: RtpType;
Expand description

Profile type used by Discord’s Opus audio traffic.

\ No newline at end of file diff --git a/current/songbird/constants/constant.RTP_VERSION.html b/current/songbird/constants/constant.RTP_VERSION.html index fa6fa9e1f..701800d67 100644 --- a/current/songbird/constants/constant.RTP_VERSION.html +++ b/current/songbird/constants/constant.RTP_VERSION.html @@ -1,2 +1,2 @@ -RTP_VERSION in songbird::constants - Rust
songbird::constants

Constant RTP_VERSION

Source 
pub const RTP_VERSION: u8 = 2;
Expand description

The one (and only) RTP version.

+RTP_VERSION in songbird::constants - Rust
songbird::constants

Constant RTP_VERSION

Source 
pub const RTP_VERSION: u8 = 2;
Expand description

The one (and only) RTP version.

\ No newline at end of file diff --git a/current/songbird/constants/constant.SAMPLE_RATE.html b/current/songbird/constants/constant.SAMPLE_RATE.html index e92b1b513..b3e902ffa 100644 --- a/current/songbird/constants/constant.SAMPLE_RATE.html +++ b/current/songbird/constants/constant.SAMPLE_RATE.html @@ -1,2 +1,2 @@ -SAMPLE_RATE in songbird::constants - Rust
songbird::constants

Constant SAMPLE_RATE

Source 
pub const SAMPLE_RATE: SampleRate;
Expand description

Sample rate of audio to be sent to Discord.

+SAMPLE_RATE in songbird::constants - Rust
songbird::constants

Constant SAMPLE_RATE

Source 
pub const SAMPLE_RATE: SampleRate;
Expand description

Sample rate of audio to be sent to Discord.

\ No newline at end of file diff --git a/current/songbird/constants/constant.SAMPLE_RATE_RAW.html b/current/songbird/constants/constant.SAMPLE_RATE_RAW.html index 57979b58d..863431a38 100644 --- a/current/songbird/constants/constant.SAMPLE_RATE_RAW.html +++ b/current/songbird/constants/constant.SAMPLE_RATE_RAW.html @@ -1,2 +1,2 @@ -SAMPLE_RATE_RAW in songbird::constants - Rust
songbird::constants

Constant SAMPLE_RATE_RAW

Source 
pub const SAMPLE_RATE_RAW: usize = 48_000;
Expand description

Sample rate of audio to be sent to Discord.

+SAMPLE_RATE_RAW in songbird::constants - Rust
songbird::constants

Constant SAMPLE_RATE_RAW

Source 
pub const SAMPLE_RATE_RAW: usize = 48_000;
Expand description

Sample rate of audio to be sent to Discord.

\ No newline at end of file diff --git a/current/songbird/constants/constant.SILENT_FRAME.html b/current/songbird/constants/constant.SILENT_FRAME.html index 7a3a4ce46..aa5ea8972 100644 --- a/current/songbird/constants/constant.SILENT_FRAME.html +++ b/current/songbird/constants/constant.SILENT_FRAME.html @@ -1,2 +1,2 @@ -SILENT_FRAME in songbird::constants - Rust
songbird::constants

Constant SILENT_FRAME

Source 
pub const SILENT_FRAME: [u8; 3];
Expand description

Opus silent frame, used to signal speech start and end (and prevent audio glitching).

+SILENT_FRAME in songbird::constants - Rust
songbird::constants

Constant SILENT_FRAME

Source 
pub const SILENT_FRAME: [u8; 3];
Expand description

Opus silent frame, used to signal speech start and end (and prevent audio glitching).

\ No newline at end of file diff --git a/current/songbird/constants/constant.STEREO_FRAME_BYTE_SIZE.html b/current/songbird/constants/constant.STEREO_FRAME_BYTE_SIZE.html index fbe31c3bf..7eb05e352 100644 --- a/current/songbird/constants/constant.STEREO_FRAME_BYTE_SIZE.html +++ b/current/songbird/constants/constant.STEREO_FRAME_BYTE_SIZE.html @@ -1,2 +1,2 @@ -STEREO_FRAME_BYTE_SIZE in songbird::constants - Rust
songbird::constants

Constant STEREO_FRAME_BYTE_SIZE

Source 
pub const STEREO_FRAME_BYTE_SIZE: usize = _; // 7_680usize
Expand description

Number of bytes in one complete frame of raw f32-encoded stereo audio.

+STEREO_FRAME_BYTE_SIZE in songbird::constants - Rust
songbird::constants

Constant STEREO_FRAME_BYTE_SIZE

Source 
pub const STEREO_FRAME_BYTE_SIZE: usize = _; // 7_680usize
Expand description

Number of bytes in one complete frame of raw f32-encoded stereo audio.

\ No newline at end of file diff --git a/current/songbird/constants/constant.STEREO_FRAME_SIZE.html b/current/songbird/constants/constant.STEREO_FRAME_SIZE.html index 455ba562b..8da9d9606 100644 --- a/current/songbird/constants/constant.STEREO_FRAME_SIZE.html +++ b/current/songbird/constants/constant.STEREO_FRAME_SIZE.html @@ -1,2 +1,2 @@ -STEREO_FRAME_SIZE in songbird::constants - Rust
songbird::constants

Constant STEREO_FRAME_SIZE

Source 
pub const STEREO_FRAME_SIZE: usize = _; // 1_920usize
Expand description

Number of individual samples in one complete frame of stereo audio.

+STEREO_FRAME_SIZE in songbird::constants - Rust
songbird::constants

Constant STEREO_FRAME_SIZE

Source 
pub const STEREO_FRAME_SIZE: usize = _; // 1_920usize
Expand description

Number of individual samples in one complete frame of stereo audio.

\ No newline at end of file diff --git a/current/songbird/constants/constant.TIMESTEP_LENGTH.html b/current/songbird/constants/constant.TIMESTEP_LENGTH.html index 331dd34d2..897752321 100644 --- a/current/songbird/constants/constant.TIMESTEP_LENGTH.html +++ b/current/songbird/constants/constant.TIMESTEP_LENGTH.html @@ -1,2 +1,2 @@ -TIMESTEP_LENGTH in songbird::constants - Rust
songbird::constants

Constant TIMESTEP_LENGTH

Source 
pub const TIMESTEP_LENGTH: Duration;
Expand description

Length of time between any two audio frames.

+TIMESTEP_LENGTH in songbird::constants - Rust
songbird::constants

Constant TIMESTEP_LENGTH

Source 
pub const TIMESTEP_LENGTH: Duration;
Expand description

Length of time between any two audio frames.

\ No newline at end of file diff --git a/current/songbird/constants/constant.UDP_KEEPALIVE_GAP.html b/current/songbird/constants/constant.UDP_KEEPALIVE_GAP.html index 7896f07e1..8bb3fa66b 100644 --- a/current/songbird/constants/constant.UDP_KEEPALIVE_GAP.html +++ b/current/songbird/constants/constant.UDP_KEEPALIVE_GAP.html @@ -1,4 +1,4 @@ -UDP_KEEPALIVE_GAP in songbird::constants - Rust
songbird::constants

Constant UDP_KEEPALIVE_GAP

Source 
pub const UDP_KEEPALIVE_GAP: Duration;
Expand description

Type-converted delay between sends of UDP keepalive frames.

+UDP_KEEPALIVE_GAP in songbird::constants - Rust
songbird::constants

Constant UDP_KEEPALIVE_GAP

Source 
pub const UDP_KEEPALIVE_GAP: Duration;
Expand description

Type-converted delay between sends of UDP keepalive frames.

Passive monitoring of Discord itself shows that these fire every 5 seconds irrespective of outgoing UDP traffic.

\ No newline at end of file diff --git a/current/songbird/constants/constant.UDP_KEEPALIVE_GAP_MS.html b/current/songbird/constants/constant.UDP_KEEPALIVE_GAP_MS.html index 6a314f9b1..275e170b1 100644 --- a/current/songbird/constants/constant.UDP_KEEPALIVE_GAP_MS.html +++ b/current/songbird/constants/constant.UDP_KEEPALIVE_GAP_MS.html @@ -1,4 +1,4 @@ -UDP_KEEPALIVE_GAP_MS in songbird::constants - Rust
songbird::constants

Constant UDP_KEEPALIVE_GAP_MS

Source 
pub const UDP_KEEPALIVE_GAP_MS: u64 = 5_000;
Expand description

Delay between sends of UDP keepalive frames.

+UDP_KEEPALIVE_GAP_MS in songbird::constants - Rust
songbird::constants

Constant UDP_KEEPALIVE_GAP_MS

Source 
pub const UDP_KEEPALIVE_GAP_MS: u64 = 5_000;
Expand description

Delay between sends of UDP keepalive frames.

Passive monitoring of Discord itself shows that these fire every 5 seconds irrespective of outgoing UDP traffic.

\ No newline at end of file diff --git a/current/songbird/constants/constant.VOICE_GATEWAY_VERSION.html b/current/songbird/constants/constant.VOICE_GATEWAY_VERSION.html index d3df6003d..b5cb09b1a 100644 --- a/current/songbird/constants/constant.VOICE_GATEWAY_VERSION.html +++ b/current/songbird/constants/constant.VOICE_GATEWAY_VERSION.html @@ -1,2 +1,2 @@ -VOICE_GATEWAY_VERSION in songbird::constants - Rust
songbird::constants

Constant VOICE_GATEWAY_VERSION

Source 
pub const VOICE_GATEWAY_VERSION: u8 = crate::model::constants::GATEWAY_VERSION; // 4u8
Expand description

The voice gateway version used by the library.

+VOICE_GATEWAY_VERSION in songbird::constants - Rust
songbird::constants

Constant VOICE_GATEWAY_VERSION

Source 
pub const VOICE_GATEWAY_VERSION: u8 = crate::model::constants::GATEWAY_VERSION; // 4u8
Expand description

The voice gateway version used by the library.

\ No newline at end of file diff --git a/current/songbird/constants/constant.VOICE_PACKET_MAX.html b/current/songbird/constants/constant.VOICE_PACKET_MAX.html index 81fc88419..c6380e35e 100644 --- a/current/songbird/constants/constant.VOICE_PACKET_MAX.html +++ b/current/songbird/constants/constant.VOICE_PACKET_MAX.html @@ -1,3 +1,3 @@ -VOICE_PACKET_MAX in songbird::constants - Rust
songbird::constants

Constant VOICE_PACKET_MAX

Source 
pub const VOICE_PACKET_MAX: usize = 1460;
Expand description

Maximum packet size for a voice packet.

+VOICE_PACKET_MAX in songbird::constants - Rust
songbird::constants

Constant VOICE_PACKET_MAX

Source 
pub const VOICE_PACKET_MAX: usize = 1460;
Expand description

Maximum packet size for a voice packet.

Set a safe amount below the Ethernet MTU to avoid fragmentation/rejection.

\ No newline at end of file diff --git a/current/songbird/constants/index.html b/current/songbird/constants/index.html index 997aed0e3..76fbec2bd 100644 --- a/current/songbird/constants/index.html +++ b/current/songbird/constants/index.html @@ -1,2 +1,2 @@ -songbird::constants - Rust
songbird

Module constants

Source
Expand description

Constants affecting driver function and API handling.

+songbird::constants - Rust
songbird

Module constants

Source
Expand description

Constants affecting driver function and API handling.

Constants§

\ No newline at end of file diff --git a/current/songbird/driver/enum.Bitrate.html b/current/songbird/driver/enum.Bitrate.html index 7fda56ed9..bf460f491 100644 --- a/current/songbird/driver/enum.Bitrate.html +++ b/current/songbird/driver/enum.Bitrate.html @@ -1,4 +1,4 @@ -Bitrate in songbird::driver - Rust
songbird::driver

Enum Bitrate

pub enum Bitrate {
+Bitrate in songbird::driver - Rust
songbird::driver
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 fe78af5ab..14b843e6f 100644
--- a/current/songbird/driver/enum.Channels.html
+++ b/current/songbird/driver/enum.Channels.html
@@ -1,4 +1,4 @@
-Channels in songbird::driver - Rust
songbird::driver
Enum Channels
Source 
#[non_exhaustive]
pub enum Channels {
+Channels in songbird::driver - Rust
songbird::driver
Enum Channels
Source 
#[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 b12d8520a..6f9f70626 100644
--- a/current/songbird/driver/enum.CryptoMode.html
+++ b/current/songbird/driver/enum.CryptoMode.html
@@ -1,4 +1,4 @@
-CryptoMode in songbird::driver - Rust
songbird::driver
Enum CryptoMode
Source 
#[non_exhaustive]
pub enum CryptoMode {
+CryptoMode in songbird::driver - Rust
songbird::driver
Enum CryptoMode
Source 
#[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 cdc7a1af6..94a2ba8c2 100644
--- a/current/songbird/driver/enum.DecodeMode.html
+++ b/current/songbird/driver/enum.DecodeMode.html
@@ -1,4 +1,4 @@
-DecodeMode in songbird::driver - Rust
songbird::driver
Enum DecodeMode
Source 
#[non_exhaustive]
pub enum DecodeMode {
+DecodeMode in songbird::driver - Rust
songbird::driver
Enum DecodeMode
Source 
#[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 3d1b9c593..438fb592c 100644
--- a/current/songbird/driver/enum.MixMode.html
+++ b/current/songbird/driver/enum.MixMode.html
@@ -1,4 +1,4 @@
-MixMode in songbird::driver - Rust
songbird::driver
Enum MixMode
Source 
pub enum MixMode {
+MixMode in songbird::driver - Rust
songbird::driver
Enum MixMode
Source 
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 9c1481f1b..30ef0a7a2 100644
--- a/current/songbird/driver/enum.SampleRate.html
+++ b/current/songbird/driver/enum.SampleRate.html
@@ -1,4 +1,4 @@
-SampleRate in songbird::driver - Rust
songbird::driver
Enum SampleRate
Source 
#[non_exhaustive]
pub enum SampleRate {
+SampleRate in songbird::driver - Rust
songbird::driver
Enum SampleRate
Source 
#[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 90d7c16ea..76c695914 100644
--- a/current/songbird/driver/enum.SchedulerError.html
+++ b/current/songbird/driver/enum.SchedulerError.html
@@ -1,4 +1,4 @@
-SchedulerError in songbird::driver - Rust
songbird::driver
Enum SchedulerError
Source 
#[non_exhaustive]
pub enum SchedulerError {
+SchedulerError in songbird::driver - Rust
songbird::driver
Enum SchedulerError
Source 
#[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 309c7fb85..d0592029d 100644
--- a/current/songbird/driver/enum.SchedulerMode.html
+++ b/current/songbird/driver/enum.SchedulerMode.html
@@ -1,4 +1,4 @@
-SchedulerMode in songbird::driver - Rust
songbird::driver
Enum SchedulerMode
Source 
#[non_exhaustive]
pub enum SchedulerMode {
+SchedulerMode in songbird::driver - Rust
songbird::driver
Enum SchedulerMode
Source 
#[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 97a0d51f2..a57db23a8 100644
--- a/current/songbird/driver/index.html
+++ b/current/songbird/driver/index.html
@@ -1,4 +1,4 @@
-songbird::driver - Rust
songbird
Module driver
Source 
Expand description
Runner for a voice connection.

+songbird::driver - Rust
songbird
Module driver
Source 
Expand description
Runner for a voice connection.

 
Songbird’s driver is a mixed-sync system, using: