Struct bevy_kira_components::sources::audio_file::AudioFileSettings

pub struct AudioFileSettings {
    pub start_paused: bool,
    pub volume: f64,
    pub playback_rate: f64,
    pub panning: f64,
    pub loop_region: Option<Region>,
    pub play_region: Region,
    pub reverse: bool,
}

Settings available to the user when instantiating an audio file.

Fields

start_paused: bool

By default, sounds will start playing right away when inserted. Setting this to true prevents that.

volume: f64

Volume at which the audio will play at.

playback_rate: f64

The playback rate of the sound.

Changing the playback rate changes both the speed and the pitch of the sound.

panning: f64

Panning (in 0..=1) for the sound, where 0 is hard left, and 1 is hard right.

loop_region: Option<Region>

Optionally loop a region of the sound (given in seconds)

play_region: Region

Only play a specific region of the file

reverse: bool

Play the file in reverse (not available for streaming sound files)

Trait Implementations

impl Component for AudioFileSettings

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its [ComponentHooks].

impl Debug for AudioFileSettings

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

Formats the value using the given formatter.

impl Default for AudioFileSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AudioFileSettings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AudioFileSettings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.