ZL38063ドライバー

ZL38063 Driver

ESP32-LyraTD-MSCオーディオボードで使用されるZL38063コーデックチップ用のドライバー。

Driver for ZL38063 codec chip used in ESP32-LyraTD-MSC audio board.

APIリファレンス

API Reference

ヘッダーファイル

Header File

関数

Functions
esp_err_t zl38063_codec_init(audio_hal_codec_config_t *cfg)

ZL38063チップを初期化します。

Initialize ZL38063 chip.

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • cfg: ZL38063の構成
    cfg: configuration of ZL38063

esp_err_t zl38063_codec_deinit(void)

ZL38063チップを非初期化します。

Deinitialize ZL38063 chip.

Return
  • ESP_OK
  • ESP_FAIL

esp_err_t zl38063_codec_ctrl_state(audio_hal_codec_mode_t mode, audio_hal_ctrl_t ctrl_state)

Control ZL38063 chip.

関数zl38063_ctrl_stateおよびzl38063_config_i2sは、このドライバーでは使用されません。 これらは、ADFプロジェクトのインターフェースの均一性と利便性を維持するためにここに保持されます。 zl38063のこれらの設定は、ファームウェアおよび構成ファイルに書き込まれます。 デフォルトのi2s構成：48000Hz、16ビット、左右チャネル。 さまざまなファイルタイプと互換性を持たせるには、リサンプリングを使用します。

The functions zl38063_ctrl_state and zl38063_config_i2s are not used by this driver. They are kept here to maintain the uniformity and convenience of the interface of the ADF project. These settings for zl38063 are burned in firmware and configuration files. Default i2s configuration: 48000Hz, 16bit, Left-Right channels. Use resampling to be compatible with different file types.

Return
  • ESP_FAIL パラメータエラー
    ESP_FAIL Parameter error
  • ESP_OK 成功
    ESP_OK Success
Parameters
  • mode: コーデックモード
    mode: codec mode
  • ctrl_state: デコードの開始または停止、または進行状況のエンコード
    ctrl_state: start or stop decode or encode progress

esp_err_t zl38063_codec_config_i2s(audio_hal_codec_mode_t mode, audio_hal_codec_i2s_iface_t *iface)

ZL38063コーデックモードとI2Sインターフェイスを構成します。

Configure ZL38063 codec mode and I2S interface.

Return
  • ESP_FAIL パラメータエラー
    ESP_FAIL Parameter error
  • ESP_OK 成功
    ESP_OK Success
Parameters
  • mode: コーデックモード
    mode: codec mode
  • iface: I2S構成
    iface: I2S config

esp_err_t zl38063_codec_set_voice_mute(bool mute)

mute or unmute the codec

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • mute: 真/偽
    mute: true, false

esp_err_t zl38063_codec_set_voice_volume(int volume)

音声音量を設定します。

Set voice volume.

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • volume: 音量（0〜100）
    volume: voice volume (0~100)

esp_err_t zl38063_codec_get_voice_volume(int *volume)

音声音量を取得します。

Get voice volume.

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • *volume: 音量（0〜100）
    *volume: voice volume (0~100)