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

    Interface RoomAnalysisViewerProps

    interface RoomAnalysisViewerProps {
        analysisData: AnalysisData;
        currentUserId?: string;
        enableMarkers?: boolean;
        enableRegions?: boolean;
        markers?: {
            authorId?: string;
            authorName?: string;
            color?: string;
            content: string;
            createdAt?: string;
            editedAt?: string;
            id: string;
            time: number;
        }[];
        onMarkerAdd?: (
            marker: {
                authorId?: string;
                authorName?: string;
                color?: string;
                content: string;
                createdAt?: string;
                editedAt?: string;
                id: string;
                time: number;
            },
        ) => void;
        onMarkerChange?: (
            marker: {
                authorId?: string;
                authorName?: string;
                color?: string;
                content: string;
                createdAt?: string;
                editedAt?: string;
                id: string;
                time: number;
            },
        ) => void;
        onMarkerDelete?: (markerId: string) => void;
        onRegionChange?: (
            region: {
                channelIdx?: number;
                content: string;
                end: number;
                id: string;
                start: number;
            },
        ) => void;
        onRegionDelete?: (regionId: string) => void;
        recordingId?: string;
        regions?: {
            channelIdx?: number;
            content: string;
            end: number;
            id: string;
            start: number;
        }[];
        sx?: SxProps<Theme>;
        videoUrl?: string;
    }
    Index

    Properties

    analysisData currentUserId? enableMarkers? enableRegions? markers? onMarkerAdd? onMarkerChange? onMarkerDelete? onRegionChange? onRegionDelete? recordingId? regions? sx? videoUrl?

    Properties

    analysisData: AnalysisData
    currentUserId?: string

    Current user ID for marker edit permissions

    enableMarkers?: boolean

    Enable timeline markers / comments

    true
    enableRegions?: boolean

    Enable region creation and editing on the media player

    true
    markers?: {
        authorId?: string;
        authorName?: string;
        color?: string;
        content: string;
        createdAt?: string;
        editedAt?: string;
        id: string;
        time: number;
    }[]

    Initial timeline markers

    onMarkerAdd?: (
        marker: {
            authorId?: string;
            authorName?: string;
            color?: string;
            content: string;
            createdAt?: string;
            editedAt?: string;
            id: string;
            time: number;
        },
    ) => void

    Called when a new marker is added

    onMarkerChange?: (
        marker: {
            authorId?: string;
            authorName?: string;
            color?: string;
            content: string;
            createdAt?: string;
            editedAt?: string;
            id: string;
            time: number;
        },
    ) => void

    Called when a marker is updated

    onMarkerDelete?: (markerId: string) => void

    Called when a marker is deleted

    onRegionChange?: (
        region: {
            channelIdx?: number;
            content: string;
            end: number;
            id: string;
            start: number;
        },
    ) => void

    Called when a region is created or updated

    onRegionDelete?: (regionId: string) => void

    Called when a region is deleted

    recordingId?: string

    Recording ID shown in the header for reference

    regions?: {
        channelIdx?: number;
        content: string;
        end: number;
        id: string;
        start: number;
    }[]

    Initial named regions

    sx?: SxProps<Theme>
    videoUrl?: string

    Presigned URL to the recording video. When provided, an inline player is shown and timestamps become clickable.

    Settings

    Member Visibility

    On This Page

    Properties