Speaker

Speaker 用于控制主机内部集成的按键。以下是主机的 Speaker 支持详细：

控制器	NS4168	AW88298	Buzzer
AirQ			✔
Atom Echo	✔
Atom Lite
Atom Martrix
AtomS3
AtomS3 Lite
AtomS3U
AtomU
基础
胶囊			✔
Cardputer	✔
Core2	✔
CoreInk	✔
CoreS3		✔
拨号	✔
DinMeter	✔
火
Paper
Stamp PICO
StampS3
Station
StickC			✔
StickC PLUS			✔
StickC PLUS2			✔
TOUGH	✔

MicroPython 应用示例：

# SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *


circle0 = None
label0 = None


x = None
y = None


def setup():
    global circle0, label0, x, y

    M5.begin()
    Widgets.fillScreen(0x222222)
    circle0 = Widgets.Circle(160, 120, 60, 0xFFFFFF, 0xFFFFFF)
    label0 = Widgets.Label("Play", 141, 110, 1.0, 0x222222, 0xFFFFFF, Widgets.FONTS.DejaVu18)

    Speaker.begin()
    Speaker.playWavFile("/flash/res/audio/poweron_2_5s.wav")


def loop():
    global circle0, label0, x, y
    M5.update()
    if M5.Touch.getCount():
        x = M5.Touch.getX()
        y = M5.Touch.getY()
        if x >= 130 and x <= 190 and y >= 90 and y <= 150:
            circle0.setColor(color=0xFF0000, fill_c=0xFF0000)
            label0.setColor(0xFFFFFF, 0xFF0000)
            label0.setText(str("Play..."))
            Speaker.playWavFile("/flash/res/audio/poweron_2_5s.wav")
            label0.setText(str("Play"))
            circle0.setColor(color=0xFFFFFF, fill_c=0xFFFFFF)
            label0.setColor(0x000000, 0xFFFFFF)


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

UiFlow2 应用示例：

cores3_speaker_example.m5f2

poweron_2_5s.wav

class Speaker

重要

Speaker Class 的方法高度依赖 M5.begin() 和 M5.update() 。

对 Speaker 对象方法的所有调用都应放在 M5.begin() 之后，并且应在主循环中调用 M5.update() 。

备注

Speaker is registered in the M5 module, not in the hardware module. Use from M5 import * to make Speaker available. Do not write from hardware import Speaker.

Methods

Speaker.config([cfg])

Speaker.config('param')

Speaker.config(param=value)

获取或者设置 Speaker 对象的参数。

UiFlow2

读取属性：

Parameter	Type	Description
pin_data_out	(integer)	I2S 的串行数据线，用二进制补码表示的音频数据。
pin_bck	(integer)	I2S 的串行时钟线，对应数字音频的每一位数据。
pin_ws	(integer)	I2S 的帧时钟，用于切换左右声道的数据。
sample_rate	(integer)	音频输出的采样率。
立体声	(boolean)	使用双声道输出。
蜂鸣器	(boolean)	使用单GPIO蜂鸣器。
use_dac	(boolean)	使用DAC音箱。
dac_zero_level	(integer)	使用DAC时的零电平参考值。
放大倍数	(integer)	输入值的乘数。
dma_buf_len	(integer)	I2S 的DMA缓冲区长度。
dma_buf_count	(integer)	I2S 的DMA缓冲区数量。
task_priority	(integer)	后台任务优先级。
task_pinned_core	(integer)	后台任务使用的CPU。
i2s_port	(integer)	I2S端口。

Python：

Speaker.config("pin_data_in")

设置属性：

Python：

Speaker.config(pin_data_in=1)

Speaker.begin() → bool

启动 Speaker 功能。执行成功返回 True 。

UiFlow2

Speaker.end() → None

禁用 Speaker 。

UiFlow2

Speaker.isRunning() → bool

获取 Speaker 是否处于运行状态， 返回bool类型。

UiFlow2

Speaker.isEnabled() → bool

获取 Speaker 是否处于使能状态， 返回bool类型。

UiFlow2

