AudioSampleRate

Enum AudioSampleRate 

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

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§

Source§

impl AudioSampleRate

Source

pub const fn as_hz(self) -> i32

Get the sample rate in Hz

Source

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§

Source§

impl Clone for AudioSampleRate

Source§

fn clone(&self) -> AudioSampleRate

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AudioSampleRate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AudioSampleRate

Source§

fn default() -> AudioSampleRate

Returns the “default value” for a type. Read more
Source§

impl Display for AudioSampleRate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<AudioSampleRate> for i32

Source§

fn from(rate: AudioSampleRate) -> Self

Converts to this type from the input type.
Source§

impl Hash for AudioSampleRate

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for AudioSampleRate

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for AudioSampleRate

Source§

impl Eq for AudioSampleRate

Source§

impl StructuralPartialEq for AudioSampleRate

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.