pub struct Channel(pub i32);Expand description
Sound effect channel.
Tuple Fields
0: i32Implementations
sourceimpl Channel
impl Channel
sourcepub fn set_volume(self, volume: i32) -> i32
pub fn set_volume(self, volume: i32) -> i32
Set the volume for any allocated channel.
sourcepub fn get_volume(self) -> i32
pub fn get_volume(self) -> i32
Returns the channels volume on scale of 0 to 128.
sourcepub fn play(self, chunk: &Chunk, loops: i32) -> Result<Channel, String>
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>
sourcepub fn fade_in(
self,
chunk: &Chunk,
loops: i32,
ms: 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>
sourcepub fn fade_out(self, ms: i32) -> i32
pub fn fade_out(self, ms: i32) -> i32
Gradually fade out which channel over ms milliseconds starting from now.
sourcepub fn is_playing(self) -> bool
pub fn is_playing(self) -> bool
if channel is playing, or not.
sourcepub fn get_fading(self) -> Fading
pub fn get_fading(self) -> Fading
if channel is fading in, out, or not
sourcepub fn get_chunk(self) -> Option<Chunk>
pub fn get_chunk(self) -> Option<Chunk>
Get the most recent sample chunk pointer played on channel.
sourcepub fn unregister_all_effects(self) -> Result<(), String>
pub fn unregister_all_effects(self) -> Result<(), String>
This removes all effects registered to channel.
sourcepub fn set_panning(self, left: u8, right: u8) -> Result<(), String>
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).
sourcepub fn unset_panning(self) -> Result<(), String>
pub fn unset_panning(self) -> Result<(), String>
Unregisters panning effect.
sourcepub fn set_distance(self, distance: u8) -> Result<(), String>
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).
sourcepub fn unset_distance(self) -> Result<(), String>
pub fn unset_distance(self) -> Result<(), String>
Unregisters distance effect.
sourcepub fn set_position(self, angle: i16, distance: u8) -> Result<(), String>
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).
sourcepub fn unset_position(self) -> Result<(), String>
pub fn unset_position(self) -> Result<(), String>
Unregisters position effect.
Trait Implementations
impl Copy for Channel
impl StructuralPartialEq for Channel
Auto Trait Implementations
impl RefUnwindSafe for Channel
impl Send for Channel
impl Sync for Channel
impl Unpin for Channel
impl UnwindSafe for Channel
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more