API Reference
=============

Encoder
-------

.. autoclass:: ruopus.OpusEncoder
   :members:
   :show-inheritance:

Decoder
-------

.. autoclass:: ruopus.OpusDecoder
   :members:
   :show-inheritance:

Multistream Decoder
-------------------

.. autoclass:: ruopus.MultistreamDecoder
   :members:
   :show-inheritance:

Ogg Opus
--------

.. autofunction:: ruopus.encode_ogg_opus
.. autofunction:: ruopus.decode_ogg_opus
.. autoclass:: ruopus.OpusHead
   :members:
   :show-inheritance:

Packet Introspection
--------------------

.. autoclass:: ruopus.Packet
   :members:
   :show-inheritance:

.. autoclass:: ruopus.Toc
   :members:
   :show-inheritance:

Enumerations
------------

.. autoclass:: ruopus.Mode
   :members:
   :show-inheritance:

.. autoclass:: ruopus.Bandwidth
   :members:
   :show-inheritance:

.. autoclass:: ruopus.FrameSize
   :members:
   :show-inheritance:

.. autoclass:: ruopus.Signal
   :members:
   :show-inheritance:

.. autoclass:: ruopus.Application
   :members:
   :show-inheritance:

Exceptions
----------

.. autoclass:: ruopus.OpusError
   :members:
   :show-inheritance:

.. autoclass:: ruopus.EncodeError
   :members:
   :show-inheritance:

.. autoclass:: ruopus.PacketError
   :members:
   :show-inheritance:

.. autoclass:: ruopus.OggError
   :members:
   :show-inheritance:

Low-Level Module
----------------

.. automodule:: ruopus.lowlevel
   :members:
   :imported-members:
   :show-inheritance: