Struct PulsePlaybackHandle 

pub struct PulsePlaybackHandle { /* private fields */ }

Handle for a real-time or looping sound started by PulsePlaybackEngine.

Implementations

impl PulsePlaybackHandle

pub fn from_parts(engine: Rc<AudioEngine>, sound_id: SoundId) -> Self

Creates a handle from an engine reference and tunes sound identifier.

pub fn sound_id(&self) -> SoundId

Returns the underlying tunes sound identifier.

pub fn stop(&self) -> PulseResult<Self>

Stops playback and returns a cloned handle for Lua chainability.

Errors

Returns an error when the engine rejects the stop request.

pub fn volume(&self, volume: f32) -> PulseResult<Self>

Sets playback volume and returns a cloned handle for Lua chainability.

Errors

Returns an error when volume is invalid or the engine rejects the request.

pub fn pan(&self, pan: f32) -> PulseResult<Self>

Sets playback stereo pan and returns a cloned handle for Lua chainability.

Errors

Returns an error when pan is invalid or the engine rejects the request.

pub fn rate(&self, rate: f32) -> PulseResult<Self>

Sets playback rate and returns a cloned handle for Lua chainability.

Errors

Returns an error when rate is invalid or the engine rejects the request.

pub fn pause(&self) -> PulseResult<Self>

Pauses playback and returns a cloned handle for Lua chainability.

Errors

Returns an error when the engine rejects the pause request.

pub fn resume(&self) -> PulseResult<Self>

Resumes playback and returns a cloned handle for Lua chainability.

Errors

Returns an error when the engine rejects the resume request.

Trait Implementations

impl Clone for PulsePlaybackHandle

fn clone(&self) -> PulsePlaybackHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PulsePlaybackHandle

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

Formats the value using the given formatter.

impl UserData for PulsePlaybackHandle

fn add_methods<M: UserDataMethods<Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.

fn add_fields<F>(fields: &mut F)

where F: UserDataFields<Self>,

Adds custom fields specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.