Struct riddle_audio::Clip

pub struct Clip { /* fields omitted */ }

Stores the raw data of an audio file.

To play the clip construct a ClipPlayer using a ClipPlayerBuilder.

Example

let clip_bytes = include_bytes!("../../example_assets/boop.wav");
let clip = Clip::load(&clip_bytes[..], ClipFormat::Wav)?;

Implementations

impl Clip

pub fn load<R>(data: R, format: ClipFormat) -> Result<Clip, AudioError> where
    R: Read, 

Reads the entirety of the data reader in to memory.

An AudioError::ClipDecodeError value will be returned if the data isn’t a known format.

pub async fn load_async<R>(
    data: R,
    format: ClipFormat
) -> Result<Clip, AudioError> where
    R: AsyncRead + Unpin, 

Reads the entirety of the data reader in to memory, asynchronously.

An AudioError::ClipDecodeError value will be returned if the data isn’t a known format.

Example

let clip_bytes = include_bytes!("../../example_assets/boop.wav");
let clip = Clip::load_async(&clip_bytes[..], ClipFormat::Wav).await?;

pub fn duration(&self) -> Option<Duration>

Get the run time of the clip, if it can be determined.

Example

let clip_bytes = include_bytes!("../../example_assets/boop.wav");
let clip = Clip::load(&clip_bytes[..], ClipFormat::Wav)?;

assert!(clip.duration().unwrap() > std::time::Duration::from_secs(0));

Trait Implementations

impl Clone for Clip

fn clone(&self) -> Clip

Returns a copy of the value.

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

Performs copy-assignment from source.