Enum SoundBuffer

pub enum SoundBuffer {
    Generic(GenericBuffer),
    Streaming(StreamingBuffer),
}

Sound buffer is a data source for sound sources. See module documentation for more info.

Variants

Generic(GenericBuffer)

General-purpose buffer, usually contains all the data and allows random access to samples. It is also used to make streaming buffer via composition.

Streaming(StreamingBuffer)

Buffer that will be filled by small portions of data only when it is needed. Ideal for large sounds (music, ambient, etc.), because unpacked PCM data takes very large amount of RAM. Allows random access only to currently loaded block, so in general there is no true random access.

Implementations

impl SoundBuffer

pub const GENERIC_F_0: &'static str = "Generic@0"

pub const STREAMING_F_0: &'static str = "Streaming@0"

impl SoundBuffer

pub fn raw_streaming(data_source: DataSource) -> Result<SoundBuffer, DataSource>

Tries to create new streaming sound buffer from a given data source. It returns raw sound buffer that has to be wrapped into Arc<Mutex<>> for use with sound sources.

pub fn raw_generic(data_source: DataSource) -> Result<SoundBuffer, DataSource>

Tries to create new generic sound buffer from a given data source. It returns raw sound buffer that has to be wrapped into Arc<Mutex<>> for use with sound sources.

Methods from Deref<Target = GenericBuffer>

pub const SAMPLES: &'static str = "samples"

pub const CHANNEL_COUNT: &'static str = "channel_count"

pub const SAMPLE_RATE: &'static str = "sample_rate"

pub const CHANNEL_DURATION_IN_SAMPLES: &'static str = "channel_duration_in_samples"

pub fn is_empty(&self) -> bool

Checks if buffer is empty or not.

pub fn samples(&self) -> &[f32]

Returns shared reference to an array with samples.

pub fn samples_mut(&mut self) -> &mut [f32]

Returns mutable reference to an array with samples that could be modified.

pub fn channel_count(&self) -> usize

Returns exact amount of channels in the buffer.

pub fn sample_rate(&self) -> usize

Returns sample rate of the buffer.

pub fn duration(&self) -> Duration

Returns exact time length of the buffer.

pub fn channel_duration_in_samples(&self) -> usize

Returns exact duration of each channel (in samples) of the buffer. The returned value represents the entire length of each channel in the buffer, even if it is streaming and its content is not yet fully decoded.

Trait Implementations

impl Debug for SoundBuffer

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

Formats the value using the given formatter.

impl Default for SoundBuffer

fn default() -> SoundBuffer

Returns the “default value” for a type.

impl DerefMut for SoundBuffer

fn deref_mut(&mut self) -> &mut <SoundBuffer as Deref>::Target

Returns mutable reference to generic buffer for any enum variant. It is possible because streaming sound buffers are built on top of generic buffers.

impl Reflect for SoundBuffer

where SoundBuffer: 'static, GenericBuffer: Reflect, StreamingBuffer: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<SoundBuffer>) -> Box<dyn Any>

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&(dyn Any + 'static)))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Any + 'static)))

fn as_reflect(&self, func: &mut dyn FnMut(&(dyn Reflect + 'static)))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Reflect + 'static)))

fn fields(&self, func: &mut dyn FnMut(&[&(dyn Reflect + 'static)]))

fn fields_mut( &mut self, func: &mut dyn FnMut(&mut [&mut (dyn Reflect + 'static)]), )

fn field( &self, name: &str, func: &mut dyn FnMut(Option<&(dyn Reflect + 'static)>), )

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut (dyn Reflect + 'static)>), )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl ResourceData for SoundBuffer

fn type_uuid(&self) -> Uuid

Returns unique data type id.

fn save(&mut self, _path: &Path) -> Result<(), Box<dyn Error>>

Saves the resource data a file at the specified path. This method is free to decide how the resource data is saved. This is needed, because there are multiple formats that defines various kinds of resources. For example, a rectangular texture could be saved into a bunch of formats, such as png, bmp, tga, jpg etc., but in the engine it is single Texture resource. In any case, produced file should be compatible with a respective resource loader.

fn can_be_saved(&self) -> bool

Returns true if the resource data can be saved to a file, false - otherwise. Not every resource type supports saving, for example there might be temporary resource type that is used only at runtime which does not need saving at all.

impl TypeUuidProvider for SoundBuffer

fn type_uuid() -> Uuid

Return type UUID.

impl Visit for SoundBuffer

where GenericBuffer: Visit, StreamingBuffer: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl Deref for SoundBuffer

fn deref(&self) -> &<SoundBuffer as Deref>::Target

Returns shared reference to generic buffer for any enum variant. It is possible because streaming sound buffers are built on top of generic buffers.

type Target = GenericBuffer

The resulting type after dereferencing.