VTParticipant
The VTParticipant model contains information about a conference participant.
Accessors
audioReceivingFrom
▸ audioReceivingFrom: Bool
Checks whether the local participant receives audio from a specific remote participant.
For example, if client A calls the stop method to stop receiving audio from participant B and then calls participant.audioReceivingFrom for participant B, client A receives false. This means that client A does not receive audio streams from participant B. If the participants audioTransmitting is false, then its audioReceivingFrom will also be false as the conference is unable to send down audio for a participant that is not sending their audio into the conference.
Returns: Bool
audioTransmitting
▸ audioTransmitting: Bool
A boolean that indicates whether the participant is transmitting audio into a conference. True indicates that the participant is sending audio; otherwise, false. The mute function does not affect this flag.
Returns: Bool
id
▸ id: String?
The participant ID.
Returns: String?
info
▸ info: VTParticipantInfo
Information about the conference participant.
Returns: VTParticipantInfo
status
▸ status: VTParticipantStatus
The participant status.
Returns: VTParticipantStatus
streams
▸ streams: [MediaStream]
The participant's streams.
Returns: [MediaStream]
type
▸ type: VTParticipantType
The participant type.
Returns: VTParticipantType
Methods
setVolume
▸ setVolume(volume
: Float) -> Bool
Sets the participant's volume in non-Dolby Voice conferences to a preferred value between 0 and 1. Providing an unsupported number results in constraining the volume to either 0 or 1. This method is supported in SDK 3.11 and later.
Parameters
Name | Type | Description |
---|---|---|
volume | Float | The preferred volume level between 0 (no audio) and 1 (full volume). |
Updated 3 months ago