Struct amethyst::audio::Dj
[−]
[src]
pub struct Dj { /* fields omitted */ }This structure provides a way to programmatically pick and play music.
Methods
impl Dj[src]
fn new(output: &Output) -> Dj[src]
Creates a new Dj using the given audio output.
fn set_picker(&mut self, picker: Box<FnMut(&mut Dj) -> bool + Send + Sync>)[src]
A Dj's picker will be called by the DjSystem whenever the Dj runs out of music to play.
Only the Dj added to the world's resources with resource ID 0 will have their picker called.
During callback the picker is separated from the Dj in order to avoid multiple aliasing. After the callback is complete, if the picker returned true it will be reattached.
fn clear_picker(&mut self)[src]
Clears the previously set picker.
fn append(&self, source: &Source) -> Result<(), DecoderError>[src]
Adds a source to the Dj's queue of music to play.
fn empty(&self) -> bool[src]
Returns true if the Dj has no more music to play.
fn volume(&self) -> f32[src]
Retrieves the volume of the Dj, between 0.0 and 1.0;
fn set_volume(&mut self, volume: f32)[src]
Sets the volume of the Dj.
fn play(&self)[src]
Resumes playback of a paused Dj. Has no effect if this Dj was never paused.
fn pause(&self)[src]
Pauses playback, this can be resumed with Dj::play
fn is_paused(&self) -> bool[src]
Returns true if the Dj is currently paused.
fn stop(&self)[src]
Empties the Dj's queue of all music.