getConferenceParticipants

Description

Get a list of conference participants and information about them

void getConferenceParticipants()

Response example

{
    "method": "getConferenceParticipants",
    "requestId" : "1",
    "confId": "00000080752eb399@some.server#vcs",
    "participants": [{
            "peerId": "user1@some.server/d8a9cda9",
            "peerDn": "สวัสดี ",
            "mic": 2,
            "video": 0,
            "slideShow": false,
            "leaderType": 1,
            "role": 2,
            "broadcast": true,
            "pinned": true
        },
        {
            "peerId": "user2@some.server/58f5dac7",
            "peerDn": "user2",
            "recordingMe": false,
            "recordingByMe": false,
            "mic": 1,
            "video": 0,
            "slideShow": false,
            "leaderType": 0,
            "role": 1,
            "broadcast": false,
            "pinned": false,
            "isInWaitingRoom": false,
        }
    ],
    "result": true
}

Response Parameters

Name	Description
peerId	TrueConf ID, unique user identifier
peerDn	User display name
pinned	A flag indicating that a participant is pinned in the `Automatic stage appearance by VAD` mode. It is present only in `video selector`
confId	Unique identifier of an ongoing conference
broadcast	Flag showing whether a user is a presenter on the podium. It is available in `role-based` conferences only
role	User role. It is available in `role-based` conference only. It can be as follows: • 0 - Without changes • 1 - General • 2 - The conference owner • 3 - User who has requested to take the floor themselves • 4 - The user who was invited to the podium • 5 - The user who is currently making an audio reply
mic	Microphone state flag. It can be as follows: • 0 - A device is missing or not selected • 1 - The device is selected but muted (audio capture is turned off) • 2 - A device is selected and enabled
recordingMe	The flag indicating if a user is currently recording video and audio streams from TrueConf VideoSDK. The parameter is optional
recordingByMe	The flag indicating if TrueConf VideoSDK is currently recording video and audio streams from the user. The parameter is optional.
video	Camera state flag. It can be as follows: • 0 - A device is missing or not selected • 1 - A device is selected but muted • 2 - A device is selected and enabled
slideShow	Flag showing whether the participant is showing slides
extraVideo	Feed type. The parameter may be unavailable. It can have the following values: • 0 - Video shared from camera • 1 - Content sharing • 2 - Video shared from camera that cannot be switched to content
audioReceiving	Reception of audio from a participant. The parameter is optional
leaderType	The type of participant. This parameter is unavailable for a `video call`. The following values are possible: • 0 - General • 1 - Conference owner • 2 - Operator • 3 - Moderator
requestId	A unique request identifier
result	A flag indicating whether the request was successful
isInWaitingRoom	A flag indicating whether a conference participant is in the waiting room. This field is present only if the moderated TrueConf VideoSDK is the owner or moderator of the group conference and the current object in the array is not TrueConf VideoSDK

See also

• call
• createConference
• On_conferenceCreated