Struct PlayerController 

pub struct PlayerController { /* private fields */ }

This type allows you to control the player from one thread, while rendering it on another.

Implementations

impl PlayerController

pub fn play(&self) -> bool

Start the playback.

Returns true if started or already playing; false otherwise.

pub fn is_playing(&self) -> bool

pub fn stop(&mut self)

Stop the playback.

pub fn set_position_ticks(&self, value: u64)

Set the playing position in timeline ticks.

Values outside the valid range are clamped to [0, total_ticks()]. Will take effect only if a file is opened and it is not empty.

pub fn position_ticks(&self) -> u64

Get the current playback position in timeline ticks.

pub fn total_ticks(&self) -> u64

Get the total number of timeline ticks in the loaded file.

pub fn set_position(&self, value: f64)

Set the playing position in normalized range [0.0, 1.0].

Will take effect only if a file is opened and it is not empty.

pub fn position(&self) -> f64

Get normalized playing position (i.e. in range [0.0, 1.0]).

pub fn new_position_observer(&self) -> PositionObserver

Initialize a new PositionObserver.

pub fn set_tempo(&mut self, tempo: f32)

Set the tempo (in beats per minute).

pub fn tempo(&self) -> Option<f32>

Get the tempo (in beats per minute).

Returns None if file is not set.

pub fn set_volume(&mut self, volume: f32)

Set master volume.

pub fn volume(&self) -> f32

Get master volume.

pub fn duration(&self) -> Duration

Get file duration.

pub fn set_file( &mut self, path: Option<impl Into<PathBuf>>, ) -> Result<(), Box<dyn Error>>

Set a MIDI file.

The parameter is Option<&str>, where Some value is actual path and None is for offloading.

pub fn note_off_all(&mut self)

Send note off message for all notes (aka Panic)