AudioConfig class

パッケージ:

microsoft-cognitiveservices-speech-sdk

使用する入力の種類 (マイク、ファイル、ストリーム) を指定するために使用されるオーディオ入力構成を表します。

メソッド

close()	オブジェクトにアタッチされている外部リソースを明示的に解放します
fromAudioFileOutput(PathLike)	指定した出力オーディオ ファイルを表す AudioConfig オブジェクトを作成します
fromDefaultMicrophoneInput()	システム上の既定のマイクを表す AudioConfig オブジェクトを作成します。
fromDefaultSpeakerOutput()	既定のスピーカーを表す AudioConfig オブジェクトを作成します。
fromMicrophoneInput(string)	指定したデバイス ID を持つマイクを表す AudioConfig オブジェクトを作成します。
fromSpeakerOutput(IPlayer)	カスタム IPlayer オブジェクトを表す AudioConfig オブジェクトを作成します。 IPlayer オブジェクトを使用して、一時停止、再開などを制御できます。
fromStreamInput(AudioInputStream | PullAudioInputStreamCallback | MediaStream)	指定したストリームを表す AudioConfig オブジェクトを作成します。
fromStreamOutput(AudioOutputStream | PushAudioOutputStreamCallback)	指定したオーディオ出力ストリームを表す AudioConfig オブジェクトを作成します
fromWavFileInput(File | Buffer, string)	指定したファイルを表す AudioConfig オブジェクトを作成します。
getProperty(string, string)	任意のプロパティの現在の値を返します。
setProperty(string, string)	任意のプロパティを設定します。

メソッドの詳細

close()

オブジェクトにアタッチされている外部リソースを明示的に解放します

function close()

fromAudioFileOutput(PathLike)

指定した出力オーディオ ファイルを表す AudioConfig オブジェクトを作成します

static function fromAudioFileOutput(filename: PathLike): AudioConfig

パラメーター

filename

PathLike

出力オーディオ ファイルのファイル名

戻り値

AudioConfig

作成されるオーディオ出力構成。 バージョン 1.11.0 で追加されました

fromDefaultMicrophoneInput()

システム上の既定のマイクを表す AudioConfig オブジェクトを作成します。

static function fromDefaultMicrophoneInput(): AudioConfig

戻り値

AudioConfig

作成されるオーディオ入力構成。

fromDefaultSpeakerOutput()

既定のスピーカーを表す AudioConfig オブジェクトを作成します。

static function fromDefaultSpeakerOutput(): AudioConfig

戻り値

AudioConfig

作成されるオーディオ出力構成。 バージョン 1.11.0 で追加されました

fromMicrophoneInput(string)

指定したデバイス ID を持つマイクを表す AudioConfig オブジェクトを作成します。

static function fromMicrophoneInput(deviceId?: string): AudioConfig

パラメーター

deviceId

string

使用するマイクのデバイス ID を指定します。 既定のマイクが使用され、値は省略されます。

戻り値

AudioConfig

作成されるオーディオ入力構成。

fromSpeakerOutput(IPlayer)

カスタム IPlayer オブジェクトを表す AudioConfig オブジェクトを作成します。 IPlayer オブジェクトを使用して、一時停止、再開などを制御できます。

static function fromSpeakerOutput(player?: IPlayer): AudioConfig

パラメーター

player

IPlayer

再生用の IPlayer オブジェクト。

戻り値

AudioConfig

作成されるオーディオ出力構成。 バージョン 1.12.0 で追加されました

fromStreamInput(AudioInputStream | PullAudioInputStreamCallback | MediaStream)

指定したストリームを表す AudioConfig オブジェクトを作成します。

static function fromStreamInput(audioStream: AudioInputStream | PullAudioInputStreamCallback | MediaStream): AudioConfig

パラメーター

audioStream

AudioInputStream | PullAudioInputStreamCallback | MediaStream

カスタム オーディオ入力ストリームを指定します。 現時点では、WAV/PCM のみがサポートされています。

戻り値

AudioConfig

作成されるオーディオ入力構成。

fromStreamOutput(AudioOutputStream | PushAudioOutputStreamCallback)

指定したオーディオ出力ストリームを表す AudioConfig オブジェクトを作成します

static function fromStreamOutput(audioStream: AudioOutputStream | PushAudioOutputStreamCallback): AudioConfig

パラメーター

audioStream

AudioOutputStream | PushAudioOutputStreamCallback

カスタム オーディオ出力ストリームを指定します。

戻り値

AudioConfig

作成されるオーディオ出力構成。 バージョン 1.11.0 で追加されました

fromWavFileInput(File | Buffer, string)

指定したファイルを表す AudioConfig オブジェクトを作成します。

static function fromWavFileInput(file: File | Buffer, name?: string): AudioConfig

パラメーター

file

File | Buffer

name

string

戻り値

AudioConfig

作成されるオーディオ入力構成。

getProperty(string, string)

任意のプロパティの現在の値を返します。

function getProperty(name: string, def?: string): string

パラメーター

name

string

クエリを実行するプロパティの名前。

def

string

プロパティが不明な場合に返す値。

戻り値

string

指定されたプロパティの現在の値 (指定された既定値)。

setProperty(string, string)

任意のプロパティを設定します。

function setProperty(name: string, value: string)

パラメーター

name

string

設定するプロパティの名前。

value

string

プロパティの新しい値。