Skip to main content

The DyteMeetingParticipant object

The DyteMeetingParticipant object consists of all the information related to a particular participant. For instance, it contains a participants video/audio/screenshare stream, and the participant's name. It also contains state variables that indicate whether a participant's camera is on or off, and whether they are muted or unmuted.

The participant object has the following properties.

  • id: The participantId of the participant (aka peerId).
  • userId: The userId of the participant.
  • name: Contains participant's name.
  • picture: Contains participant's picture (if any).
  • isHost: Boolean value indicating whether this user is host of current meeting or not.
  • clientSpecificId: Arbitrary ID that can be set to identify the participant.
  • videoEnabled: Set to true if the participant's camera is on.
  • audioEnabled: Set to true if the participant is unmuted.

You can subscribe to various participants events. For subscribing:

  • Implement DyteParticipantEventsListener to a class say ParticipantEventListener, and listen to event from DyteParticipantEventsListener by overriding them. This class can be user to manage your state in the application.
class ParticipantEventListener extends DyteParticipantEventsListener {

  @override
  void onAudioUpdate({
    required bool audioEnabled,
    required DyteMeetingParticipant participant,
  }) {
    /// handle audioUpdate of `DyteMeetingParticipant` participant
  }

  @override
  void onActiveSpeakerChanged(DyteMeetingParticipant participant) {
    /// handle active speaker changing to `DyteMeetingParticipant` participant
  }

  @override
  void onNoActiveSpeaker() {
    /// handle no active speaker
  }

  @override
  void onParticipantPinned(DyteMeetingParticipant participant) {
    /// handle pinning of `DyteMeetingParticipant` participant
  }


  @override
  void onParticipantUnpinned(DyteMeetingParticipant participant) {
    /// handle unpinning the pinned participant
  }

  @override
  void onScreenShareStarted(DyteMeetingParticipant participant) {
    /// handle screen share started of `DyteMeetingParticipant` participant
  }

  @override
  void onScreenShareEnded(DyteMeetingParticipant participant) {
    /// handle screen share ended of `DyteMeetingParticipant` participant
  }

  @override
  void onVideoUpdate({
    required bool videoEnabled,
    required DyteMeetingParticipant participant,
  }) {
    /// handle videoUpdate of `DyteMeetingParticipant` participant
  }

}
  • Now to subscribe, pass the instance of DyteParticipantEventsListener class created above to addParticipantEventsListener() method of dyteClient instance as follows:
dyteClient.addParticipantEventsListener(ParticipantEventListener());

Audio/Video updates for participant​


...

@override
void onVideoUpdate(bool videoEnabled) {
  if (videoEnabled) {
      // video is enabled, and other participants in room can see local user
    } else {
      // video is disabled, and other participants in room can not see local user.
    }
}

@override
void onAudioUpdate({
  required bool audioEnabled,
  required DyteMeetingParticipant participant,
}) {
    if (audioEnabled) {
      // audio is enabled, and other participants in room can hear local user
    } else {
      // audio is disabled, and other participants in room can not hear local user.
    }
}

...