Enum AudioChannelCount 

#[repr(i32)]
pub enum AudioChannelCount {
    Mono = 1,
    Stereo = 2,
}

Audio channel configuration for capture

ScreenCaptureKit supports mono (1 channel) or stereo (2 channels) audio. Using other values will result in the system defaulting to stereo.

Examples

use screencapturekit::stream::configuration::audio::AudioChannelCount;

// Get the channel count
assert_eq!(AudioChannelCount::Stereo.as_count(), 2);

// Use default (stereo)
let channels = AudioChannelCount::default();
assert_eq!(channels, AudioChannelCount::Stereo);

Variants

Mono = 1

Mono - single channel audio

Stereo = 2

Stereo - two channel audio (default)

Implementations

impl AudioChannelCount

pub const fn as_count(self) -> i32

Get the channel count as an integer

pub const fn from_count(count: i32) -> Option<Self>

Create from channel count, returning None if unsupported

Examples

use screencapturekit::stream::configuration::audio::AudioChannelCount;

assert_eq!(AudioChannelCount::from_count(2), Some(AudioChannelCount::Stereo));
assert_eq!(AudioChannelCount::from_count(6), None); // Not supported

Trait Implementations

impl Clone for AudioChannelCount

fn clone(&self) -> AudioChannelCount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioChannelCount

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

Formats the value using the given formatter.

impl Default for AudioChannelCount

fn default() -> AudioChannelCount

Returns the “default value” for a type.

impl Display for AudioChannelCount

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

Formats the value using the given formatter.

impl From<AudioChannelCount> for i32

fn from(count: AudioChannelCount) -> Self

Converts to this type from the input type.

impl Hash for AudioChannelCount

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 AudioChannelCount

fn eq(&self, other: &AudioChannelCount) -> 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 Copy for AudioChannelCount

impl Eq for AudioChannelCount

impl StructuralPartialEq for AudioChannelCount