Interface ParticipantPropertiesPayload

The participant properties interface.

interface ParticipantPropertiesPayload {
    audio?: string;
    audioConnectionStatus?: number;
    avatar?: string;
    bCCEditor?: boolean;
    bCoHost: boolean;
    bHold?: boolean;
    bLocalRecord?: boolean;
    bRaiseHand?: boolean;
    bVideoOn?: boolean;
    bid?: number;
    displayName?: string;
    feedback?: number;
    isGuest?: boolean;
    isHost?: boolean;
    muted?: boolean;
    os?: number;
    reason?: "on hold" | "failover";
    sharerOn?: boolean;
    sharerPause?: boolean;
    source?: "on hold" | "failover";
    userId: number;
    userRole?: number;
    userType?: number;
    zoomID?: string;
}

Properties

audio? audioConnectionStatus? avatar? bCCEditor? bCoHost bHold? bLocalRecord? bRaiseHand? bVideoOn? bid? displayName? feedback? isGuest? isHost? muted? os? reason? sharerOn? sharerPause? source? userId userRole? userType? zoomID?

Properties

Optional audio

audio?: string

The user's audio.

Optional audioConnectionStatus

audioConnectionStatus?: number

Participants's audio status.

  • 0: NotConnect,
  • 1: Connecting,
  • 2: ConnectSuccess,
  • 3: ConnectFail,

Optional avatar

avatar?: string

Avatar of the user.

Optional bCCEditor

bCCEditor?: boolean

Whether the user can edit closed captions.

bCoHost

bCoHost: boolean

Whether the user is a co-host.

Optional bHold

bHold?: boolean

Whether the user is on hold.

Optional bLocalRecord

bLocalRecord?: boolean

Whether the user is starting local recording.

Optional bRaiseHand

bRaiseHand?: boolean

Whether the user's hand is raised.

Optional bVideoOn

bVideoOn?: boolean

Whether the user is starting the video.

Optional bid

bid?: number

The breakout room's ID.

Optional displayName

displayName?: string

Display name.

Optional feedback

feedback?: number

Nonverbal feedback.

Optional isGuest

isGuest?: boolean

Whether the user is a guest (does not belong to the same account).

Optional isHost

isHost?: boolean

Whether the user is the host.

Optional muted

muted?: boolean

Whether the audio is muted.

Optional os

os?: number

The current client's type.

Optional reason

reason?: "on hold" | "failover"

Whether the participants leave the meeting due to failover or an on hold change.

Optional sharerOn

sharerOn?: boolean

Whether the user is starting sharing.

Optional sharerPause

sharerPause?: boolean

Whether sharing is paused.

Optional source

source?: "on hold" | "failover"

Whether a new user joins the meeting due to failover or an on hold change.

userId

userId: number

The user's ID.

Optional userRole

userRole?: number

The user's role.

Optional userType

userType?: number

The type of user:

  • 9: Client
  • 5: Phone
  • 15: H323 device

Optional zoomID

zoomID?: string

The internal ID.

Settings

Member Visibility

Theme

On This Page

audioaudioConnectionStatusavatarbCCEditorbCoHostbHoldbLocalRecordbRaiseHandbVideoOnbiddisplayNamefeedbackisGuestisHostmutedosreasonsharerOnsharerPausesourceuserIduserRoleuserTypezoomID