Struct Channel

pub struct Channel(pub i32);

Available on crate feature dep_sdl2 only.

Sound effect channel.

Tuple Fields

0: i32

Implementations

impl Channel

pub fn all() -> Channel

Represent for all channels (-1)

pub fn post() -> Channel

This is the MIX_CHANNEL_POST (-2)

pub fn set_volume(self, volume: i32) -> i32

Set the volume for any allocated channel.

pub fn get_volume(self) -> i32

Returns the channels volume on scale of 0 to 128.

pub fn play(self, chunk: &Chunk, loops: i32) -> Result<Channel, String>

Play chunk on channel, or if channel is -1, pick the first free unreserved channel.

pub fn play_timed( self, chunk: &Chunk, loops: i32, ticks: i32, ) -> Result<Channel, String>

pub fn fade_in( self, chunk: &Chunk, loops: i32, ms: i32, ) -> Result<Channel, String>

Play chunk on channel, or if channel is -1, pick the first free unreserved channel.

pub fn fade_in_timed( self, chunk: &Chunk, loops: i32, ms: i32, ticks: i32, ) -> Result<Channel, String>

pub fn pause(self)

Pause channel, or all playing channels if -1 is passed in.

pub fn resume(self)

Unpause channel, or all playing and paused channels if -1 is passed in.

pub fn halt(self)

Halt channel playback

pub fn expire(self, ticks: i32) -> i32

Halt channel playback, after ticks milliseconds.

pub fn fade_out(self, ms: i32) -> i32

Gradually fade out which channel over ms milliseconds starting from now.

pub fn is_playing(self) -> bool

if channel is playing, or not.

pub fn is_paused(self) -> bool

if channel is paused, or not.

pub fn get_fading(self) -> Fading

if channel is fading in, out, or not

pub fn get_chunk(self) -> Option<Chunk>

Get the most recent sample chunk pointer played on channel.

pub fn unregister_all_effects(self) -> Result<(), String>

This removes all effects registered to channel.

pub fn set_panning(self, left: u8, right: u8) -> Result<(), String>

Sets a panning effect, where left and right is the volume of the left and right channels. They range from 0 (silence) to 255 (loud).

pub fn unset_panning(self) -> Result<(), String>

Unregisters panning effect.

pub fn set_distance(self, distance: u8) -> Result<(), String>

This effect simulates a simple attenuation of volume due to distance. distance ranges from 0 (close/loud) to 255 (far/quiet).

pub fn unset_distance(self) -> Result<(), String>

Unregisters distance effect.

pub fn set_position(self, angle: i16, distance: u8) -> Result<(), String>

This effect emulates a simple 3D audio effect. angle ranges from 0 to 360 degrees going clockwise, where 0 is directly in front. distance ranges from 0 (close/loud) to 255 (far/quiet).

pub fn unset_position(self) -> Result<(), String>

Unregisters position effect.

pub fn set_reverse_stereo(self, flip: bool) -> Result<(), String>

Simple reverse stereo, swaps left and right channel sound. true for reverse, false to unregister effect.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.

impl PartialEq for Channel

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Channel

impl StructuralPartialEq for Channel