Struct cat_audio::AudioWrapper

pub struct AudioWrapper {
    pub audio: Audio,
    // some fields omitted
}

Простой интерфейс для управления аудио движком. A simple interface for operating the audio engine.

Fields

audio: Audio

Implementations

impl AudioWrapper

pub fn new(audio: Audio) -> AudioWrapper

pub fn load_track<P: AsRef<Path>>(&mut self, path: P, name: String) -> bool

Загружает трек в хранилище.

Возвращает true, если загрузка прошла без ошибок.

Loads a track to the storage.

Returns true if loaded with no errors.

pub fn remove_track(&mut self, name: &str) -> AudioCommandResult

Удаляет трек из хранилища.

Removes a track from the storage.

pub fn clear_storage(&mut self) -> AudioCommandResult

Очищает хранилище и плейлист.

Clears the storage and the playlist.

pub fn push_sets(&mut self, name: String, sets: Vec<Set>)

Добавляет новые сеты.

Adds new sets.

pub fn get_track_sets(&self, name: &str) -> Option<&Vec<Set>>

Возвращает сеты трека.

Returns track's sets.

pub fn get_mut_track_sets(&mut self, name: &str) -> Option<&mut Vec<Set>>

Возвращает сеты трека.

Returns track's sets.

impl AudioWrapper

Проигрывание треков.

Playing tracks.

pub fn play_track(&self, name: &str, repeats: u32) -> AudioCommandResult

Запускает трек.

Plays a track.

Repeats: 0 - forever, 1 - once, 2 - twice and so on...

pub fn stop_track(&self, name: &str) -> AudioCommandResult

Останавливает трек.

Stops a track.

pub fn play(&self) -> AudioCommandResult

Запускает поток проигрывания.

Starts playing the output stream.

pub fn pause(&self) -> AudioCommandResult

Ставит на паузу поток проигрывания.

Pauses the output stream.

pub fn unpause_track(&self, name: &str) -> AudioCommandResult

Возобновляет проигрывание трека.

Unpauses a track.

pub fn pause_track(&self, name: &str) -> AudioCommandResult

Ставит трек на паузу.

Pauses a track.

pub fn clear_playlist(&self) -> AudioCommandResult

Очищает плейлист.

Clears the playlist.

impl AudioWrapper

Функции установки параметров.

Setting functions.

pub fn set_track_volume(&self, name: &str, volume: f32) -> AudioCommandResult

Устанавливает громкость трека.

Sets track's volume.

pub fn set_general_volume(&self, volume: f32) -> AudioCommandResult

Устанавливает общую громкость.

Sets the general volume.