SpeechConfig クラス

パッケージ:

com.microsoft.cognitiveservices.speech

Maven 成果物:

com.microsoft.cognitiveservices.speech:client-sdk:1.32.1

• java.lang.Object
• • com.microsoft.cognitiveservices.speech.SpeechConfig

実装

java.lang.AutoCloseable

public class SpeechConfig
implements java.lang.AutoCloseable

音声の構成。 注: オブジェクトによって保持されている基になるリソースを解放するには、close() を呼び出す必要があります。 バージョン 1.7.0 で変更されました

フィールドの概要

修飾子と型	フィールドと説明
static java.lang.Class<?>	speechConfigClass ネイティブ ライブラリを読み込むアクセサー。

コンストラクターの概要

修飾子	コンストラクター	説明
protected	SpeechConfig(long handleValue)	音声構成オブジェクトの内部コンストラクター。

メソッドの概要

修飾子と型	メソッドと説明
void	close() 関連付けられているリソースを破棄します。
void	enableAudioLogging() サービスでオーディオ ログを有効にします。
void	enableDictation() ディクテーションを有効にします。
static SpeechConfig	fromAuthorizationToken(String authorizationToken, String region) 指定した承認トークンとサービス リージョンを使用して、音声構成のインスタンスを作成します。
static SpeechConfig	fromEndpoint(URI endpoint) 指定したエンドポイントを使用して音声構成のインスタンスを作成します。
static SpeechConfig	fromEndpoint(URI endpoint, String subscriptionKey) 指定したエンドポイントとサブスクリプション キーを使用して、音声構成のインスタンスを作成します。
static SpeechConfig	fromHost(URI host) 指定したホストを使用して音声構成のインスタンスを作成します。
static SpeechConfig	fromHost(URI host, String subscriptionKey) 指定したホストキーとサブスクリプション キーを使用して、音声構成のインスタンスを作成します。
static SpeechConfig	fromSubscription(String subscriptionKey, String region) 指定したサブスクリプション キーとサービス リージョンを使用して、音声構成のインスタンスを作成します。
java.lang.String	getAuthorizationToken() 承認トークンを取得します。
java.lang.String	getEndpointId() 音声認識に使用されるカスタマイズされた音声モデル、または音声合成用のカスタム音声モデルのエンドポイント ID を取得します。
SafeHandle	getImpl() 音声構成オブジェクトへのネイティブ ハンドルを取得します。
OutputFormat	getOutputFormat() 音声認識の出力形式 (単純または詳細) を取得します。
java.lang.String	getProperty(PropertyId id) プロパティ ID でプロパティを取得します。
java.lang.String	getProperty(String name) 名前付きプロパティを値として取得します。
java.lang.String	getSpeechRecognitionLanguage() 音声認識言語を取得します
java.lang.String	getSpeechSynthesisLanguage() 音声合成言語を取得します。
java.lang.String	getSpeechSynthesisOutputFormat() 音声合成の出力形式を取得します。
java.lang.String	getSpeechSynthesisVoiceName() 音声合成音声名を取得します。
void	requestWordLevelTimestamps() 単語レベルのタイムスタンプが含まれます。
void	setAuthorizationToken(String value) 承認トークンを設定します。
void	setEndpointId(String value) 音声認識に使用されるカスタマイズされた音声モデルのエンドポイント ID、または音声合成用のカスタム音声モデルを設定します。
void	setOutputFormat(OutputFormat format) 音声認識の出力形式 (単純または詳細) を設定します。
void	setProfanity(ProfanityOption profanity) 不適切な表現オプションを設定します。
void	setProperty(PropertyId id, String value) プロパティ ID でプロパティを設定します。
void	setProperty(String name, String value) 名前付きプロパティを値として設定します。
void	setProxy(String proxyHostName, int proxyPort, String proxyUserName, String proxyPassword) バージョン 1.1.0 で追加されたプロキシ構成を設定します。
void	setServiceProperty(String name, String value, ServicePropertyChannel channel) 指定したチャネルを使用してサービスに渡されるプロパティ値を設定します。
void	setSpeechRecognitionLanguage(String value) 音声認識言語を設定します
void	setSpeechSynthesisLanguage(String value) 音声合成言語を設定します。
void	setSpeechSynthesisOutputFormat(SpeechSynthesisOutputFormat value) 音声合成出力形式を設定します。
void	setSpeechSynthesisVoiceName(String value) 音声合成音声名を設定します。

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

