Struct serenity::voice::Audio

pub struct Audio {
    pub playing: bool,
    pub volume: f32,
    pub finished: bool,
    pub source: Box<AudioSource>,
    pub position: Duration,
    pub position_modified: bool,
}

Control object for audio playback.

Accessed by both commands and the playback code -- as such, access is always guarded. In particular, you should expect to receive a LockedAudio when calling Handler::play_returning or Handler::play_only.

Example

use serenity::voice::{Handler, LockedAudio, ffmpeg};

let handler: Handler = /* ... */;
let source = ffmpeg("../audio/my-favourite-song.mp3")?;
let safe_audio: LockedAudio = handler.play_only();
{
    let audio_lock = safe_audio_control.clone();
    let mut audio = audio_lock.lock();

    audio.volume(0.5);
}

Fields

playing: bool

Whether or not this sound is currently playing.

Can be controlled with play or pause if chaining is desired.

volume: f32

The desired volume for playback.

Sensible values fall between 0.0 and 1.0. Can be controlled with volume if chaining is desired.

finished: bool

Whether or not the sound has finished, or reached the end of its stream.

Read-only for now.

source: Box<AudioSource>

Underlying data access object.

Calling code is not expected to use this.

position: Duration

The current position for playback.

Consider the position fields read-only for now.

position_modified: bool

Methods

impl Audio

pub fn new(source: Box<AudioSource>) -> Self

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn play(&mut self) -> &mut Self

Sets playing to true in a manner that allows method chaining.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn pause(&mut self) -> &mut Self

Sets playing to false in a manner that allows method chaining.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Sets volume in a manner that allows method chaining.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn position(&mut self, position: Duration) -> &mut Self

Change the position in the stream for subsequent playback.

Currently a No-op.