Class SPXParticipant

  • Article

Declaration

@class SPXParticipant : NSObject;

Description

Represents a participant in a conversation transcribing session.

Added in version 1.13.0.

Methods

initFrom:preferredLanguage: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.

- (instancetype _Nullable)initFrom:(NSString * _Nonnull)userId
    preferredLanguage:(NSString * _Nonnull)preferredLanguage
    voiceSignature:(NSString * _Nonnull)voiceSignature

Parameters

  • userId - user's Id.
  • preferredLanguage - users' preferred language.
  • voiceSignature - user's voice signature.

Returns

The Participant object.

initFrom:preferredLanguage:voiceSignature:error:

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.

- (instancetype _Nullable)initFrom:(NSString * _Nonnull)userId
    preferredLanguage:(NSString * _Nonnull)preferredLanguage
    voiceSignature:(NSString * _Nonnull)voiceSignature
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • userId - user's Id.
  • preferredLanguage - users' preferred language.
  • voiceSignature - user's voice signature.
  • outError - error information.

Returns

The Participant object.

initFrom:preferredLanguage:

Create a Participant using user id and her/his preferred language.

- (instancetype _Nullable)initFrom:(NSString * _Nonnull)userId
    preferredLanguage:(NSString * _Nonnull)preferredLanguage

Parameters

  • userId - user's Id.
  • preferredLanguage - users' preferred language.

Returns

The Participant object.

initFrom:preferredLanguage:error:

Create a Participant using user id and her/his preferred language.

- (instancetype _Nullable)initFrom:(NSString * _Nonnull)userId
    preferredLanguage:(NSString * _Nonnull)preferredLanguage
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • userId - user's Id.
  • preferredLanguage - users' preferred language.
  • outError - error information.

Returns

The Participant object.

initFrom:

Create a Participant using user id.

- (instancetype _Nullable)initFrom:(NSString * _Nonnull)userId

Parameters

  • userId - user's Id.

Returns

The Participant object.

initFrom:error:

Create a Participant using user id.

- (instancetype _Nullable)initFrom:(NSString * _Nonnull)userId
    error:(NSError * _Nullable * _Nullable)outError

Parameters

  • userId - user's Id.
  • outError - error information.

Returns

The Participant object.

Properties

properties

@property (readonly, atomic) id<SPXPropertyCollection> _Nullable properties;

The collection of properties and their values defined for this SPXParticipant.

id

@property (readwrite, copy, nonatomic) NSString * _Nullable id;

The unique identifier for the participant.

avatar

@property (readwrite, copy, nonatomic) NSString * _Nullable avatar;

The user's avatar as an HTML hex string (e.g. FF0000 for red).

displayName

@property (readwrite, copy, nonatomic) NSString * _Nullable displayName;

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.

preferredLanguage

@property (readwrite, copy, nonatomic) NSString * _Nullable preferredLanguage;

The participant's preferred spoken language.

voiceSignature

@property (readwrite, copy, nonatomic) NSString * _Nullable voiceSignature;

The participant's voice signature.

isMuted

@property (readonly, nonatomic) BOOL isMuted;

Provides information is Participant muted.

isUsingTts

@property (readonly, nonatomic) BOOL isUsingTts;

Provides information is participant using Text To Speech (TTS).

isHost

@property (readonly, nonatomic) BOOL isHost;

Provides information is participant host.