SfBParticipantAudio Class Reference

Inherits from SfBParticipantService : NSObject
Declared in SfBParticipantAudio.h

Overview

This interface represents the audio capabilities of a participant in the conversation.

  isSpeaking

@property (readonly) BOOL isSpeaking

  isOnHold

@property (readonly) BOOL isOnHold

  isMuted

Whether the participant’s audio can be heard by other participants in the conversation.

@property (readonly) BOOL isMuted

Discussion

Whether the participant’s audio can be heard by other participants in the conversation.

Declared In

SfBParticipantAudio.h

– setMuted:error:

Controls whether this participant’s audio can be heard by other participants in the conversation. This action may may not be available if the local participant does not have the ‘leader’ role in the conversation. This may even apply to this setting for the local participant itself (the conversation’s selfParticipant). In particular, it may not always be possible to un-mute until a remote ‘leader’ enables this.

- (BOOL)setMuted:(BOOL)muted error:(NSError **)error

Parameters

muted

Mutes if true, umutes otherwise.

Discussion

Controls whether this participant’s audio can be heard by other participants in the conversation. This action may may not be available if the local participant does not have the ‘leader’ role in the conversation. This may even apply to this setting for the local participant itself (the conversation’s selfParticipant). In particular, it may not always be possible to un-mute until a remote ‘leader’ enables this.

Declared In

SfBParticipantAudio.h

  canSetMuted

Checks if the participant can be muted / un-muted. As explained above, a number of different factors may determine this.

@property (readonly) BOOL canSetMuted

Discussion

Checks if the participant can be muted / un-muted. As explained above, a number of different factors may determine this.

Declared In

SfBParticipantAudio.h

– init

- (instancetype)init