mindspore.dataset.audio.Vol
===========================

.. image:: https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/master/resource/_static/logo_source.svg
    :target: https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/dataset_audio/mindspore.dataset.audio.Vol.rst
    :alt: 查看源文件


.. py:class:: mindspore.dataset.audio.Vol(gain, gain_type=GainType.AMPLITUDE)

    调整波形的音量。

    参数：
        - **gain** (float) - 提升（或衰减）的增益。
          如果 `gain_type` 为 ``GainType.AMPLITUDE`` ，应为一个非负的幅度比。
          如果 `gain_type` 为 ``GainType.POWER`` ，应为一个功率（电压的平方）。
          如果 `gain_type` 为 ``GainType.DB`` ，应以分贝为单位。
        - **gain_type** (:class:`~.audio.GainType`, 可选) - 增益的类型，可为 ``GainType.AMPLITUDE`` 、
          ``GainType.POWER`` 或 ``GainType.DB`` 。默认值： ``GainType.AMPLITUDE`` 。

    异常：
        - **TypeError** - 当 `gain` 的类型不为float。
        - **TypeError** - 当 `gain_type` 的类型不为 :class:`mindspore.dataset.audio.GainType` 。
        - **ValueError** - 当 `gain_type` 为 ``GainType.AMPLITUDE`` 时，`gain` 为负数。
        - **ValueError** - 当 `gain_type` 为 ``GainType.POWER`` 时，`gain` 不为正数。
        - **RuntimeError** - 当输入音频的shape不为<..., time>。

    教程样例：
        - `音频变换样例库
          <https://www.mindspore.cn/docs/zh-CN/master/api_python/samples/dataset/audio_gallery.html>`_