Enum AudioSampleRate 

#[repr(i32)]
pub enum AudioSampleRate {
    Rate8000 = 8_000,
    Rate16000 = 16_000,
    Rate24000 = 24_000,
    Rate48000 = 48_000,
}

Audio sample rate for capture

ScreenCaptureKit supports a fixed set of sample rates. Using values outside this set will result in the system defaulting to 48000 Hz.

Examples

use screencapturekit::stream::configuration::audio::AudioSampleRate;

// Get the Hz value
assert_eq!(AudioSampleRate::Rate48000.as_hz(), 48000);

// Use default (48000 Hz)
let rate = AudioSampleRate::default();
assert_eq!(rate, AudioSampleRate::Rate48000);

Variants

Rate8000 = 8_000

8000 Hz - Low quality, suitable for telephony

Rate16000 = 16_000

16000 Hz - Speech quality

Rate24000 = 24_000

24000 Hz - Medium quality

Rate48000 = 48_000

48000 Hz - Professional audio quality (default)

Implementations

impl AudioSampleRate

pub const fn as_hz(self) -> i32

Get the sample rate in Hz

pub const fn from_hz(hz: i32) -> Option<Self>

Create from Hz value, returning None if unsupported

Examples

use screencapturekit::stream::configuration::audio::AudioSampleRate;

assert_eq!(AudioSampleRate::from_hz(48000), Some(AudioSampleRate::Rate48000));
assert_eq!(AudioSampleRate::from_hz(44100), None); // Not supported

Trait Implementations

impl Clone for AudioSampleRate

fn clone(&self) -> AudioSampleRate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for AudioSampleRate

impl Debug for AudioSampleRate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AudioSampleRate

fn default() -> AudioSampleRate

Returns the “default value” for a type.

impl Display for AudioSampleRate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for AudioSampleRate

impl From<AudioSampleRate> for i32

fn from(rate: AudioSampleRate) -> Self

Converts to this type from the input type.

impl Hash for AudioSampleRate

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AudioSampleRate

fn eq(&self, other: &AudioSampleRate) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AudioSampleRate