Hiyve Components - v1.0.0
    Preparing search index...

    Interface RoomInfo

    Room information returned when creating or joining a room.

    Provides metadata about the current room including its owner and active capture sessions (recording, streaming, transcription). Available via the room state after successfully creating or joining a room.

    RoomState for the containing state object

    interface RoomInfo {
        created?: string;
        id: string;
        name: string;
        owner: string;
        recordingId?: string | number | null;
        requireWaitingRoom?: boolean;
        responseId?: string | number | null;
        streamingId?: string | number | null;
        transcribingId?: string | number | null;
    }
    Index

    Properties

    created? id name owner recordingId? requireWaitingRoom? responseId? streamingId? transcribingId?

    Properties

    created?: string

    ISO timestamp when the room was created

    id: string

    Unique room identifier assigned by the server

    name: string

    Room name used for joining

    owner: string

    User ID of the room owner/host

    recordingId?: string | number | null

    Recording ID if the room is being recorded, null/undefined otherwise

    requireWaitingRoom?: boolean

    Whether the room requires waiting room approval for participants

    responseId?: string | number | null

    AI context response ID (set when transcription has useContext enabled)

    streamingId?: string | number | null

    Streaming ID if the room is being streamed, null/undefined otherwise

    transcribingId?: string | number | null

    Transcribing ID if the room is being transcribed, null/undefined otherwise

    Settings

    Member Visibility

    On This Page

    Properties