Commit 9467fc44 authored by moto's avatar moto Committed by Facebook GitHub Bot
Browse files

Expose AudioMetadata (#3556)

Summary:
`torchaudio.info` returns `AudioMetaData`. It should be exposed as public API, without referring `backend` submodule.

Pull Request resolved: https://github.com/pytorch/audio/pull/3556

Reviewed By: huangruizhe

Differential Revision: D48267349

Pulled By: mthrok

fbshipit-source-id: 6ccc0c32bf62fbdcb71495fc7d8d4cc29891538a
parent f2b2f05a
...@@ -38,7 +38,7 @@ Structures used to report the metadata of audio files. ...@@ -38,7 +38,7 @@ Structures used to report the metadata of audio files.
AudioMetaData AudioMetaData
------------- -------------
.. autoclass:: torchaudio.backend.common.AudioMetaData .. autoclass:: torchaudio.AudioMetaData
.. py:module:: torchaudio.backend.sox_io_backend .. py:module:: torchaudio.backend.sox_io_backend
......
from torchaudio import ( # noqa: F401 from . import ( # noqa: F401
_extension, _extension,
compliance, compliance,
datasets, datasets,
...@@ -11,6 +11,8 @@ from torchaudio import ( # noqa: F401 ...@@ -11,6 +11,8 @@ from torchaudio import ( # noqa: F401
transforms, transforms,
utils, utils,
) )
from .backend.common import AudioMetaData
try: try:
from .version import __version__, git_version # noqa: F401 from .version import __version__, git_version # noqa: F401
...@@ -34,6 +36,7 @@ _init_backend() ...@@ -34,6 +36,7 @@ _init_backend()
__all__ = [ __all__ = [
"AudioMetaData",
"io", "io",
"compliance", "compliance",
"datasets", "datasets",
......
class AudioMetaData: class AudioMetaData:
"""Return type of ``torchaudio.info`` function. """AudioMetaData()
This class is used by :py:mod:`"sox_io" backend<torchaudio.backends.sox_io_backend>` and Return type of ``torchaudio.info`` function.
:py:mod:`"soundfile" backend<torchaudio.backends.soundfile_backend>`.
:ivar int sample_rate: Sample rate :ivar int sample_rate: Sample rate
:ivar int num_frames: The number of frames :ivar int num_frames: The number of frames
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment