TrueConf

# pinUser

Version: 4.3.0+

Description: pin or unpin a participant in Automatic Stage Appearance by VAD mode.

This command is used only in a role-based conference.

Request example:

{
    "method" : "pinUser",
    "peerId" : "user@some.server/Abc556d8d5",
    "isPinNeeded" : true,
    "requestId" : "1"
}

Response example:

{
    "method" : "pinUser",
    "requestId" : "1",
    "result" : true
}

Parameter description:

  • requestId - unique request identifier. You can find more details about it here.

  • peerId - identifier of the user who should be pinned

  • isPinNeeded - a flag indicating the necessity to pin or unpin

See also: