Struct TransportState 

pub struct TransportState {
    pub transport: Option<MusicalTransport>,
    pub playing: Notify<bool>,
    pub playhead: Notify<InstantMusical>,
    pub speed: TransportSpeed,
    pub stop_at: Option<InstantMusical>,
    pub loop_range: Option<Range<InstantMusical>>,
}

The state of the musical transport in a Firewheel context.

Fields

transport: Option<MusicalTransport>

The current musical transport.

playing: Notify<bool>

Whether or not the musical transport is playing (true) or is paused (false).

playhead: Notify<InstantMusical>

The playhead of the musical transport.

speed: TransportSpeed

A multiplier for the speed of the transport.

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.

stop_at: Option<InstantMusical>

If this is Some, then the transport will automatically stop when the playhead reaches the given musical time.

This has no effect if TransportState::loop_range is Some.

loop_range: Option<Range<InstantMusical>>

If this is Some, then the transport will continously loop the given region.

Implementations

impl TransportState

pub fn set_static_transport(&mut self, beats_per_minute: Option<f64>)

Set the transport to a single static tempo (StaticTransport).

If beats_per_minute is None, then this will set the transport to None.

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

Get the beats per minute of the current static transport.

Returns None if transport is None or if transport is not MusicalTransport::Static.

pub fn set_speed_multiplier( &mut self, speed_multiplier: f64, change_at: Option<InstantMusical>, )

Set a multiplier for the speed of the transport to a single static value.

• 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.
• change_at: If this is Some, then the change will happen when the transport reaches the given playhead. If this is None, then the change will happen as soon as the processor receives the event.

Trait Implementations

impl Clone for TransportState

fn clone(&self) -> TransportState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for TransportState

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 TransportState

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

Formats the value using the given formatter.

impl Default for TransportState

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for TransportState

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