Struct SampleInfo

pub struct SampleInfo<'a> {
    pub index: u32,
    pub name: Option<Cow<'a, str>>,
    pub volume: ChannelVolumes,
    pub sample_spec: Spec,
    pub channel_map: Map,
    pub duration: MicroSeconds,
    pub bytes: u32,
    pub lazy: bool,
    pub filename: Option<Cow<'a, str>>,
    pub proplist: Proplist,
}

Stores information about sample cache entries.

Please note that this structure can be extended as part of evolutionary API updates at any time in any new release.

Fields

index: u32

Index of this entry.

name: Option<Cow<'a, str>>

Name of this entry.

volume: ChannelVolumes

Default volume of this entry.

sample_spec: Spec

Sample specification of the sample.

channel_map: Map

The channel map.

duration: MicroSeconds

Duration of this entry.

bytes: u32

Length of this sample in bytes.

lazy: bool

Non-zero when this is a lazy cache entry.

filename: Option<Cow<'a, str>>

In case this is a lazy cache entry, the filename for the sound file to be loaded on demand.

proplist: Proplist

Property list for this sample.

Implementations

impl SampleInfo<'_>

pub fn to_owned(&self) -> SampleInfo<'static>

Creates a copy with owned data.

Trait Implementations

impl<'a> Debug for SampleInfo<'a>

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

Formats the value using the given formatter.