フィールドの詳細

speechConfigClass

public static Class speechConfigClass

ネイティブ ライブラリを読み込むアクセサー。 アクティブなクラスを保持し、クラス GC がそれを再利用しないようにします (およびローカル変数!

コンストラクターの詳細

SpeechConfig

protected SpeechConfig(long handleValue)

音声構成オブジェクトの内部コンストラクター。

Parameters:

handleValue - ネイティブ ハンドル。

メソッドの詳細

close

public void close()

関連付けられているリソースを破棄します。

enableAudioLogging

public void enableAudioLogging()

サービスでオーディオ ログを有効にします。 オーディオログとコンテンツ ログは、Microsoft 所有のストレージ、または Cognitive Services サブスクリプションにリンクされた独自のストレージ アカウント (Bring Your Own Storage (BYOS) 対応 Speech リソース) に格納されます。 バージョン 1.5.0 で追加されました。

enableDictation

public void enableDictation()

ディクテーションを有効にします。 音声認識でのみサポートされます。 バージョン 1.5.0 で追加されました。

fromAuthorizationToken

public static SpeechConfig fromAuthorizationToken(String authorizationToken, String region)

指定した承認トークンとサービス リージョンを使用して、音声構成のインスタンスを作成します。 注: 呼び出し元は、承認トークンが有効であることを確認する必要があります。 認証トークンの有効期限が切れる前に、呼び出し元は、新しい有効なトークンを使用してこのセッターを呼び出すことによって、認証トークンを更新する必要があります。 新しい認識エンジンの作成時に構成値がコピーされるため、新しいトークン値は既に作成されている認識エンジンには適用されません。 以前に作成された認識エンジンの場合、トークンを更新するには、対応する認識エンジンの承認トークンを設定する必要があります。 それ以外の場合、認識中に認識エンジンでエラーが発生します。

Parameters:

authorizationToken - 承認トークン。

region - リージョン名 (リージョン ページを参照)。

Returns:

音声構成インスタンス。

fromEndpoint

public static SpeechConfig fromEndpoint(URI endpoint)

指定したエンドポイントを使用して音声構成のインスタンスを作成します。 このメソッドは、標準以外のサービス エンドポイントまたはパラメーターを使用するユーザーのみを対象としています。 注: エンドポイント URI で指定されたクエリ パラメーターは、他の API によって設定されている場合でも変更されません。 たとえば、認識言語が URI でクエリ パラメーター "language=de-DE" として定義され、setSpeechRecognitionLanguage("en-US") によっても設定されている場合、URI の言語設定が優先され、有効な言語は "de-DE" になります。 他の API では、エンドポイント URI で指定されていないパラメーターのみを設定できます。 注: エンドポイントで認証にサブスクリプション キーが必要な場合は、fromEndpoint(java.net.URI, String) を使用してサブスクリプション キーをパラメーターとして渡してください。 fromEndpoint で承認トークンを使用するには、このメソッドを使用して SpeechConfig インスタンスを作成し、作成された SpeechConfig インスタンスで setAuthorizationToken() を呼び出します。 注: バージョン 1.5.0 で追加されました。

Parameters:

endpoint - 接続するサービス エンドポイント。

Returns:

音声構成インスタンス。

fromEndpoint

public static SpeechConfig fromEndpoint(URI endpoint, String subscriptionKey)

指定したエンドポイントとサブスクリプション キーを使用して、音声構成のインスタンスを作成します。 このメソッドは、標準以外のサービス エンドポイントまたはパラメーターを使用するユーザーのみを対象としています。 注: エンドポイント URI で指定されたクエリ パラメーターは、他の API によって設定されている場合でも変更されません。 たとえば、認識言語が URI でクエリ パラメーター "language=de-DE" として定義され、setSpeechRecognitionLanguage("en-US") によっても設定されている場合、URI の言語設定が優先され、有効な言語は "de-DE" になります。 他の API では、エンドポイント URI で指定されていないパラメーターのみを設定できます。 注: fromEndpoint で承認トークンを使用するには、fromEndpoint(java.net.URI) を使用し、作成された SpeechConfig インスタンスで setAuthorizationToken() を呼び出してください。

Parameters:

endpoint - 接続するサービス エンドポイント。

subscriptionKey - サブスクリプション キー。

Returns:

音声構成インスタンス。

fromHost

public static SpeechConfig fromHost(URI host)

指定したホストを使用して音声構成のインスタンスを作成します。 このメソッドは、既定以外のサービス ホストを使用するユーザーのみを対象としています。 標準リソース パスが想定されます。 標準以外のリソース パスを持つサービス、またはパスがまったくないサービスの場合は、代わりに fromEndpoint を使用してください。 注: クエリ パラメーターはホスト URI では許可されず、他の API で設定する必要があります。 注: ホストで認証にサブスクリプション キーが必要な場合は、fromHost(java.net.URI, String) を使用してサブスクリプション キーをパラメーターとして渡します。 fromHost で承認トークンを使用するには、このメソッドを使用して SpeechConfig インスタンスを作成し、作成された SpeechConfig インスタンスで setAuthorizationToken() を呼び出します。 注: バージョン 1.8.0 で追加されました。

Parameters:

host - 接続するサービス ホスト。 形式は "protocol://host:port" で、":p ort" は省略可能です。

Returns:

音声構成インスタンス。

fromHost

public static SpeechConfig fromHost(URI host, String subscriptionKey)

指定したホストキーとサブスクリプション キーを使用して、音声構成のインスタンスを作成します。 このメソッドは、既定以外のサービス ホストを使用するユーザーのみを対象としています。 標準リソース パスが想定されます。 標準以外のリソース パスを持つサービス、またはパスがまったくないサービスの場合は、代わりに fromEndpoint を使用してください。 注: クエリ パラメーターはホスト URI では許可されず、他の API で設定する必要があります。 注: fromHost で承認トークンを使用するには、fromHost(java.net.URI) を使用し、作成された SpeechConfig インスタンスで setAuthorizationToken() を呼び出します。 注: バージョン 1.8.0 で追加されました。

Parameters:

host - 接続するサービス ホスト。 形式は "protocol://host:port" で、":p ort" は省略可能です。

subscriptionKey - サブスクリプション キー。

Returns:

音声構成インスタンス。

fromSubscription

public static SpeechConfig fromSubscription(String subscriptionKey, String region)

指定したサブスクリプション キーとサービス リージョンを使用して、音声構成のインスタンスを作成します。

Parameters:

subscriptionKey - サブスクリプション キー。

region - リージョン名 ( リージョン ページを参照)。

Returns:

音声構成インスタンス。

getAuthorizationToken

public String getAuthorizationToken()

承認トークンを取得します。

Returns:

承認トークン。

getEndpointId

public String getEndpointId()

音声認識に使用されるカスタマイズされた音声モデル、または音声合成用のカスタム音声モデルのエンドポイント ID を取得します。

Returns:

エンドポイント ID。

getImpl

public SafeHandle getImpl()

音声構成オブジェクトへのネイティブ ハンドルを取得します。

Returns:

ネイティブ ハンドル。

getOutputFormat

public OutputFormat getOutputFormat()

音声認識の出力形式 (単純または詳細) を取得します。 注: この出力形式は音声認識の結果を対象とします。合成されたオーディオ出力形式を設定するために を使用 com.microsoft.cognitiveservices.speech.SpeechConfig#setSpeechSynthesisOutputFormat します。

Returns:

音声認識の出力形式を返します。

getProperty

public String getProperty(PropertyId id)

propertyId でプロパティを取得します。 バージョン 1.3.0 で追加されました。

Parameters:

id - プロパティの PropertyId。

Returns:

値。

getProperty

public String getProperty(String name)

名前付きプロパティを値として取得します。

Parameters:

name - プロパティの名前。

Returns:

値。

getSpeechRecognitionLanguage

public String getSpeechRecognitionLanguage()

音声認識言語を取得します

Returns:

認識言語を返します。

getSpeechSynthesisLanguage

public String getSpeechSynthesisLanguage()

音声合成言語を取得します。 バージョン 1.7.0 で追加されました

Returns:

合成言語を返します。

getSpeechSynthesisOutputFormat

public String getSpeechSynthesisOutputFormat()

音声合成の出力形式を取得します。 バージョン 1.7.0 で追加されました

Returns:

合成出力形式を返します。

getSpeechSynthesisVoiceName

public String getSpeechSynthesisVoiceName()

音声合成音声名を取得します。 バージョン 1.7.0 で追加されました

Returns:

合成音声名を返します。

requestWordLevelTimestamps

public void requestWordLevelTimestamps()

単語レベルのタイムスタンプが含まれます。 バージョン 1.5.0 で追加されました。

setAuthorizationToken

public void setAuthorizationToken(String value)

承認トークンを設定します。 注: 呼び出し元は、承認トークンが有効であることを確認する必要があります。 認証トークンの有効期限が切れる前に、呼び出し元は、新しい有効なトークンを使用してこのセッターを呼び出すことによって、認証トークンを更新する必要があります。 新しい認識エンジンの作成時に構成値がコピーされるため、新しいトークン値は既に作成されている認識エンジンには適用されません。 以前に作成された認識エンジンの場合、トークンを更新するには、対応する認識エンジンの承認トークンを設定する必要があります。 そうしないと、認識中に認識エンジンでエラーが発生します。

Parameters:

value - 承認トークン。

setEndpointId

public void setEndpointId(String value)

音声認識に使用されるカスタマイズされた音声モデル、または音声合成用のカスタム音声モデルのエンドポイント ID を設定します。

Parameters:

value - エンドポイント ID。

setOutputFormat

public void setOutputFormat(OutputFormat format)

音声認識の出力形式 (単純または詳細) を設定します。 注: この出力形式は音声認識の結果を対象とします。合成されたオーディオ出力形式を設定するために 使用 com.microsoft.cognitiveservices.speech.SpeechConfig#setSpeechSynthesisOutputFormat します。

Parameters:

format - 音声認識の出力形式。

setProfanity

public void setProfanity(ProfanityOption profanity)

不適切な表現オプションを設定します。 バージョン 1.5.0 で追加されました。

Parameters:

profanity - 設定するプロパティ オプション。

setProperty

public void setProperty(PropertyId id, String value)

propertyId でプロパティを設定します。 バージョン 1.3.0 で追加されました。

Parameters:

id - プロパティの PropertyId。

value - 値。

setProperty

public void setProperty(String name, String value)

名前付きプロパティを値として設定します。

Parameters:

name - プロパティの名前。

value - 値。

setProxy

public void setProxy(String proxyHostName, int proxyPort, String proxyUserName, String proxyPassword)

バージョン 1.1.0 で追加されたプロキシ構成を設定します。 注: プロキシ機能は macOS では使用できません。 この関数は、このプラットフォームには影響しません。

Parameters:

proxyHostName - プロトコル スキームを使用しないプロキシ サーバーのホスト名 (http://)

proxyPort - プロキシ サーバーのポート番号。

proxyUserName - プロキシ サーバーのユーザー名。 ユーザー名が必要ない場合は、空の文字列を使用します。

proxyPassword - プロキシ サーバーのパスワード。 ユーザー パスワードが必要ない場合は、空の文字列を使用します。

setServiceProperty

public void setServiceProperty(String name, String value, ServicePropertyChannel channel)

指定したチャネルを使用してサービスに渡されるプロパティ値を設定します。 バージョン 1.5.0 で追加されました。

Parameters:

name - プロパティ名。

value - プロパティ値。

channel - 指定したプロパティをサービスに渡すために使用されるチャネル。

setSpeechRecognitionLanguage

public void setSpeechRecognitionLanguage(String value)

音声認識言語を設定します

Parameters:

value - BCP-47 形式の言語識別子。

setSpeechSynthesisLanguage

public void setSpeechSynthesisLanguage(String value)

音声合成言語を設定します。 バージョン 1.7.0 で追加されました

Parameters:

value - BCP-47 形式の言語識別子 (en-US など)。

setSpeechSynthesisOutputFormat

public void setSpeechSynthesisOutputFormat(SpeechSynthesisOutputFormat value)

音声合成出力形式を設定します。 バージョン 1.7.0 で追加されました

Parameters:

value - 合成出力形式 ID (Riff16Khz16BitMonoPcm など)。

setSpeechSynthesisVoiceName

public void setSpeechSynthesisVoiceName(String value)

音声合成音声名を設定します。 バージョン 1.7.0 で追加されました

Parameters:

value - 音声合成音声名。