getConferenceParticipants

Description: Get a list of conference participants and information about them.

Request example:

{
    "method" : "getConferenceParticipants",
    "requestId" : "1"
}

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
        },
        {
            "peerId": "user2@some.server/58f5dac7",
            "peerDn": "user2",
            "recordingMe": false,
            "recordingByMe": false,
            "mic": 1,
            "video": 0,
            "slideShow": false,
            "leaderType": 0,
            "role": 1,
            "broadcast": false
        }
    ],
    "result": true
}

Parameter description:

• peerId — TrueConf ID, unique user identifier

• peerDn — User display name

• 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 conferences only. It can be as follows:

  • 0 — without changes

  • 1 — General

  • 2 — the conference owner

  • 3 - a user who initiated the request to leave the podium.

  • 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 - Device is selected, but muted (sound capture is disabled)

  • 2 — A device is selected and enabled

• recordingMe — the flag indicating if a user is currently recording video and audio streams from VideoSDK/Room. The parameter is optional.

• recordingByMe — the flag indicating if VideoSDK/Room 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 this 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.

• videoReceiving — reception of video 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 - unique request identifier. More details can be found here

See also:

• call
• createConference
• conferenceCreated