Interface LayoutState

Layout state for video grid configuration.

Remarks

Contains the dominant speaker selection for video grid layouts. The dominant speaker is featured prominently in speaker/sidebar layouts. Only room owners can set the dominant speaker, which is then broadcast to all participants via data messages.

Example

Using dominant speaker in layouts:

function VideoRoom() {
  const { dominantSpeaker, setDominant, participants } = useLayout();
  const { isOwner } = useRoom();

  return (
    <VideoGrid
      dominantSpeaker={dominantSpeaker}
      layout="speaker"
    />
  );
}

See

useLayout for the hook to access layout state
ClientActions.setDominant for setting the dominant speaker

interface LayoutState {
dominantSpeaker: string | null;
}

Index

Properties

dominantSpeaker

Properties

dominantSpeaker

dominantSpeaker: string | null

User ID of the dominant speaker, or null if no dominant speaker is set. In speaker/sidebar modes, this participant is shown in the main area. Use 'local' or the local user's ID to make the local user dominant.

Interface LayoutState

Remarks

Example

See

Index

Properties

Properties

dominantSpeaker

Settings

On This Page