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

    Interface JoinRoomWithTokenOptions

    Options for joining a room with a join token.

    interface JoinRoomWithTokenOptions {
        joinToken: string;
        password?: string;
        roomRegion: string;
        userId: string;
        videoOnly?: boolean;
    }
    Index

    Properties

    joinToken password? roomRegion userId videoOnly?

    Properties

    joinToken: string

    The join token from the invite link

    password?: string

    Password if the token is password-protected

    roomRegion: string

    The region where the room is hosted

    userId: string

    User ID for the joining user

    videoOnly?: boolean

    Join in video-only mode — no microphone access, no audio producer. Useful for ghost participants such as a phone used as an extra camera.

    false

    Settings

    Member Visibility

    On This Page

    Properties