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

    Interface StreamingControlsProps

    Props for the StreamingControls component.

    interface StreamingControlsProps {
        colors?: Partial<StreamingControlsColors>;
        error?: string | null;
        isStreaming: boolean;
        isStreamingStarting?: boolean;
        labels?: Partial<StreamingControlsLabels>;
        onClearError?: () => void;
        onStartStreaming: (options?: { rtmpUrl?: string }) => void;
        onStopStreaming: () => void;
        showRtmpInput?: boolean;
        streamingDuration?: number;
    }
    Index

    Properties

    colors? error? isStreaming isStreamingStarting? labels? onClearError? onStartStreaming onStopStreaming showRtmpInput? streamingDuration?

    Properties

    colors?: Partial<StreamingControlsColors>

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

    error?: string | null

    Error message to display, or null/undefined for no error.

    isStreaming: boolean

    Whether a live stream is currently active.

    isStreamingStarting?: boolean

    Whether the stream is in the process of starting.

    labels?: Partial<StreamingControlsLabels>

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

    onClearError?: () => void

    Called when the user taps the error message to dismiss it.

    onStartStreaming: (options?: { rtmpUrl?: string }) => void

    Called when the user presses the "Go Live" button. Receives optional streaming options.

    onStopStreaming: () => void

    Called when the user presses the stop button.

    showRtmpInput?: boolean

    Whether to show the RTMP URL input field.

    false

    streamingDuration?: number

    Elapsed streaming time in seconds.

    Settings

    Member Visibility

    On This Page

    Properties