SpeechConfig クラス
音声/意図認識、または音声合成の構成を定義するクラス。
メンバー
EmbeddedSpeechConfig
構文: public friend EmbeddedSpeechConfig;
HybridSpeechConfig
構文: public friend HybridSpeechConfig;
演算子 SPXSPEECHCONFIGHANDLE
構文: public inline explicit operator SPXSPEECHCONFIGHANDLE ( ) const;
基になるハンドル値を取得するために使用される内部演算子。
戻り値
ハンドル。
SetSpeechRecognitionLanguage
構文: public inline void SetSpeechRecognitionLanguage ( const std::string & lang );
入力言語を音声認識エンジンに設定します。
パラメーター
-
langBCP-47 形式で認識される音声言語の名前を指定します。
GetSpeechRecognitionLanguage
構文: public inline std::string GetSpeechRecognitionLanguage ( ) const;
音声認識への入力言語を取得します。 言語は BCP-47 形式で指定されています。
戻り値
音声認識言語。
SetSpeechSynthesisLanguage
構文: public inline void SetSpeechSynthesisLanguage ( const std::string & lang );
音声シンセサイザーの言語を設定します。 バージョン 1.4.0 で追加されました。
パラメーター
-
lang言語の名前を指定します (例: en-US)
GetSpeechSynthesisLanguage
構文: public inline std::string GetSpeechSynthesisLanguage ( ) const;
音声シンセサイザーの言語を取得します。 バージョン 1.4.0 で追加されました。
戻り値
音声合成言語。
SetSpeechSynthesisVoiceName
構文: public inline void SetSpeechSynthesisVoiceName ( const std::string & voiceName );
音声シンセサイザーの音声を設定します。 バージョン 1.4.0 で追加されました。
パラメーター
-
voiceName音声の名前を指定します
GetSpeechSynthesisVoiceName
構文: public inline std::string GetSpeechSynthesisVoiceName ( ) const;
音声シンセサイザーの音声を取得します。 バージョン 1.4.0 で追加されました。
戻り値
音声合成音声名。
SetSpeechSynthesisOutputFormat
構文: public inline void SetSpeechSynthesisOutputFormat ( SpeechSynthesisOutputFormat formatId );
音声合成出力形式 (Riff16Khz16BitMonoPcm など) を設定します。 バージョン 1.4.0 で追加されました。
パラメーター
-
formatId出力形式 ID を指定します
GetSpeechSynthesisOutputFormat
構文: public inline std::string GetSpeechSynthesisOutputFormat ( ) const;
音声合成出力形式を取得します。 バージョン 1.4.0 で追加されました。
戻り値
音声合成出力形式。
SetEndpointId
構文: public inline void SetEndpointId ( const std::string & endpointId );
Custom Speech または Custom Voice のエンドポイント ID を設定します。
パラメーター
-
endpointIdエンドポイント ID。
GetEndpointId
構文: public inline std::string GetEndpointId ( ) const;
Custom Speech または Custom Voice のエンドポイント ID を取得します。
戻り値
エンドポイント ID。
SetAuthorizationToken
構文: public inline void SetAuthorizationToken ( const std::string & token );
サービスに接続する承認トークンを設定します。 注: 呼び出し元は、承認トークンが有効であることを確認する必要があります。 認証トークンの有効期限が切れる前に、呼び出し元は、新しい有効なトークンを使用してこのセッターを呼び出すことによって、認証トークンを更新する必要があります。 新しい認識エンジンの作成時に構成値がコピーされるため、新しいトークン値は既に作成されている認識エンジンには適用されません。 以前に作成された認識エンジンの場合、トークンを更新するには、対応する認識エンジンの承認トークンを設定する必要があります。 それ以外の場合、認識中に認識エンジンでエラーが発生します。
パラメーター
-
token承認トークン。
GetAuthorizationToken
構文: public inline std::string GetAuthorizationToken ( ) const;
サービスに接続するための承認トークンを取得します。
戻り値
承認トークン。
GetSubscriptionKey
構文: public inline std::string GetSubscriptionKey ( ) const;
Speech Recognizer または Intent Recognizer、Translation Recognizer、Speech シンセサイザーの作成に使用されるサブスクリプション キーを取得します。
戻り値
サブスクリプション キー。
GetRegion
構文: public inline std::string GetRegion ( ) const;
Speech Recognizer または Intent Recognizer、Translation Recognizer、Speech シンセサイザーの作成に使用するリージョン キーを取得します。
戻り値
地域。
GetOutputFormat
構文: public inline OutputFormat GetOutputFormat ( ) const;
音声認識の出力形式 (単純または詳細) を取得します。 注: この出力形式は音声認識の結果を対象とします。合成されたオーディオ出力形式を取得するには、 SpeechConfig::GetSpeechSynthesisOutputFormat を使用します。
戻り値
音声認識の出力形式。
SetOutputFormat
構文: public inline void SetOutputFormat ( OutputFormat format );
音声認識の出力形式 (単純または詳細) を設定します。 注: この出力形式は音声認識の結果用です。合成オーディオ出力形式を設定するには、 SpeechConfig::SetSpeechSynthesisOutputFormat を使用します。
パラメーター
-
format音声認識の出力形式
SetProfanity
構文: public inline void SetProfanity ( ProfanityOption profanity );
不適切な表現オプションを設定します。 バージョン 1.5.0 で追加されました。
パラメーター
-
profanity不適切な表現オプションの値。
EnableAudioLogging
構文: public inline void EnableAudioLogging ( );
サービスでオーディオ ログを有効にします。 バージョン 1.5.0 で追加されました。
オーディオ ログとコンテンツ ログは、Microsoft が所有するストレージ、または Cognitive Services サブスクリプションにリンクされている独自のストレージ アカウント (Bring Your Own Storage (BYOS) 対応 Speech リソース) のいずれかに格納されます。
RequestWordLevelTimestamps
構文: public inline void RequestWordLevelTimestamps ( );
応答結果に単語レベルのタイムスタンプが含まれます。 バージョン 1.5.0 で追加されました。
EnableDictation
構文: public inline void EnableDictation ( );
ディクテーション モードを有効にします。 音声認識でのみサポートされます。 バージョン 1.5.0 で追加されました。
SetProxy
構文: public inline void SetProxy ( const std::string & proxyHostName , uint32_t proxyPort , const std::string & proxyUserName , const std::string & proxyPassword );
バージョン 1.1.0 で追加されたプロキシ構成を設定します。
注: macOS ではプロキシ機能を使用できません。 この関数は、このプラットフォームには影響しません。
パラメーター
proxyHostNameプロトコル スキームを使用しないプロキシ サーバーのホスト名 ([http://](http://))proxyPortプロキシ サーバーのポート番号proxyUserNameプロキシ サーバーのユーザー名proxyPasswordプロキシ サーバーのパスワード
SetProperty
構文: public inline void SetProperty ( const std::string & name , const std::string & value );
名前でプロパティ値を設定します。
パラメーター
nameプロパティ名。valueプロパティ値。
GetProperty
構文: public inline std::string GetProperty ( const std::string & name ) const;
名前でプロパティ値を取得します。
パラメーター
-
nameパラメーター名。
戻り値
プロパティ値。
GetProperty
構文: public inline std::string GetProperty ( PropertyId id ) const;
ID でプロパティ値を取得します。
パラメーター
-
idパラメーター ID。
戻り値
プロパティ値。
SetProperty
構文: public inline void SetProperty ( PropertyId id , const std::string & value );
ID でプロパティ値を設定します。
パラメーター
idプロパティ ID。valueプロパティ値。
SetServiceProperty
構文: public inline void SetServiceProperty ( const std::string & name , const std::string & value , ServicePropertyChannel channel );
指定したチャネルを使用してサービスに渡されるプロパティ値を設定します。 バージョン 1.5.0 で追加されました。
パラメーター
nameプロパティ名。valueプロパティ値。channel指定したプロパティをサービスに渡すために使用されるチャネル。
~SpeechConfig
構文: public inline virtual ~SpeechConfig ( );
オブジェクトを破棄します。
FromSubscription
構文: public inline static std::shared_ptr< SpeechConfig > FromSubscription ( const std::string & subscription , const std::string & region );
指定したサブスクリプション キーとリージョンを使用して、音声構成のインスタンスを作成します。
パラメーター
subscriptionサブスクリプション キー。regionリージョン名 ( リージョン ページを参照)。
戻り値
新しい音声構成インスタンスへの共有ポインター。
FromAuthorizationToken
構文: public inline static std::shared_ptr< SpeechConfig > FromAuthorizationToken ( const std::string & authToken , const std::string & region );
指定した承認トークンとリージョンを使用して、音声構成のインスタンスを作成します。 注: 呼び出し元は、承認トークンが有効であることを確認する必要があります。 認証トークンの有効期限が切れる前に、呼び出し元は、新しい有効なトークンを使用してこのセッターを呼び出すことによって、認証トークンを更新する必要があります。 新しい認識エンジンの作成時に構成値がコピーされるため、新しいトークン値は既に作成されている認識エンジンには適用されません。 以前に作成された認識エンジンの場合、トークンを更新するには、対応する認識エンジンの承認トークンを設定する必要があります。 そうしないと、認識中に認識エンジンでエラーが発生します。
パラメーター
authToken承認トークン。regionリージョン名 ( リージョン ページを参照)。
戻り値
新しい音声構成インスタンスへの共有ポインター。
FromEndpoint
構文: public inline static std::shared_ptr< SpeechConfig > FromEndpoint ( const std::string & endpoint , const std::string & subscription );
エンドポイントとサブスクリプションを指定して音声構成のインスタンスを作成します。 このメソッドは、標準以外のサービス エンドポイントを使用するユーザーのみを対象としています。 注: エンドポイント URI で指定されたクエリ パラメーターは、他の API によって設定されている場合でも変更されません。 たとえば、認識言語が URI でクエリ パラメーター "language=de-DE" として定義され、SetSpeechRecognitionLanguage("en-US") によっても設定されている場合、URI の言語設定が優先され、有効な言語は "de-DE" になります。 他の API では、エンドポイント URI で指定されていないパラメーターのみを設定できます。 注: FromEndpoint で承認トークンを使用するには、FromEndpoint(const SPXSTRING&) を使用し、作成された SpeechConfig インスタンスで SetAuthorizationToken() を呼び出します。
パラメーター
endpoint接続するサービス エンドポイント。subscriptionサブスクリプション キー。
戻り値
新しい音声構成インスタンスへの共有ポインター。
FromEndpoint
構文: public inline static std::shared_ptr< SpeechConfig > FromEndpoint ( const std::string & endpoint );
指定したエンドポイントを使用して SpeechConfig のインスタンスを作成します。 このメソッドは、標準以外のサービス エンドポイントを使用するユーザーのみを対象としています。 注: エンドポイント URI で指定されたクエリ パラメーターは、他の API によって設定されている場合でも変更されません。 特定のクエリ パラメーターがサポートされているかどうかは、エンドポイントとシナリオによって異なります。 たとえば、認識言語が URI でクエリ パラメーター "language=de-DE" として定義され、SetSpeechRecognitionLanguage("en-US") によっても設定されている場合、URI の言語設定が優先され、有効な言語は "de-DE" になります。 この例は、エンドポイントとシナリオの組み合わせでクエリ パラメーターとして言語がサポートされている場合にのみ適用されます。 他の API では、エンドポイント URI で指定されていないパラメーターのみを設定できます。 注: エンドポイントで認証にサブスクリプション キーが必要な場合は、FromEndpoint(const SPXSTRING&、const SPXSTRING&) を使用して、サブスクリプション キーをパラメーターとして渡します。 FromEndpoint で承認トークンを使用するには、このメソッドを使用して SpeechConfig インスタンスを作成し、作成された SpeechConfig インスタンスで SetAuthorizationToken() を呼び出します。 注: バージョン 1.5.0 で追加されました。
パラメーター
-
endpoint接続するサービス エンドポイント URI。
戻り値
新しい音声構成インスタンスへの共有ポインター。
FromHost
構文: public inline static std::shared_ptr< SpeechConfig > FromHost ( const std::string & host , const std::string & subscription );
指定したホストとサブスクリプションを使用して音声構成のインスタンスを作成します。 このメソッドは、既定以外のサービス ホストを使用するユーザーのみを対象としています。 標準リソース パスが想定されます。 標準以外のリソース パスを持つサービスまたはパスがまったくないサービスの場合は、代わりに FromEndpoint を使用します。 注: クエリ パラメーターはホスト URI では許可されず、他の API で設定する必要があります。 注: FromHost で承認トークンを使用するには、FromHost(const SPXSTRING&) を使用し、作成された SpeechConfig インスタンスで SetAuthorizationToken() を呼び出します。 注: バージョン 1.8.0 で追加されました。
パラメーター
host接続するサービス ホスト。 形式は "protocol://host:port" で、":p ort" は省略可能です。subscriptionサブスクリプション キー。
戻り値
新しい音声構成インスタンスへの共有ポインター。
FromHost
構文: public inline static std::shared_ptr< SpeechConfig > FromHost ( const std::string & host );
指定したホストを使用して SpeechConfig のインスタンスを作成します。 このメソッドは、既定以外のサービス ホストを使用するユーザーのみを対象としています。 標準リソース パスが想定されます。 標準以外のリソース パスを持つサービスまたはパスがまったくないサービスの場合は、代わりに FromEndpoint を使用します。 注: クエリ パラメーターはホスト URI では許可されず、他の API で設定する必要があります。 注: ホストで認証にサブスクリプション キーが必要な場合は、FromHost(const SPXSTRING&、const SPXSTRING&) を使用して、サブスクリプション キーをパラメーターとして渡します。 FromHost で承認トークンを使用するには、このメソッドを使用して SpeechConfig インスタンスを作成し、作成された SpeechConfig インスタンスで SetAuthorizationToken() を呼び出します。 注: バージョン 1.8.0 で追加されました。
パラメーター
-
host接続するサービス ホスト URI。 形式は "protocol://host:port" で、":p ort" は省略可能です。
戻り値
新しい音声構成インスタンスへの共有ポインター。