このページの内容

リファレンス

ESP32 SDKリファレンス

プレビュー版:機能とAPIは変更される場合があります。

PDFはブラウザーの印刷ダイアログで作成します。ホスト型のエクスポートサービスではありません。

  • コンポーネント:ESP-IDF向けのonesay-esp32
  • 音声:16000 Hz、モノラル、pcm_s16le、40 msのフレーム
  • リプレイバッファー:既定で3000 ms(96000バイト)。オーバーフローはエラーとして報告し、黙って破棄することはありません
  • 認証情報:ファームウェアが提供するセキュアストアのインターフェイスから読み取ります
  • ネットワーク:ESP-IDFによるTLS WebSocket
  • 音声入力:ファームウェアが渡すPCM。SDKは音声をキャプチャしません

このSDKは固定容量のCクライアントです。接続のバインド、音声のフレーム化、ACKの処理、未確認の音声のリプレイ、イベントの順序付け、コールバックのディスパッチ、再接続を担当します。音声、認証情報のストア、ハードウェアのドライバーはファームウェアが提供します。

タスク音声#

  • エントリポイント:onesay_client_init, onesay_client_connect, onesay_client_start_dictation, onesay_client_write_audio, onesay_client_replay_unacked, onesay_client_reconnect, onesay_client_end_signal, onesay_client_dispatch, onesay_client_disconnect
  • トランスポート:onesay.realtime.v1 WebSocket with canonical PCM frames, contiguous ACK, unacked-only replay and bounded resume
  • 結果:Task events through the bounded event queue

リアルタイム音声(RTC)#

  • エントリポイント:onesay_esp32_rtc_prepare, onesay_esp32_rtc_connect_audio, onesay_esp32_rtc_read_media_status, onesay_esp32_rtc_read_binding, onesay_esp32_rtc_close
  • トランスポート:OneSay RTC binding over the pinned official ESP32 runtime behind one internal adapter
  • 結果:RTC audio, packet send, stream receive, RPC callee and explicit Agent Control

ケイパビリティ#

ケイパビリティ対応状況詳細
タスク音声(WSS、ACK、リプレイ、再開)対応Supported
RTCオーディオ対応RTC audio owner
パケット一部対応Send only
ストリーム一部対応Receive only
RPC一部対応Callee only (answers 1–4 app.* methods, replies to the original caller only); no caller
DataTrack未対応ESP32では未対応
Agent対応Explicit Agent Control (create, get, stop)
状態、デバイス、エラー、解放対応Binding and media status, OneSay error codes, close
選択モードのメディア暗号化未対応Unsupported: any selected value is refused before any request

公開しないもの:native room or track handles、native token or connection material、the upstream ESP32 runtime API。未対応のケイパビリティは明示的なエラーで失敗します。

SDKのケイパビリティと互換性も参照してください。

元のMarkdownを表示
# ESP32 SDK

- コンポーネント:ESP-IDF向けの`onesay-esp32`
- 音声:16000 Hz、モノラル、`pcm_s16le`、40 msのフレーム
- リプレイバッファー:既定で3000 ms(96000バイト)。オーバーフローはエラーとして報告し、黙って破棄することはありません
- 認証情報:ファームウェアが提供するセキュアストアのインターフェイスから読み取ります
- ネットワーク:ESP-IDFによるTLS WebSocket
- 音声入力:ファームウェアが渡すPCM。SDKは音声をキャプチャしません

このSDKは固定容量のCクライアントです。接続のバインド、音声のフレーム化、ACKの処理、未確認の音声のリプレイ、イベントの順序付け、コールバックのディスパッチ、再接続を担当します。音声、認証情報のストア、ハードウェアのドライバーはファームウェアが提供します。

## タスク音声

- エントリポイント:`onesay_client_init`, `onesay_client_connect`, `onesay_client_start_dictation`, `onesay_client_write_audio`, `onesay_client_replay_unacked`, `onesay_client_reconnect`, `onesay_client_end_signal`, `onesay_client_dispatch`, `onesay_client_disconnect`
- トランスポート:onesay.realtime.v1 WebSocket with canonical PCM frames, contiguous ACK, unacked-only replay and bounded resume
- 結果:Task events through the bounded event queue

## リアルタイム音声(RTC)

- エントリポイント:`onesay_esp32_rtc_prepare`, `onesay_esp32_rtc_connect_audio`, `onesay_esp32_rtc_read_media_status`, `onesay_esp32_rtc_read_binding`, `onesay_esp32_rtc_close`
- トランスポート:OneSay RTC binding over the pinned official ESP32 runtime behind one internal adapter
- 結果:RTC audio, packet send, stream receive, RPC callee and explicit Agent Control

## ケイパビリティ

| ケイパビリティ | 対応状況 | 詳細 |
|---|---|---|
| タスク音声(WSS、ACK、リプレイ、再開) | 対応 | Supported |
| RTCオーディオ | 対応 | RTC audio owner |
| パケット | 一部対応 | Send only |
| ストリーム | 一部対応 | Receive only |
| RPC | 一部対応 | Callee only (answers 1–4 `app.*` methods, replies to the original caller only); no caller |
| DataTrack | 未対応 | ESP32では未対応 |
| Agent | 対応 | Explicit Agent Control (create, get, stop) |
| 状態、デバイス、エラー、解放 | 対応 | Binding and media status, OneSay error codes, close |
| 選択モードのメディア暗号化 | 未対応 | Unsupported: any selected value is refused before any request |

公開しないもの:native room or track handles、native token or connection material、the upstream ESP32 runtime API。未対応のケイパビリティは明示的なエラーで失敗します。

[SDKのケイパビリティと互換性](sdk-compatibility.md)も参照してください。