Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Represents a participant in a conversation. Added in version 1.5.0.
Members
Id
Syntax: public const std::string & Id;
Get the identifier for the participant.
Properties
Syntax: public PropertyCollection & Properties;
Collection of additional participant properties.
Participant
Syntax: public inline explicit Participant ( SPXPARTICIPANTHANDLE hparticipant );
Internal constructor. Creates a new instance using the provided handle.
Parameters
hparticipantparticipant handle.
~Participant
Syntax: public inline virtual ~Participant ( );
Virtual destructor.
operator SPXPARTICIPANTHANDLE
Syntax: public inline explicit operator SPXPARTICIPANTHANDLE ( ) const;
Internal operator used to get underlying handle value.
Returns
A handle.
SetPreferredLanguage
Syntax: public inline void SetPreferredLanguage ( const std::string & preferredLanguage );
Set preferred language.
Parameters
preferredLanguageThe preferred language, such as "en-us".
SetVoiceSignature
Syntax: public inline void SetVoiceSignature ( const std::string & voiceSignature );
Set voice signature. If voice signature is empty then user will not be identified.
Parameters
voiceSignatureThe participant's voice signature."
From
Syntax: public inline static std::shared_ptr< Participant > From ( const std::string & userId , const std::string & preferredLanguage , const std::string & voiceSignature );
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.
Parameters
userIdA user ids.preferredLanguageThe preferred languages of the user. It can be optional.voiceSignatureThe voice signature of the user. It can be optional.
Returns
A smart pointer of Participant