Interface ClientState

Combined client state containing all state slices.

Remarks

This interface aggregates all state slices into a single object. It's primarily used internally by the HiyveProvider to build the context value. For most use cases, prefer using the specific hooks (useConnection, useRoom, etc.) to access only the state you need.

Example

Accessing full state (advanced usage):

import { useConnection, useRoom, useParticipants, useRecording } from '@hiyve/react';

function DebugPanel() {
  const connection = useConnection();
  const room = useRoom();
  const { participants } = useParticipants();
  const recording = useRecording();

  return (
    <pre>
      {JSON.stringify({
        connected: connection.isConnected,
        inRoom: room.isInRoom,
        participants: participants.size,
        recording: recording.isRecording,
      }, null, 2)}
    </pre>
  );
}

See

ClientContextValue for the full context including actions
useConnection, useRoom, useParticipants from @hiyve/react for accessing specific slices

interface ClientState {
    audioProcessing: AudioProcessingState;
    chat: ChatState;
    client: Client | null;
    connection: ConnectionState;
    handRaise: HandRaiseState;
    layout: LayoutState;
    localMedia: LocalMediaState;
    participants: ParticipantsState;
    recording: RecordingState;
    room: RoomState;
    storedRooms: StoredRoomsState;
    streaming: StreamingState;
    transcription: TranscriptionState;
    waitForHost: WaitForHostState;
    waitingRoom: WaitingRoomState;
}

Hierarchy (View Summary)

ClientState
- ClientContextValue

Index

Properties

audioProcessing chat client connection handRaise layout localMedia participants recording room storedRooms streaming transcription waitForHost waitingRoom

Properties

audioProcessing

audioProcessing: AudioProcessingState

Audio processing state (feedback, validation, gainNode)

chat

chat: ChatState

Chat state (messages, unreadCount)

client

client: Client | null

The Hiyve Client instance, null if not connected

connection

connection: ConnectionState

Connection state (isConnected, isConnecting, error)

handRaise

handRaise: HandRaiseState

Hand raise state (raised hands map)

layout

layout: LayoutState

Layout state (dominant speaker)

localMedia

localMedia: LocalMediaState

Local media state (mute states, screen sharing)

participants

participants: ParticipantsState

Participants state (participants map, localUserId)

recording

recording: RecordingState

Recording state (isRecording, recordingId, startTime)

room

room: RoomState

Room state (room info, isOwner, isInRoom)

storedRooms

storedRooms: StoredRoomsState

Stored rooms state (persistent room management)

streaming

streaming: StreamingState

Streaming state (isStreaming, streamingId, featuredUser)

transcription

transcription: TranscriptionState

Transcription state (isTranscribing, transcriptions)

waitForHost

waitForHost: WaitForHostState

Wait for host state (isWaiting, roomName, timeout)

waitingRoom

waitingRoom: WaitingRoomState

Waiting room state (waitingUsers)