Speaker.isPlaying([channel]) → bool

获取 Speaker 是否处于声音输出状态， 返回bool类型。

传入参数 channel 时，获取指定通道的播放状态。channel 接受的值是 0 ~ 7 。

UiFlow2

Speaker.getPlayingChannels() → int

获取正在播放的频道数。

UiFlow2

Speaker.setVolume(volume: int) → None

设置声音的输出主音量。volume 接受 0 ~ 255 的音量等级。

UiFlow2

Speaker.getVolume() → int

获取声音的输出主音量。返回 0 ~ 255 的音量等级。

UiFlow2

Speaker.setVolumePercentage(percentage: float) → None

设置声音的输出主音量百分比。percentage 是 0% ~ 100% 的音量等级。

UiFlow2

Speaker.getVolumePercentage() → float

获取声音的输出主音量百分比。返回 0% ~ 100% 的音量等级。

UiFlow2

Speaker.setAllChannelVolume(volume: int) → None

设置所有虚拟通道的声音输出音量。volume 接受 0 ~ 255 的音量等级。

UiFlow2

Speaker.setChannelVolume(channel: int, volume: int) → None

设置指定虚拟通道的声音输出音量。

Parameters:

• volume 接受 0 ~ 255 的音量等级。

• channel 是播放的通道，范围是 0 ~ 7 。

UiFlow2

Speaker.getChannelVolume(channel) → int

获取指定虚拟通道的声音输出音量。channel 是虚拟通道，范围是 0 ~ 7 。

UiFlow2

Speaker.stop([channel]) → None

停止声音输出。当不使用 channel 时，停止所有通道的声音输出。channel 接受的值是 0 ~ 7 。

UiFlow2

Speaker.tone(frequency, duration[, channel[, stop_current_sound]]) → None

播放简单的音调声音。

Parameters:

• frequency 是音调的频率，单位是 Hz。

• duration 是音调的持续时间，单位是毫秒。

• channel 是播放的通道，范围是 0 ~ 7 ，默认填 -1 ，使用可用的通道播放。

• stop_current_sound 用于控制是否等待之前的音频播放完成，为 True 时，无需等待当前输出完成即可开始新的输出。

UiFlow2

Speaker.playRaw(wav_data: bytes|bytearray[, sample_rate: int[, stereo: bool[, repeat: int[, channel: int[, stop_current_sound: bool]]]]]) → bool

播放 PCM 的数据。

Parameters:

• wav_data 是音频数据的 buffer。

• sample_rate 是设置音频数据的采样率。

• stereo 是设置音频为双声道。

• repeat 是音频播放的次数，默认是 1 。

• channel 是播放的通道，范围是 0 ~ 7 ，默认填 -1 ，使用可用的通道播放。

• stop_current_sound 用于控制是否等待之前的音频播放完成，为 True 时，无需等待当前输出完成即可开始新的输出。

UiFlow2

Speaker.playWav(wav_data: bytes|bytearray[, repeat: int[, channel: int[, stop_current_sound: bool]]]) → None

播放 wave 格式的音频数据。要求传入整个音频文件的原始数据。

Parameters:

• wav_data 是音频数据的 buffer。

• repeat 是音频播放的次数，默认是 1 。

• channel 是播放的通道，范围是 0 ~ 7 ，默认填 -1 ，使用可用的通道播放。

• stop_current_sound 用于控制是否等待之前的音频播放完成，为 True 时，无需等待当前输出完成即可开始新的输出。

UiFlow2

Speaker.playWavFile(path: str[, repeat: int[, channel: int[, stop_current_sound: bool]]]) → None

播放 wave 格式的音频数据。要求传入整个音频文件的原始数据。

Parameters:

• path 是音频文件的路径。

• repeat 是音频播放的次数，默认是 1 。

• channel 是播放的通道，范围是 0 ~ 7 ，默认填 -1 ，使用可用的通道播放。

• stop_current_sound 用于控制是否等待之前的音频播放完成，为 True 时，无需等待当前输出完成即可开始新的输出。

UiFlow2