Enum MusicalTransport 

pub enum MusicalTransport {
    Static(StaticTransport),
    Dynamic(Arc<DynamicTransport>),
}

Variants

Static(StaticTransport)

A musical transport with a single static tempo in beats per minute.

Dynamic(Arc<DynamicTransport>)

A musical transport with multiple keyframes of tempo. The tempo immediately jumps from one keyframe to another (the tempo is NOT linearly interpolated between keyframes).

Implementations

impl MusicalTransport

pub fn beats_per_minute(&self) -> Option<f64>

Returns the beats per minute if this is of type MusicalTransport::Static, None otherwise.

pub fn musical_to_seconds( &self, musical: InstantMusical, transport_start: InstantSeconds, speed_multiplier: f64, ) -> InstantSeconds

Convert the time in musical beats to the corresponding time in seconds.

• musical - The time in musical beats to convert.
• transport_start - The instant of the start of the transport (musical time of 0).
• speed_multiplier - A multiplier for the playback speed. A value of 1.0 means no change in speed, a value less than 1.0 means a decrease in speed, and a value greater than 1.0 means an increase in speed.

pub fn musical_to_samples( &self, musical: InstantMusical, transport_start: InstantSamples, speed_multiplier: f64, sample_rate: NonZeroU32, ) -> InstantSamples

Convert the time in musical beats to the corresponding time in samples.

• musical - The time in musical beats to convert.
• transport_start - The instant of the start of the transport (musical time of 0).
• speed_multiplier - A multiplier for the playback speed. A value of 1.0 means no change in speed, a value less than 1.0 means a decrease in speed, and a value greater than 1.0 means an increase in speed.
• sample_rate - The sample rate of the stream.

pub fn seconds_to_musical( &self, seconds: InstantSeconds, transport_start: InstantSeconds, speed_multiplier: f64, ) -> InstantMusical

Convert the time in seconds to the corresponding time in musical beats.

• seconds - The time in seconds to convert.
• transport_start - The instant of the start of the transport (musical time of 0).
• speed_multiplier - A multiplier for the playback speed. A value of 1.0 means no change in speed, a value less than 1.0 means a decrease in speed, and a value greater than 1.0 means an increase in speed.
• sample_rate - The sample rate of the stream.

pub fn samples_to_musical( &self, sample_time: InstantSamples, transport_start: InstantSamples, speed_multiplier: f64, sample_rate: NonZeroU32, sample_rate_recip: f64, ) -> InstantMusical

Convert the time in samples to the corresponding time in musical beats.

• sample_time - The time in samples to convert.
• transport_start - The instant of the start of the transport (musical time of 0).
• speed_multiplier - A multiplier for the playback speed. A value of 1.0 means no change in speed, a value less than 1.0 means a decrease in speed, and a value greater than 1.0 means an increase in speed.
• sample_rate - The sample rate of the stream.
• sample_rate - The reciprocal of the sample rate.

pub fn delta_seconds_from( &self, from: InstantMusical, delta_seconds: DurationSeconds, speed_multiplier: f64, ) -> InstantMusical

Return the musical time that occurs delta_seconds seconds after the given from timestamp.

• speed_multiplier - A multiplier for the playback speed. A value of 1.0 means no change in speed, a value less than 1.0 means a decrease in speed, and a value greater than 1.0 means an increase in speed.

pub fn bpm_at_musical( &self, musical: InstantMusical, speed_multiplier: f64, ) -> f64

Return the tempo in beats per minute at the given musical time.

• speed_multiplier - A multiplier for the playback speed. A value of 1.0 means no change in speed, a value less than 1.0 means a decrease in speed, and a value greater than 1.0 means an increase in speed.

pub fn proc_transport_info( &self, frames: usize, playhead: InstantMusical, speed_multiplier: f64, sample_rate: NonZeroU32, ) -> ProcTransportInfo

Return information about this transport for this processing block.

• frames - The number of frames in this processing block.
• playhead - The current playhead of the transport at frame 0 in this processing block.
• speed_multiplier - A multiplier for the playback speed. A value of 1.0 means no change in speed, a value less than 1.0 means a decrease in speed, and a value greater than 1.0 means an increase in speed.
• sample_rate - The sample rate of the stream.

pub fn transport_start( &self, now: InstantSamples, playhead: InstantMusical, speed_multiplier: f64, sample_rate: NonZeroU32, ) -> InstantSamples

Return the instant the beginning of this transport (musical time of 0) occurs on.

• now - The current time in samples.
• playhead - The current playhead of the transport.
• speed_multiplier - A multiplier for the playback speed. A value of 1.0 means no change in speed, a value less than 1.0 means a decrease in speed, and a value greater than 1.0 means an increase in speed.
• sample_rate - The sample rate of the stream.

Trait Implementations

impl Clone for MusicalTransport

fn clone(&self) -> MusicalTransport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for MusicalTransport

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, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

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 map_entities<M: EntityMapper>(this: &mut Self, mapper: &mut M)

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]

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

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

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.

impl Debug for MusicalTransport

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

Formats the value using the given formatter.

impl PartialEq for MusicalTransport

fn eq(&self, other: &MusicalTransport) -> 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 StructuralPartialEq for MusicalTransport