Struct rich_sdl2_rust::mixer::chunk::channel::Channel

pub struct Channel<'device>(/* private fields */);

A mixing channel for playing a MixChunk.

Implementations

impl<'device> Channel<'device>

pub fn volume(&self) -> u32

Returns the output volume of the channel. The volume is in 0..=128.

pub fn set_volume(&self, volume: u32)

Sets the output volume of the channel. The volume is clamped to 0..=128.

pub fn play(self, chunk: &MixChunk<'_>, options: PlayOptions) -> Result<Self>

Starts to play a chunk.

pub fn play_fade_in( self, chunk: &MixChunk<'_>, fade_in: u32, options: PlayOptions ) -> Result<Self>

Starts to play a chunk with fade-in time in milliseconds.

pub fn pause(&'device mut self) -> Option<Pauser<'device>>

Pauses playing and returns the Pauser, or None if it is free.

pub fn halt(&self)

Halts playing on the channel.

pub fn fade_out(&self, fade_out: u32) -> usize

Fade out playing on the channel in milliseconds. And returns the numbers of channels that is fading out.

pub fn is_playing(&self) -> bool

Returns whether the channel is playing.

pub fn playing_chunk(&self) -> Option<MixChunk<'_>>

Returns the playing chunk if exists.

Trait Implementations

impl<'device> Debug for Channel<'device>

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

Formats the value using the given formatter.

impl<'device> EffectAttachExt for Channel<'device>

fn attach(&self, effect: Effect<'_>)

Attaches the effect to the channel.

fn detach_all(&self)

Detaches all the effect from the channel.

impl<'device> PartialEq for Channel<'device>

fn eq(&self, other: &Channel<'device>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'device> Eq for Channel<'device>

impl<'device> StructuralPartialEq for Channel<'device>