torchaudio.utils¶
torchaudio.utils.sox_utils¶
Utility module to configure libsox. This affects functionalities in Sox IO backend and Sox Effects.
-
torchaudio.utils.sox_utils.
get_buffer_size
() → int[source]¶ Get buffer size for sox effect chain
- Returns
size in bytes of buffers used for processing audio.
- Return type
-
torchaudio.utils.sox_utils.
list_effects
() → Dict[str, str][source]¶ List the available sox effect names
-
torchaudio.utils.sox_utils.
list_read_formats
() → List[str][source]¶ List the supported audio formats for read
- Returns
List of supported audio formats
- Return type
List[str]
-
torchaudio.utils.sox_utils.
list_write_formats
() → List[str][source]¶ List the supported audio formats for write
- Returns
List of supported audio formats
- Return type
List[str]
-
torchaudio.utils.sox_utils.
set_buffer_size
(buffer_size: int)[source]¶ Set buffer size for sox effect chain
- Parameters
buffer_size (int) – Set the size in bytes of the buffers used for processing audio.
See also
-
torchaudio.utils.sox_utils.
set_seed
(seed: int)[source]¶ Set libsox’s PRNG
- Parameters
seed (int) – seed value. valid range is int32.
See also
-
torchaudio.utils.sox_utils.
set_use_threads
(use_threads: bool)[source]¶ Set multithread option for sox effect chain
- Parameters
use_threads (bool) – When
True
, enableslibsox
’s parallel effects channels processing. To use mutlithread, the underlyinglibsox
has to be compiled with OpenMP support.
See also