Struct cat_audio::Audio

pub struct Audio { /* fields omitted */ }

Простой аудио движок. A simple audio engine.

Пока только вывод доступен.

Only output is available now.

Implementations

impl Audio

pub fn new<D: Fn(&Host) -> Device + Send + Sync + 'static, F: Fn(&Device) -> Format + Send + Sync + 'static>(
    host: Host,
    choose_device: D,
    choose_format: F,
    settings: AudioSettings
) -> Result<Audio>

Строит аудио движок.

Возвращает результат создания аудио потока.

Creates an audio engine.

Returns the result of starting an audio thread.

pub fn default(settings: AudioSettings) -> Result<Audio>

Строит аудио движок с хостом, устройством и потоком по умолчанию.

Возвращает результат создания аудио потока.

Creates an audio engine with default host, device and streams.

Returns the result of starting an audio thread.

pub fn tracks_amount(&self) -> usize

Возвращает количество треков в хранилище.

Returns the amount of track in the storage.

impl Audio

feature="extended"

pub fn send_command(
    &self,
    command: AudioEngineCommand
) -> Result<(), SendError<AudioEngineCommand>>

Отправляет команду аудио системе.

Sends a audio system command.

pub fn storage_slots(&mut self) -> &mut Vec<bool>

Возращает флаги ячеек хранилища. true - занято, false - свободно

Returns storage slot flags. true - busy, false - free

pub fn free_storage_slots(&mut self) -> &mut Vec<usize>

Возращает индексы свободных ячеек хранилища.

Returns indices of free storage slots.

impl Audio

Добавление/удаление треков.

Adding/removing tracks.

pub fn add_track(&mut self, track: MonoTrack) -> AudioCommandResult

Добавляет трек в хранилище.

Если недостаточно места, возвращает AudioCommandResult::StorageOverflow.

Adds a track to the storage.

If there is not enough space, returns AudioCommandResult::StorageOverflow.

pub fn add_tracks(&mut self, tracks: Vec<MonoTrack>) -> AudioCommandResult

Добавляет несколько треков в хранилище.

Если недостаточно места даже для одного, возвращает AudioCommandResult::StorageOverflow.

Adds some tracks to the storage.

If there is not enough space even for one, returns AudioCommandResult::StorageOverflow.

pub fn remove_track(&mut self, index: usize) -> AudioCommandResult

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

Removes the track from the storage.

pub fn remove_tracks(&mut self, indices: Vec<usize>) -> AudioCommandResult

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

Removes tracks from the storage.

pub fn clear_storage(&mut self) -> AudioCommandResult

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

Clears the storage and the playlist.

impl Audio

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

Play tracks.

pub fn play_track(&self, set: TrackSet) -> AudioCommandResult

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

Plays a track.

pub fn play_tracks(&self, sets: Vec<TrackSet>) -> AudioCommandResult

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

Plays tracks.

pub fn stop_track(&self, index: usize) -> AudioCommandResult

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

Stops a track from the playlist.

pub fn stop_tracks(&self, indices: Vec<usize>) -> AudioCommandResult

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

Stops tracks in the playlist.

pub fn clear_playlist(&self) -> AudioCommandResult

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

Clears a playlist.

pub fn play(&self) -> AudioCommandResult

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

Starts playing the output stream.

pub fn pause(&self) -> AudioCommandResult

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

Pauses the output stream.

pub fn unpause_track(&self, index: usize) -> AudioCommandResult

Снимает трек с паузы.

Если уже проигрывается или такого трека нет, ничего не происходит.

Unpauses a track.

If it's already playing or there is no such track, nothing happens.

pub fn unpause_tracks(&self, indices: Vec<usize>) -> AudioCommandResult

Снимает треки с паузы.

Если уже проигрываются или таких треков нет, ничего не происходит.

Unpauses tracks.

If they're already playing or there are no such tracks, nothing happens.

pub fn pause_track(&self, index: usize) -> AudioCommandResult

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

Если уже на паузе или такого трека нет, ничего не происходит.

Pauses a track.

If it's already paused or there is no such track, nothing happens.

pub fn pause_tracks(&self, indices: Vec<usize>) -> AudioCommandResult

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

Если уже на паузе или таких треков нет, ничего не происходит.

Pauses tracks.

If trey're already paused or there are no such tracks, nothing happens.

impl Audio

Установка параметров.

Setting parameters.

pub fn set_track_volume(&self, index: usize, volume: f32) -> AudioCommandResult

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

Sets the volume of a playing track.

pub fn set_tracks_volume(
    &self,
    indices: Vec<usize>,
    volume: f32
) -> AudioCommandResult

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

Sets the volume of playing tracks.

pub fn set_tracks_volumes(&self, sets: Vec<(usize, f32)>) -> AudioCommandResult

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

Sets volumes of playing tracks.

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

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

Sets the general volume.

impl Audio

Упраление через хранилище треков.

Operating through the track storage.

pub fn unpause_track_storage(&self, index: usize) -> AudioCommandResult

Снимает паузу с треков из плейлиста, привязанных к треку из хранилища.

Unpauses tracks from the playlist attached to a track from the storage.

pub fn unpause_tracks_storage(&self, indices: Vec<usize>) -> AudioCommandResult

Снимает паузу с треков из плейлиста, привязанных к трекам из хранилища.

Unpauses tracks from the playlist attached to tracks from the storage.

pub fn pause_track_storage(&self, index: usize) -> AudioCommandResult

Ставит на паузу треки из плейлиста, привязанных к треку из хранилища.

Pauses tracks from the playlist attached to a track from the storage.

pub fn pause_tracks_storage(&self, indices: Vec<usize>) -> AudioCommandResult

Ставит на паузу треки из плейлиста, привязанные к трекам из хранилища.

Pauses tracks from the playlist attached to tracks from the storage.

pub fn stop_track_storage(&self, index: usize) -> AudioCommandResult

Останавливает треки из плейлиста, привязанные к треку из хранилища.

Stops tracks from the playlist attached to a track from the storage.

pub fn stop_tracks_storage(&self, indices: Vec<usize>) -> AudioCommandResult

Останавливает треки из плейлиста, привязанные к трекам из хранилища.

Stops tracks from the playlist attached to tracks from the storage.

pub fn set_track_volume_storage(
    &self,
    index: usize,
    volume: f32
) -> AudioCommandResult

Устанавливает громкость треков из плейлиста, привязанных к треку из хранилища.

Sets a volume of tracks from the playlist attached to a track from the storage.

pub fn set_tracks_volume_storage(
    &self,
    indices: Vec<usize>,
    volume: f32
) -> AudioCommandResult

Устанавливает громкость треков из плейлиста, привязанных к трекам из хранилища.

Sets a volume of tracks from the playlist attached to tracks from the storage.

pub fn set_tracks_volumes_storage(
    &self,
    sets: Vec<(usize, f32)>
) -> AudioCommandResult

Устанавливает громкости треков из плейлиста, привязанных к трекам из хранилища.

Sets volumes of tracks from the playlist attached to tracks from the storage.

Trait Implementations

impl Drop for Audio

Отправляет команду для остановки и ожидает окончание работы потока.

Sends a command to close and waits for the thread to finish.

pub fn drop(&mut self)

Executes the destructor for this type.