com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.yml

### YamlMime:JavaType
uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient"
fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient"
name: "VoiceProfileClient"
nameWithType: "VoiceProfileClient"
summary: "A voice profile client performs voice profile management for speaker recognition."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public final class **VoiceProfileClient**</br> implements <xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.VoiceProfileClient(com.microsoft.cognitiveservices.speech.SpeechConfig)"
  fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.VoiceProfileClient(SpeechConfig speechConfig)"
  name: "VoiceProfileClient(SpeechConfig speechConfig)"
  nameWithType: "VoiceProfileClient.VoiceProfileClient(SpeechConfig speechConfig)"
  summary: "Creates a new instance of a voice profile client."
  parameters:
  - description: "speech configuration."
    name: "speechConfig"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public VoiceProfileClient(SpeechConfig speechConfig)"
  desc: "Creates a new instance of a voice profile client."
methods:
- uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.close()"
  fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.close()"
  name: "close()"
  nameWithType: "VoiceProfileClient.close()"
  summary: "Dispose of associated resources."
  syntax: "public void close()"
  desc: "Dispose of associated resources. Note: close() must be called in order to release underlying resources held by the object."
- uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.createProfileAsync(com.microsoft.cognitiveservices.speech.speaker.VoiceProfileType,java.lang.String)"
  fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.createProfileAsync(VoiceProfileType voiceProfileType, String locale)"
  name: "createProfileAsync(VoiceProfileType voiceProfileType, String locale)"
  nameWithType: "VoiceProfileClient.createProfileAsync(VoiceProfileType voiceProfileType, String locale)"
  summary: "Creates a voice profile as an asynchronous operation."
  parameters:
  - description: "A voice profile type."
    name: "voiceProfileType"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfileType?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfileType&text=VoiceProfileType\" data-throw-if-not-resolved=\"False\" />"
  - description: "a locale, e.g \"en-us\"."
    name: "locale"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Future<VoiceProfile> createProfileAsync(VoiceProfileType voiceProfileType, String locale)"
  desc: "Creates a voice profile as an asynchronous operation."
  returns:
    description: "An asynchronous operation representing the result of creating a voice profile."
    type: "<xref href=\"java.util.concurrent.Future?alt=java.util.concurrent.Future&text=Future\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfile?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfile&text=VoiceProfile\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.deleteProfileAsync(com.microsoft.cognitiveservices.speech.speaker.VoiceProfile)"
  fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.deleteProfileAsync(VoiceProfile voiceProfile)"
  name: "deleteProfileAsync(VoiceProfile voiceProfile)"
  nameWithType: "VoiceProfileClient.deleteProfileAsync(VoiceProfile voiceProfile)"
  summary: "Delete a voice profile asynchronously."
  parameters:
  - description: "A voice profile."
    name: "voiceProfile"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfile?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfile&text=VoiceProfile\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Future<VoiceProfileResult> deleteProfileAsync(VoiceProfile voiceProfile)"
  desc: "Delete a voice profile asynchronously."
  returns:
    description: "An asynchronous operation representing the result of deleting a voice profile."
    type: "<xref href=\"java.util.concurrent.Future?alt=java.util.concurrent.Future&text=Future\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfileResult?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfileResult&text=VoiceProfileResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.enrollProfileAsync(com.microsoft.cognitiveservices.speech.speaker.VoiceProfile,com.microsoft.cognitiveservices.speech.audio.AudioConfig)"
  fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.enrollProfileAsync(VoiceProfile voiceProfile, AudioConfig audioConfig)"
  name: "enrollProfileAsync(VoiceProfile voiceProfile, AudioConfig audioConfig)"
  nameWithType: "VoiceProfileClient.enrollProfileAsync(VoiceProfile voiceProfile, AudioConfig audioConfig)"
  summary: "Enroll a voice profile asynchronously."
  parameters:
  - description: "A voice profile."
    name: "voiceProfile"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfile?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfile&text=VoiceProfile\" data-throw-if-not-resolved=\"False\" />"
  - description: "An audio config."
    name: "audioConfig"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.AudioConfig?alt=com.microsoft.cognitiveservices.speech.audio.AudioConfig&text=AudioConfig\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Future<VoiceProfileEnrollmentResult> enrollProfileAsync(VoiceProfile voiceProfile, AudioConfig audioConfig)"
  desc: "Enroll a voice profile asynchronously."
  returns:
    description: "An asynchronous operation representing the result of enrollment of a voice profile."
    type: "<xref href=\"java.util.concurrent.Future?alt=java.util.concurrent.Future&text=Future\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfileEnrollmentResult?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfileEnrollmentResult&text=VoiceProfileEnrollmentResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.getActivationPhrasesAsync(com.microsoft.cognitiveservices.speech.speaker.VoiceProfileType,java.lang.String)"
  fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.getActivationPhrasesAsync(VoiceProfileType voiceProfileType, String locale)"
  name: "getActivationPhrasesAsync(VoiceProfileType voiceProfileType, String locale)"
  nameWithType: "VoiceProfileClient.getActivationPhrasesAsync(VoiceProfileType voiceProfileType, String locale)"
  summary: "Get valid activation phrases for enrollment."
  parameters:
  - description: "A voice profile type."
    name: "voiceProfileType"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfileType?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfileType&text=VoiceProfileType\" data-throw-if-not-resolved=\"False\" />"
  - description: "a locale, e.g \"en-us\"."
    name: "locale"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Future<VoiceProfilePhraseResult> getActivationPhrasesAsync(VoiceProfileType voiceProfileType, String locale)"
  desc: "Get valid activation phrases for enrollment."
  returns:
    description: "An asynchronous operation representing the result of getting activation phrases."
    type: "<xref href=\"java.util.concurrent.Future?alt=java.util.concurrent.Future&text=Future\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfilePhraseResult?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfilePhraseResult&text=VoiceProfilePhraseResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.getAllProfilesAsync(com.microsoft.cognitiveservices.speech.speaker.VoiceProfileType)"
  fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.getAllProfilesAsync(VoiceProfileType voiceProfileType)"
  name: "getAllProfilesAsync(VoiceProfileType voiceProfileType)"
  nameWithType: "VoiceProfileClient.getAllProfilesAsync(VoiceProfileType voiceProfileType)"
  summary: "Get all voice profiles as an asynchronous operation."
  parameters:
  - description: "A voice profile type."
    name: "voiceProfileType"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfileType?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfileType&text=VoiceProfileType\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Future<List<VoiceProfile>> getAllProfilesAsync(VoiceProfileType voiceProfileType)"
  desc: "Get all voice profiles as an asynchronous operation."
  returns:
    description: "An asynchronous operation representing the result of getting all voice profile."
    type: "<xref href=\"java.util.concurrent.Future?alt=java.util.concurrent.Future&text=Future\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfile?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfile&text=VoiceProfile\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.getImpl()"
  fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.getImpl()"
  name: "getImpl()"
  nameWithType: "VoiceProfileClient.getImpl()"
  summary: "Internal method to get the underlying native handle."
  syntax: "public SafeHandle getImpl()"
  desc: "Internal method to get the underlying native handle."
  returns:
    description: "the native handle to the underlying object."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.util.SafeHandle?alt=com.microsoft.cognitiveservices.speech.util.SafeHandle&text=SafeHandle\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.getProperties()"
  fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.getProperties()"
  name: "getProperties()"
  nameWithType: "VoiceProfileClient.getProperties()"
  summary: "The collection of properties and their values defined for Voice<wbr>Profile<wbr>Client."
  syntax: "public PropertyCollection getProperties()"
  desc: "The collection of properties and their values defined for VoiceProfileClient."
  returns:
    description: "The collection of properties and their values defined for VoiceProfileClient."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.PropertyCollection?alt=com.microsoft.cognitiveservices.speech.PropertyCollection&text=PropertyCollection\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.resetProfileAsync(com.microsoft.cognitiveservices.speech.speaker.VoiceProfile)"
  fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.resetProfileAsync(VoiceProfile voiceProfile)"
  name: "resetProfileAsync(VoiceProfile voiceProfile)"
  nameWithType: "VoiceProfileClient.resetProfileAsync(VoiceProfile voiceProfile)"
  summary: "Reset a voice profile asynchronously."
  parameters:
  - description: "A voice profile."
    name: "voiceProfile"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfile?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfile&text=VoiceProfile\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Future<VoiceProfileResult> resetProfileAsync(VoiceProfile voiceProfile)"
  desc: "Reset a voice profile asynchronously."
  returns:
    description: "An asynchronous operation representing the result of reset a voice profile."
    type: "<xref href=\"java.util.concurrent.Future?alt=java.util.concurrent.Future&text=Future\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfileResult?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfileResult&text=VoiceProfileResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.retrieveEnrollmentResultAsync(com.microsoft.cognitiveservices.speech.speaker.VoiceProfile)"
  fullName: "com.microsoft.cognitiveservices.speech.speaker.VoiceProfileClient.retrieveEnrollmentResultAsync(VoiceProfile voiceProfile)"
  name: "retrieveEnrollmentResultAsync(VoiceProfile voiceProfile)"
  nameWithType: "VoiceProfileClient.retrieveEnrollmentResultAsync(VoiceProfile voiceProfile)"
  summary: "Retrieve an enrollment result given the Voice Profile."
  parameters:
  - description: "A voice profile."
    name: "voiceProfile"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfile?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfile&text=VoiceProfile\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Future<VoiceProfileEnrollmentResult> retrieveEnrollmentResultAsync(VoiceProfile voiceProfile)"
  desc: "Retrieve an enrollment result given the Voice Profile."
  returns:
    description: "An asynchronous operation representing the result of enrollment of a voice profile."
    type: "<xref href=\"java.util.concurrent.Future?alt=java.util.concurrent.Future&text=Future\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.cognitiveservices.speech.speaker.VoiceProfileEnrollmentResult?alt=com.microsoft.cognitiveservices.speech.speaker.VoiceProfileEnrollmentResult&text=VoiceProfileEnrollmentResult\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "class"
desc: "A voice profile client performs voice profile management for speaker recognition. Note: close() must be called in order to release underlying resources held by the object."
implements:
- "<xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.cognitiveservices.speech.speaker"
artifact: com.microsoft.cognitiveservices.speech:client-sdk:1.38.0