AudioRecordStream

コンストラクタ

new AudioRecordStream()

new AudioRecordStream(id): AudioRecordStream

新しいAudioRecordStreamインスタンスを作成します。このコンストラクターは直接呼び出さないでください。AudioRecordStreamBuilder.AudioRecordStreamBuilder.buildAsyncを使用してインスタンスを作成します。

パラメーター

id

number

内部ストリーム識別子

戻り値

AudioRecordStream

プロパティ

streamId

streamId: number

メソッド

flushAsync()

flushAsync(): Promise<AudioStatus>

レコードバッファをフラッシュし、未読データをすべて破棄します。

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

• STATUS_NO_ERROR (0)： フラッシュされました
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

getAudioConfigAsync()

getAudioConfigAsync(): Promise<AudioConfig>

録音ストリームの現在のオーディオ構成を取得します。

戻り値

Promise<AudioConfig>

Promiseは、以下を含むAudioConfigオブジェクトに解決されます。

• sampleRate： Hz単位の現在のサンプルレート
• channelMask： 現在のチャネル構成
• format： 現在のサンプルフォーマット。 または、次の値で拒否します。
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

getAudioEffectSessionIdAsync()

getAudioEffectSessionIdAsync(): Promise<number>

このストリームに関連付けられているカスタムオーディオエフェクトセッションIDを取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

• 正の値： エフェクトセッションID
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_BAD_VALUE (-2)： エフェクトセッションが割り当てられていません

---

getAudioFlagsAsync()

getAudioFlagsAsync(): Promise<number>

このストリームに構成されているオーディオフラグを取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

• AudioFlags値のビット単位の組み合わせ
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

getAudioSourceAsync()

getAudioSourceAsync(): Promise<AudioSource>

このストリームに構成されているオーディオソースタイプを取得します。

戻り値

Promise<AudioSource>

Promiseは以下に解決されます。

• 現在のソースを示すAudioSource列挙値。 または、次の値で拒否します。
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

getChannelCountAsync()

getChannelCountAsync(): Promise<number>

録音ストリームのチャネル数を取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

• 正の値： チャネル数
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

getLatencyInMsAsync()

getLatencyInMsAsync(): Promise<number>

録音ストリームの現在のレイテンシをミリ秒単位で取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

• 正の値： ミリ秒単位のレイテンシ
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

getMinBufferSizeInBytesAsync()

getMinBufferSizeInBytesAsync(): Promise<number>

録音に必要な最小バッファサイズを取得します。readAsync呼び出しでは、録音の信頼性を高めるために、これ以上のサイズを使用する必要があります。

戻り値

Promise<number>

Promiseは以下に解決されます。

• 正の値： バイト単位の最小バッファサイズ
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

getNumBytesInPipelineAsync()

getNumBytesInPipelineAsync(): Promise<number>

現時点で録音パイプラインにあるバイトの数を取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

• 正の値： パイプラインにあるバイトの数
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

getNumBytesOfNativeBufferAsync()

getNumBytesOfNativeBufferAsync(): Promise<number>

録音に使用されるネイティブバッファのサイズを取得します。バッファできるデータの最大量を表します。

戻り値

Promise<number>

Promiseは以下に解決されます。

• 正の値： バイト単位のバッファサイズ
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

getSampleRateAsync()

getSampleRateAsync(): Promise<number>

録音ストリームのサンプルレートを取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

• 正の値： Hz単位のサンプルレート
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

getSampleSizeAsync()

getSampleSizeAsync(): Promise<number>

録音ストリームのサンプルサイズをビット単位で取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

• 正の値： ビット単位のサンプルサイズ（例：16、24、32）
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

initCheckAsync()

initCheckAsync(): Promise<AudioStatus>

録音ストリームが適切に初期化されているか確認します。ストリームを確実に準備するには、ほかのメソッドを使用する前に呼び出す必要があります。

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

• STATUS_NO_ERROR (0)： ストリームは適切に初期化されています
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

readAsync()

readAsync(bytes): Promise<ArrayBuffer>

録音ストリームからオーディオデータを読み取ります。必要な権限：com.amazon.audio.privilege.microphone.access

パラメーター

bytes

number

読み込むバイト数。getMinBufferSizeInBytesAsyncによって返される値以上の値である必要があります。

戻り値

Promise<ArrayBuffer>

Promiseは以下に解決されます。

• 録音されたオーディオデータを含むArrayBuffer。 または、次の値で拒否します。
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_BAD_VALUE (-2)： bytesパラメーターが無効です
• STATUS_PERMISSION_DENIED (-9)： マイク権限がありません
• STATUS_INVALID_OPERATION (-8)： 読み取り操作が失敗しました
• STATUS_DEAD_OBJECT (-5)： サーバー通信エラー

---

registerEventObserverAsync()

registerEventObserverAsync(callback): Promise<AudioStatus>

録音ストリームイベントを受け取るコールバックを登録します。一度に登録できるコールバックは1つだけです。

パラメーター

callback

(value) => void

イベントを受け取る関数。イベントには以下のものがあります。

• DIED (0)： ストリームが失敗しました
• RECOVERED (1)： ストリームが障害から回復しました
• MUTE_STATE_CHANGED (2)： ストリームのミュート状態が変更されました

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

• STATUS_NO_ERROR (0)： コールバックが登録されました
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_BAD_VALUE (-2)： コールバックが無効です
• STATUS_ALREADY_EXISTS (-4)： コールバックは既に登録されています

---

unregisterEventObserverAsync()

unregisterEventObserverAsync(): Promise<AudioStatus>

以前に登録されたイベントコールバックの登録を解除します。

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

• STATUS_NO_ERROR (0)： コールバックの登録が解除されました
• STATUS_NO_INIT (-3)： ストリームが初期化されていません
• STATUS_BAD_VALUE (-2)： 登録されたコールバックはありません

---

getMajorVersion()

static getMajorVersion(): number

AudioRecordStream実装のメジャーバージョン番号を取得します。バージョンの確認に使用できます。

戻り値

number

メジャーバージョン番号

---

getMinorVersion()

static getMinorVersion(): number

AudioRecordStream実装のマイナーバージョン番号を取得します。バージョンの確認に使用できます。

戻り値

number

マイナーバージョン番号

---

getPatchVersion()

static getPatchVersion(): number

AudioRecordStream実装のパッチバージョン番号を取得します。バージョンの確認に使用できます。

戻り値

number

パッチのバージョン番号

---

Last updated: 2025年10月2日