Skip to main content

CaptureSession

Struct CaptureSession 

Source
pub struct CaptureSession {
    pub purpose: CapturePurpose,
    pub intent_granted: bool,
    pub sample_rate: u32,
    pub channels: u16,
    pub frames_captured: u64,
    pub live: bool,
    /* private fields */
}
Expand description

Session state — cold construction; pull path is lock-free enough for tests.

Fields§

§purpose: CapturePurpose§intent_granted: bool§sample_rate: u32§channels: u16§frames_captured: u64§live: bool

Implementations§

Source§

impl CaptureSession

Source

pub const RING_CAP: usize

Source

pub fn new(purpose: CapturePurpose, sample_rate: u32, channels: u16) -> Self

Creates a new instance.

Source

pub fn grant_intent(&mut self)

User/shell grants capture for this purpose (Webizen intent).

Source

pub fn revoke_intent(&mut self)

Revokes intent.

Source

pub fn start(&mut self) -> Result<(), AudioError>

Arm capture. Fails closed without intent.

Source

pub fn stop(&mut self)

Stops.

Source

pub fn push_mono(&mut self, samples: &[f32]) -> usize

Shell pushes mono PCM (device or file stream). Dropped if not live.

Source

pub fn pull_mono(&mut self, out: &mut [f32]) -> usize

Pull mono samples into out. Returns frames written.

Source

pub fn available(&self) -> usize

true when available.

Trait Implementations§

Source§

impl Clone for CaptureSession

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CaptureSession

Source§

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

Formats the value using the given formatter. Read more

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.