Interface ParticipantUpdateResult

The outcome of changing a participant.

interface ParticipantUpdateResult {
    ErrorMessage?: string;
    NotInRoom?: boolean;
    Success: boolean;
}

Properties

ErrorMessage?: string

What went wrong, when it failed.

NotInRoom?: boolean

true when LiveKit refused because that participant (or the room) does not exist.

Success: boolean

Whether LiveKit applied the change.