Struct rich_sdl2_rust::mixer::chunk::channel::ChannelGroup

pub struct ChannelGroup<'device> { /* private fields */ }

A channel group, reserving some Channels.

Implementations

impl<'device> ChannelGroup<'device>

pub fn new(_device: &'device MixDevice<'device>, len: usize) -> Self

Constructs the new channel group.

pub fn partition(self, left_len: usize) -> (Self, Self)

Partitions the group into two groups. The length of first element of tuple will be left_len, and the other will be self.len - left_len. And halts all the playing channel before doing it.

Panics

Panics if self.len < left_len.

pub fn first_free(&self) -> Option<Channel<'_>>

Returns the first free mixing channel if exists.

pub fn oldest_playing(&self) -> Option<Channel<'_>>

Returns the oldest playing channel in the group.

pub fn newest_playing(&self) -> Option<Channel<'_>>

Returns the newest playing channel in the group.

pub fn halt_all(&self)

Halts all the playing channel.

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

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

pub fn len(&self) -> usize

Returns the numbers of channels in the group.

pub fn is_empty(&self) -> bool

Returns whether the group is empty.