類別 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 );

將輸入語言設定為語音辨識器。

參數

  • lang 指定要以 BCP-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 指定輸出格式識別碼

GetSpeechSynthesisOutputFormat

語法： public inline std::string GetSpeechSynthesisOutputFormat ( ) const;

取得語音合成輸出格式。 已在1.4.0版中新增。

傳回

語音合成輸出格式。

SetEndpointId

語法： public inline void SetEndpointId ( const std::string & endpointId );

設定自訂語音或自訂語音的端點標識碼。

參數

  • endpointId 端點標識碼。

GetEndpointId

語法： public inline std::string GetEndpointId ( ) const;

取得自訂語音或自訂語音的端點標識碼。

傳回

端點標識碼。

SetAuthorizationToken

語法： public inline void SetAuthorizationToken ( const std::string & token );

設定要連線至服務的授權令牌。 注意：呼叫端必須確定授權令牌有效。 授權令牌到期之前，呼叫端必須使用新的有效令牌呼叫這個 setter 來重新整理它。 當建立新的辨識器時複製組態值時，新的令牌值將不會套用至已建立的辨識器。 對於先前建立的辨識器，您必須設定對應辨識器的授權令牌，以重新整理令牌。 否則，辨識器會在辨識期間發生錯誤。

參數

  • token 授權令牌。

GetAuthorizationToken

語法： public inline std::string GetAuthorizationToken ( ) const;

取得要連線至服務的授權令牌。

傳回

授權令牌。

GetSubscriptionKey

語法： public inline std::string GetSubscriptionKey ( ) const;

取得用來建立語音辨識器或意圖辨識器或翻譯辨識器或語音合成器的訂用帳戶密鑰。

傳回

訂用帳戶金鑰。

GetRegion

語法： public inline std::string GetRegion ( ) const;

取得用來建立語音辨識器或意圖辨識器或翻譯辨識器或語音合成器的區域索引鍵。

傳回

區域。

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 擁有的記憶體，或連結到認知服務訂用帳戶的記憶體帳戶中， (自備記憶體 (BYOS) 啟用語音資源) 。

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 版中新增的 Proxy 組態。

注意：macOS 上無法使用 Proxy 功能。 此函式不會影響此平臺。

參數

  • proxyHostName Proxy 伺服器的主機名，不含通訊協定配置 ([http://](http://))

  • proxyPort Proxy 伺服器的埠號碼

  • proxyUserName Proxy 伺服器的用戶名稱

  • proxyPassword Proxy 伺服器的密碼

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 參數標識碼。

傳回

屬性值。

SetProperty

語法： public inline void SetProperty ( PropertyId id , const std::string & value );

依標識碼設定屬性值。

參數

  • 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 );

使用指定的授權令牌和區域，建立語音設定的實例。 注意：呼叫端必須確定授權令牌有效。 授權令牌到期之前，呼叫端必須使用新的有效令牌呼叫這個 setter 來重新整理它。 當建立新的辨識器時複製組態值時，新的令牌值將不會套用至已建立的辨識器。 針對先前建立的辨識器，您必須設定對應辨識器的授權令牌以重新整理令牌。 否則，辨識器會在辨識期間發生錯誤。

參數

  • 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」 是選擇性的。

傳回

新語音設定實例的共享指標。