Skip to main content

WasmStreamingEncoder

Struct WasmStreamingEncoder 

Source
pub struct WasmStreamingEncoder { /* private fields */ }
Expand description

Encodes samples frame-by-frame as they arrive, returning encoded frames ready for transmission. Use this for low-latency streaming encoding where you push samples and pull frames.

Implementations§

Source§

impl WasmStreamingEncoder

Source

pub fn new(sample_rate: u32, channels: u8, bit_depth: u8) -> Self

Create a new streaming encoder

§Arguments
  • sample_rate - Sample rate in Hz (e.g., 44100)
  • channels - Number of channels (1 or 2)
  • bit_depth - Bits per sample (16, 24, or 32)
§Returns

New encoder instance

Source

pub fn with_compression(self, level: u8) -> Self

Set compression level (0-9)

§Arguments
  • level - Compression level (0=fast/large, 9=slow/small)
§Returns

Self for method chaining

Source

pub fn push_samples(&mut self, samples: &[f32]) -> Result<(), JsValue>

Push audio samples to the encoder

Samples should be interleaved if multi-channel (e.g., [L0, R0, L1, R1, …] for stereo). Frames are encoded automatically when enough samples accumulate.

§Arguments
  • samples - Interleaved f32 audio samples (-1.0 to 1.0)
§Returns

Error if encoding fails

Source

pub fn next_frame(&mut self) -> JsValue

Get the next encoded frame if available

Returns an object with: index, timestamp_ms, data (Uint8Array), samples Returns null if no frames are ready yet.

§Returns

Encoded frame object or null

Source

pub fn pending_samples(&self) -> usize

Get number of samples currently buffered

§Returns

Number of sample frames in buffer

Source

pub fn pending_frames(&self) -> usize

Get number of encoded frames ready for transmission

§Returns

Number of ready frames

Source

pub fn flush(&mut self) -> Result<(), JsValue>

Flush remaining samples and finalize encoding

Call this when done pushing samples. Encodes any remaining partial frame. After this, call finalize() to get the complete flo file.

§Returns

Error if encoding fails

Source

pub fn finalize( &mut self, metadata: Option<Vec<u8>>, ) -> Result<Vec<u8>, JsValue>

Build a complete flo file from all accumulated frames

Call flush() first, then this method to generate the complete file. The file will contain all encoded frames with proper table-of-contents.

§Arguments
  • metadata - Optional metadata bytes (MessagePack encoded, use create_metadata())
§Returns

Complete flo file as byte array

Trait Implementations§

Source§

impl Default for WasmStreamingEncoder

Available on crate feature wasm only.
Source§

fn default() -> Self

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

impl From<WasmStreamingEncoder> for JsValue

Source§

fn from(value: WasmStreamingEncoder) -> Self

Converts to this type from the input type.
Source§

impl FromWasmAbi for WasmStreamingEncoder

Source§

type Abi = WasmPtr<WasmRefCell<WasmStreamingEncoder>>

The Wasm ABI type that this converts from when coming back out from the ABI boundary.
Source§

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi. Read more
Source§

impl IntoWasmAbi for WasmStreamingEncoder

Source§

type Abi = WasmPtr<WasmRefCell<WasmStreamingEncoder>>

The Wasm ABI type that this converts into when crossing the ABI boundary.
Source§

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
Source§

impl LongRefFromWasmAbi for WasmStreamingEncoder

Source§

type Abi = WasmPtr<WasmRefCell<WasmStreamingEncoder>>

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRef<WasmStreamingEncoder>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl OptionFromWasmAbi for WasmStreamingEncoder

Source§

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.
Source§

impl OptionIntoWasmAbi for WasmStreamingEncoder

Source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
Source§

impl RefFromWasmAbi for WasmStreamingEncoder

Source§

type Abi = WasmPtr<WasmRefCell<WasmStreamingEncoder>>

The Wasm ABI type references to Self are recovered from.
Source§

type Anchor = RcRef<WasmStreamingEncoder>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.
Source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl RefMutFromWasmAbi for WasmStreamingEncoder

Source§

type Abi = WasmPtr<WasmRefCell<WasmStreamingEncoder>>

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRefMut<WasmStreamingEncoder>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl SupportsConstructor for WasmStreamingEncoder

Source§

impl SupportsInstanceProperty for WasmStreamingEncoder

Source§

impl SupportsStaticProperty for WasmStreamingEncoder

Source§

impl TryFromJsValue for WasmStreamingEncoder

Source§

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.
Source§

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.
Source§

impl VectorFromWasmAbi for WasmStreamingEncoder

Source§

impl VectorIntoWasmAbi for WasmStreamingEncoder

Source§

impl WasmDescribe for WasmStreamingEncoder

Source§

impl WasmDescribeVector for WasmStreamingEncoder

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> 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> ReturnWasmAbi for T
where T: IntoWasmAbi,

Source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
Source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more