Struct playdate::sound::player::FilePlayer

pub struct FilePlayer<Api = Default>(/* private fields */)
where
    Api: Api;

Implementations

impl<Api> Player<Api>

where Api: Api,

pub fn new() -> Result<Player<Api>, Error>

where Api: Default,

pub fn new_with(api: Api) -> Result<Player<Api>, Error>

impl<Api> Player<Api>

where Api: Api,

pub fn api(&self) -> &Api

impl<Api> Player<Api>

where Api: Api,

pub fn load_into_player<P>(&self, path: P) -> Result<(), Error<Error>>

where P: AsRef<str>,

Prepares player to stream the file at path.

Equivalent to loadIntoPlayer

pub fn set_buffer_length(&self, len: f32)

Sets the buffer length of player to len seconds.

Equivalent to setBufferLength

pub fn is_playing(&self) -> bool

Returns true if player is playing.

Equivalent to isPlaying

pub fn play(&self, repeat: Repeat) -> i32

Starts playing the file player.

Equivalent to play

pub fn stop(&self)

Stops playing the file.

Equivalent to stop

pub fn volume(&self) -> (f32, f32)

Gets the left and right channel playback volume for player.

Equivalent to getVolume

pub fn set_volume(&self, left: f32, right: f32)

Sets the playback volume for left and right channels of player.

Equivalent to setVolume

pub fn length(&self) -> f32

Returns the length, in seconds, of the file loaded into player.

Equivalent to getLength

pub fn offset(&self) -> f32

Gets the current offset in seconds for player.

Equivalent to getOffset

pub fn set_offset(&self, offset: f32)

Sets the current offset in seconds.

Equivalent to setOffset

pub fn rate(&self) -> f32

Gets the playback rate for player.

Equivalent to getRate

pub fn set_rate(&self, rate: f32)

Sets the playback rate for the player.

1.0 is normal speed, 0.5 is down an octave, 2.0 is up an octave, etc.

Unlike SamplePlayer, FilePlayers can’t play in reverse (i.e., rate < 0).

Equivalent to setRate

pub fn set_loop_range(&self, start: f32, end: f32)

Sets the start and end of the loop region for playback, in seconds.

If end is omitted, the end of the file is used.

Equivalent to setLoopRange

pub fn did_underrun(&self) -> bool

Returns true if player has underrun, false if not.

Equivalent to didUnderrun

pub fn set_stop_on_underrun(&self, value: bool)

If value is true, the player will restart playback (after an audible stutter) as soon as data is available.

Equivalent to setStopOnUnderrun

pub fn set_finish_callback( &self, callback: Option<unsafe extern "C" fn(_: *mut SoundSource, _: *mut c_void)> )

Sets a function to be called when playback has completed.

This is an alias for sys::ffi::playdate_sound_source::setFinishCallback.

Equivalent to setFinishCallback

pub fn set_loop_callback( &self, callback: Option<unsafe extern "C" fn(_: *mut SoundSource, _: *mut c_void)> )

Equivalent to setLoopCallback

pub fn fade_volume( &self, left: f32, right: f32, len: i32, finish_callback: Option<unsafe extern "C" fn(_: *mut SoundSource, _: *mut c_void)> )

Changes the volume of the Player to left and right over a length of len sample frames, then calls the provided callback (if set).

Equivalent to fadeVolume

pub fn set_mp3_stream_source( &self, source: Option<unsafe extern "C" fn(_: *mut u8, _: i32, _: *mut c_void) -> i32>, userdata: *mut c_void, buffer_len: f32 )

Equivalent to setMP3StreamSource

Trait Implementations

impl<Api> Debug for Player<Api>

where Api: Debug + Api,

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

Formats the value using the given formatter.

impl<Api> Drop for Player<Api>

where Api: Api,

fn drop(&mut self)

Executes the destructor for this type.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.