198 строки
13 KiB
YAML
198 строки
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.cognitiveservices.speech.transcription.Participant"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant"
|
|
name: "Participant"
|
|
nameWithType: "Participant"
|
|
summary: "Represents a participant in a conversation transcribing session."
|
|
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 **Participant**</br> implements <xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
|
|
methods:
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.close()"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.close()"
|
|
name: "close()"
|
|
nameWithType: "Participant.close()"
|
|
summary: "Explicitly frees any external resource attached to the object"
|
|
syntax: "public void close()"
|
|
desc: "Explicitly frees any external resource attached to the object"
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.from(java.lang.String)"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.from(String userId)"
|
|
name: "from(String userId)"
|
|
nameWithType: "Participant.from(String userId)"
|
|
summary: "Create a Participant using user id."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "user's Id."
|
|
name: "userId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static Participant from(String userId)"
|
|
desc: "Create a Participant using user id."
|
|
returns:
|
|
description: "Participant object."
|
|
type: "<xref href=\"com.microsoft.cognitiveservices.speech.transcription.Participant?alt=com.microsoft.cognitiveservices.speech.transcription.Participant&text=Participant\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.from(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.from(String userId, String preferredLanguage)"
|
|
name: "from(String userId, String preferredLanguage)"
|
|
nameWithType: "Participant.from(String userId, String preferredLanguage)"
|
|
summary: "Create a Participant using user id and her/his preferred language."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "user's Id."
|
|
name: "userId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "users' preferred language."
|
|
name: "preferredLanguage"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static Participant from(String userId, String preferredLanguage)"
|
|
desc: "Create a Participant using user id and her/his preferred language."
|
|
returns:
|
|
description: "Participant object."
|
|
type: "<xref href=\"com.microsoft.cognitiveservices.speech.transcription.Participant?alt=com.microsoft.cognitiveservices.speech.transcription.Participant&text=Participant\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.from(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.from(String userId, String preferredLanguage, String voiceSignature)"
|
|
name: "from(String userId, String preferredLanguage, String voiceSignature)"
|
|
nameWithType: "Participant.from(String userId, String preferredLanguage, String voiceSignature)"
|
|
summary: "Create a Participant using user id, her/his preferred language and her/his voice signature."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "user's Id."
|
|
name: "userId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "users' preferred language."
|
|
name: "preferredLanguage"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "user's voice signature."
|
|
name: "voiceSignature"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static Participant from(String userId, String preferredLanguage, String voiceSignature)"
|
|
desc: "Create a Participant using user id, her/his preferred language and her/his voice signature. If voice signature is empty then user will not be identified."
|
|
returns:
|
|
description: "Participant object."
|
|
type: "<xref href=\"com.microsoft.cognitiveservices.speech.transcription.Participant?alt=com.microsoft.cognitiveservices.speech.transcription.Participant&text=Participant\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.getAvatar()"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.getAvatar()"
|
|
name: "getAvatar()"
|
|
nameWithType: "Participant.getAvatar()"
|
|
summary: "Gets the colour of the user's avatar as an HTML hex string (e.<wbr>g."
|
|
syntax: "public String getAvatar()"
|
|
desc: "Gets the colour of the user's avatar as an HTML hex string (e.g. FF0000 for red)."
|
|
returns:
|
|
description: "hex color string"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.getDisplayName()"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.getDisplayName()"
|
|
name: "getDisplayName()"
|
|
nameWithType: "Participant.getDisplayName()"
|
|
summary: "The participant's display name."
|
|
syntax: "public String getDisplayName()"
|
|
desc: "The participant's display name. Please note that each participant within the same conversation must have a different display name. Duplicate names within the same conversation are not allowed. You can use the Id property as another way to refer to each participant."
|
|
returns:
|
|
description: "The participant's display name."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.getId()"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.getId()"
|
|
name: "getId()"
|
|
nameWithType: "Participant.getId()"
|
|
summary: "The unique identifier for the participant."
|
|
syntax: "public String getId()"
|
|
desc: "The unique identifier for the participant."
|
|
returns:
|
|
description: "unique ID"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.getImpl()"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.getImpl()"
|
|
name: "getImpl()"
|
|
nameWithType: "Participant.getImpl()"
|
|
summary: "Returns the participant implementation."
|
|
syntax: "public SafeHandle getImpl()"
|
|
desc: "Returns the participant implementation."
|
|
returns:
|
|
description: "The implementation of the participant."
|
|
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.transcription.Participant.getProperties()"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.getProperties()"
|
|
name: "getProperties()"
|
|
nameWithType: "Participant.getProperties()"
|
|
summary: "Gets the properties for participant."
|
|
syntax: "public PropertyCollection getProperties()"
|
|
desc: "Gets the properties for participant."
|
|
returns:
|
|
description: "the properties of participant."
|
|
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.transcription.Participant.isHost()"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.isHost()"
|
|
name: "isHost()"
|
|
nameWithType: "Participant.isHost()"
|
|
summary: "Gets whether or not this participant is the host."
|
|
syntax: "public boolean isHost()"
|
|
desc: "Gets whether or not this participant is the host."
|
|
returns:
|
|
description: "whether or not this participant is the host."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.isMuted()"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.isMuted()"
|
|
name: "isMuted()"
|
|
nameWithType: "Participant.isMuted()"
|
|
summary: "Gets whether or not this participant is muted."
|
|
syntax: "public boolean isMuted()"
|
|
desc: "Gets whether or not this participant is muted."
|
|
returns:
|
|
description: "whether or not this participant is muted."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.isUsingTts()"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.isUsingTts()"
|
|
name: "isUsingTts()"
|
|
nameWithType: "Participant.isUsingTts()"
|
|
summary: "Gets whether or not the participant is using Text To Speech (TTS)."
|
|
syntax: "public boolean isUsingTts()"
|
|
desc: "Gets whether or not the participant is using Text To Speech (TTS)."
|
|
returns:
|
|
description: "whether or not the participant is using Text To Speech (TTS)."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.setPreferredLanguage(java.lang.String)"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.setPreferredLanguage(String preferredLanguage)"
|
|
name: "setPreferredLanguage(String preferredLanguage)"
|
|
nameWithType: "Participant.setPreferredLanguage(String preferredLanguage)"
|
|
summary: "Sets the preferred languages for participant."
|
|
parameters:
|
|
- description: "participant's preferred language."
|
|
name: "preferredLanguage"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setPreferredLanguage(String preferredLanguage)"
|
|
desc: "Sets the preferred languages for participant."
|
|
- uid: "com.microsoft.cognitiveservices.speech.transcription.Participant.setVoiceSignature(java.lang.String)"
|
|
fullName: "com.microsoft.cognitiveservices.speech.transcription.Participant.setVoiceSignature(String voiceSignature)"
|
|
name: "setVoiceSignature(String voiceSignature)"
|
|
nameWithType: "Participant.setVoiceSignature(String voiceSignature)"
|
|
summary: "Sets the voice signature for participant."
|
|
parameters:
|
|
- description: "user's voice signature."
|
|
name: "voiceSignature"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setVoiceSignature(String voiceSignature)"
|
|
desc: "Sets the voice signature for participant. If voice signature is empty then user will not be identified."
|
|
type: "class"
|
|
desc: "Represents a participant in a conversation transcribing session. Added in version 1.5.0"
|
|
implements:
|
|
- "<xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.microsoft.cognitiveservices.speech.transcription"
|
|
artifact: com.microsoft.cognitiveservices.speech:client-sdk:1.38.0
|