mindspore.dataset.audio.MaskAlongAxis
=====================================

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


.. py:class:: mindspore.dataset.audio.MaskAlongAxis(mask_start, mask_width, mask_value, axis)

    对音频波形应用掩码。掩码的起始和长度由 `[mask_start, mask_start + mask_width)` 决定。

    参数：
        - **mask_start** (int) - 掩码的起始位置，必须为非负值。
        - **mask_width** (int) - 掩码的宽度，必须大于0。
        - **mask_value** (float) - 填充到掩码区间的值。
        - **axis** (int) - 要应用掩码的轴， ``1`` 表示频率， ``2`` 表示时间。

    异常：
        - **ValueError** - 如果 `mask_start` 小于0。
        - **ValueError** - 如果 `mask_width` 小于1。
        - **ValueError** - 如果 `axis` 的值不在[1, 2]范围内。

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