Struct SamplerNode 

pub struct SamplerNode {
    pub sample: Option<ArcGc<dyn SampleResource>>,
    pub volume: Volume,
    pub play: Notify<bool>,
    pub play_from: PlayFrom,
    pub repeat_mode: RepeatMode,
    pub speed: f64,
    pub mono_to_stereo: bool,
    pub crossfade_on_seek: bool,
    pub min_gain: f32,
}

A node that plays samples

It supports pausing, resuming, looping, and changing the playback speed.

Fields

sample: Option<ArcGc<dyn SampleResource>>

The sample resource to use.

volume: Volume

The volume to play the sample at.

Note, this gain parameter is NOT smoothed! If you need the gain to be smoothed, please use a VolumeNode or a VolumePanNode.

play: Notify<bool>

Whether or not the current sample should start/restart playing (true), or be paused/stopped (false).

play_from: PlayFrom

Defines where the sampler should start playing from when SamplerNode::play is set to true.

repeat_mode: RepeatMode

How many times a sample should be repeated.

speed: f64

The speed at which to play the sample at. 1.0 means to play the sound at its original speed, < 1.0 means to play the sound slower (which will make it lower-pitched), and > 1.0 means to play the sound faster (which will make it higher-pitched).

mono_to_stereo: bool

If true, then mono samples will be converted to stereo during playback.

By default this is set to true.

crossfade_on_seek: bool

If true, then samples will be crossfaded when the playhead or sample is changed (if a sample was currently playing when the event was sent).

By default this is set to true.

min_gain: f32

If the resutling gain (in raw amplitude, not decibels) is less than or equal to this value, then the gain will be clamped to 0.0 (silence).

By default this is set to 0.00001 (-100 decibels).

Implementations

impl SamplerNode

pub fn set_sample(&mut self, sample: ArcGc<dyn SampleResource>)

Set the parameters to a play a single sample.

pub fn sync_sample_event(&self) -> NodeEventType

Returns an event type to sync the sample parameter.

pub fn sync_volume_event(&self) -> NodeEventType

Returns an event type to sync the volume parameter.

pub fn sync_play_event(&self) -> NodeEventType

Returns an event type to sync the play parameter.

pub fn sync_play_from_event(&self) -> NodeEventType

Returns an event type to sync the play_from parameter.

pub fn sync_repeat_mode_event(&self) -> NodeEventType

Returns an event type to sync the playhead parameter.

pub fn sync_speed_event(&self) -> NodeEventType

Returns an event type to sync the speed parameter.

pub fn start_or_restart(&mut self)

Start/restart the sample in this node.

If a sample is already playing, then it will restart from the beginning.

pub fn start_from(&mut self, from: PlayFrom)

Play the sample in this node from the given playhead.

pub fn pause(&mut self)

Pause sample playback.

pub fn resume(&mut self)

Resume sample playback.

pub fn stop(&mut self)

Stop sample playback.

Calling SamplerNode::resume after this will restart the sample from the beginning.

pub fn start_or_restart_requested(&self) -> bool

Returns true if the current state is set to restart the sample.

pub fn resume_requested(&self) -> bool

Returns true if the current state is set to resume the sample.

pub fn pause_requested(&self) -> bool

Returns true if the current state is set to pause the sample.

pub fn stop_requested(&self) -> bool

Returns true if the current state is set to stop the sample.

Trait Implementations

impl AudioNode for SamplerNode

type Configuration = SamplerConfig

A type representing this constructor’s configuration.

fn info(&self, config: &Self::Configuration) -> AudioNodeInfo

Get information about this node.

fn construct_processor( &self, config: &Self::Configuration, cx: ConstructProcessorContext<'_>, ) -> impl AudioNodeProcessor

Construct a realtime processor for this node.

fn update(&mut self, configuration: &Self::Configuration, cx: UpdateContext<'_>)

If AudioNodeInfo::call_update_method was set to true, then the Firewheel context will call this method on every update cycle.

impl Clone for SamplerNode

fn clone(&self) -> SamplerNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for SamplerNode

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for SamplerNode

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

Formats the value using the given formatter.

impl Default for SamplerNode

fn default() -> Self

Returns the “default value” for a type.

impl Diff for SamplerNode

where Option<ArcGc<dyn SampleResource>>: Diff, Volume: Diff, Notify<bool>: Diff, PlayFrom: Diff, RepeatMode: Diff, f64: Diff, bool: Diff, f32: Diff,

fn diff<__E: EventQueue>( &self, baseline: &Self, path: PathBuilder, event_queue: &mut __E, )

Compare self to baseline and generate events to resolve any differences.

impl PartialEq for SamplerNode

fn eq(&self, other: &SamplerNode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Patch for SamplerNode

where Option<ArcGc<dyn SampleResource>>: Patch, Volume: Patch, Notify<bool>: Patch, PlayFrom: Patch, RepeatMode: Patch, f64: Patch, bool: Patch, f32: Patch,

type Patch = SamplerNodePatch

A type’s patch.

fn patch(data: &ParamData, path: &[u32]) -> Result<Self::Patch, PatchError>

Construct a patch from a parameter event.

fn apply(&mut self, patch: Self::Patch)

Apply a patch.

fn patch_event(event: &NodeEventType) -> Option<Self::Patch>

Construct a patch from a node event.

impl StructuralPartialEq for SamplerNode