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

    Interface VideoTileProps

    Props for the VideoTile component.

    interface VideoTileProps {
        colors?: Partial<VideoTileColors>;
        displayName?: string;
        height?: number;
        isAudioMuted?: boolean;
        isLocal?: boolean;
        isVideoMuted?: boolean;
        labels?: Partial<VideoTileLabels>;
        mirror?: boolean;
        muteIcon?: ReactNode;
        stream: MediaStream | null;
        userId: string;
        width?: number;
    }
    Index

    Properties

    colors? displayName? height? isAudioMuted? isLocal? isVideoMuted? labels? mirror? muteIcon? stream userId width?

    Properties

    colors?: Partial<VideoTileColors>

    Partial color overrides merged with built-in defaults. See VideoTileColors.

    displayName?: string

    Display name shown in the bottom label overlay. Falls back to userId when omitted.

    height?: number

    Explicit tile height in pixels. When omitted, the tile fills its parent container.

    isAudioMuted?: boolean

    Whether the participant's audio is muted. When true, a mute badge is displayed.

    false

    isLocal?: boolean

    Whether this tile represents the local user. Appends "(You)" to the display name and enables mirror mode by default.

    false

    isVideoMuted?: boolean

    Whether the participant's video is off. When true, the avatar is shown instead of the video stream.

    false

    labels?: Partial<VideoTileLabels>

    Partial label overrides merged with built-in defaults. See VideoTileLabels.

    mirror?: boolean

    Mirror the video horizontally. Typically true for the local front-facing camera so the user sees a natural reflection.

    false

    muteIcon?: ReactNode

    Custom React element to render inside the mute badge instead of the default "MIC OFF" text.

    stream: MediaStream | null

    MediaStream to render. Pass participant.videoStream for remote users or the local camera stream from useLocalMedia. When null or when isVideoMuted is true, an avatar with initials is shown instead.

    userId: string

    Unique user identifier. Used to generate a deterministic avatar color when colors.avatarBackground is not set.

    width?: number

    Explicit tile width in pixels. When omitted, the tile fills its parent container.

    Settings

    Member Visibility

    On This Page

    Properties