LogoLogo
ALO.ai
Developer Documentation
Developer Documentation
  • Developer Documentation
  • Developer Account
    • API Key
  • SDKs
    • Authentication
    • Chat
      • Configuration
      • Send Messages
        • Upload Files
      • Message History
      • Message Actions
      • Message Counts
      • Translation
      • Typing Indicators
      • API Reference
        • Event
        • Message
    • Presence
      • Configuration
      • Basic Usage
      • Methods
    • Audio
      • Prerequisites
      • Instantiating Audio Service
      • Connect to a Channel
      • Disconnecting Audio Service
      • Push To Talk (PTT)
      • Full Duplex
      • Mute and Unmute Audio
      • Input/Output Device Selection
        • Microphone Selection
        • Speaker Selection
      • Channel Participants
      • Text To Speech Audio (TTS)
      • Automatic Reconnects
      • Handling Events
      • Classes
        • AloAudio
        • AudioUser
        • AudioChannel
        • Participant
    • Video
      • Prerequisites
      • Instantiating Video Service
      • Connect to a Channel
      • Disconnecting Video Service
      • Input Device Selection
        • Microphone Selection
        • Camera Selection
      • Publishing Streams
      • Modifying Published Streams
      • Channel Participants
      • Rendering Streams
        • Local Stream
        • Remote Streams
      • Muting/Unmuting Remote Streams
      • Recording Video (coming soon)
      • Automatic Reconnects
      • Handling Events
      • Classes
        • AloVideo
        • Participant
        • VideoChannel
        • VideoUser
  • ALO APPS
    • Overview
    • Creating Apps
    • Webhooks
      • Verifying Requests from ALO
    • Custom Action Forms
    • Using the ALO Platform API
  • ALO Platform API
    • Overview
    • Authentication
    • API
      • Actions and Periods
      • Channels
      • Channel Messages
      • Channel Users
      • Direct Message Channels
      • Direct Message Channel Chat Messages
      • Direct Message Channel Users
      • Groups
      • Periods
      • Types
      • Users
      • Video Management System
  • Misc
    • Supported Language Codes
Powered by GitBook
LogoLogo

ALO.ai

  • ALO.ai

© Copyright 2025 ALO.ai, Inc. • All Rights Reserved

On this page
  1. SDKs
  2. Video
  3. Classes

Participant

PreviousAloVideoNextVideoChannel

Last updated 4 years ago

A participant object represents a user that is connected to a given channel. You can get the list of participants from the object. You will also get a list of participants with the onParticipantsChanged event.

Properties

Property

Type

Description

connectionId

String

Unique identifier, generated by the Video Service, that identifies a user's connection to a given channel.

id

String

Identifies the participant. This id will not change even if the connectionId changes.

isMutedLocally

Boolean

This is set totrue when the current user decides to mute the participant's audio. If true and the participant is publishing audio, the audio track will be disabled.

isPublishingAudio

Boolean

This is true when the participant's published stream contains an audio track.

isPublishingStream

Boolean

This is true if the participant is publishing a stream (audio and/or video).

isPublishingVideo

Boolean

This is true when the participant's published stream contains a video track.

isCurrentUser

Boolean

This is true when the participant represents the current user.

mediaStream

If the participant is publishing audio and/or video this will be their media stream

mutedByPublisher

Boolean

When true the given participant's is publishing audio.

name

String

Name of the participant that can be used for display purposes.

userId

String

User id of the given participant.

VideoChannel
MediaStream