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

    Interface StreamingControlsProps

    Props for the StreamingControls component.

    The StreamingControls component provides a UI for starting and stopping live streams with configurable options.

    interface StreamingControlsProps {
        compact?: boolean;
        defaultCreateMp4?: boolean;
        defaultMode?: StreamingMode;
        disabled?: boolean;
        duration?: number;
        icons?: Partial<StreamingControlsIcons>;
        isStreaming?: boolean;
        isStreamingStarting?: boolean;
        labels?: Partial<StreamingControlsLabels>;
        onStreamingStart?: (options?: StreamingOptions) => void;
        onStreamingStop?: () => void;
        showOptions?: boolean;
        styles?: Partial<StreamingControlsStyles>;
        sx?: SxProps<Theme>;
    }
    Index

    Properties

    compact? defaultCreateMp4? defaultMode? disabled? duration? icons? isStreaming? isStreamingStarting? labels? onStreamingStart? onStreamingStop? showOptions? styles? sx?

    Properties

    compact?: boolean

    Use compact button style (default: false)

    defaultCreateMp4?: boolean

    Default value for create MP4 option (default: true)

    defaultMode?: StreamingMode

    Default value for streaming mode (default: 'single')

    disabled?: boolean

    Whether the control is disabled

    duration?: number

    Streaming duration in seconds (for display)

    icons?: Partial<StreamingControlsIcons>

    Custom icons

    isStreaming?: boolean

    Whether streaming is currently active

    isStreamingStarting?: boolean

    Whether streaming is starting (shows loading state)

    labels?: Partial<StreamingControlsLabels>

    Custom labels for i18n support

    onStreamingStart?: (options?: StreamingOptions) => void

    Callback when streaming starts

    onStreamingStop?: () => void

    Callback when streaming stops

    showOptions?: boolean

    Show options dialog before starting (default: true)

    styles?: Partial<StreamingControlsStyles>

    Custom styles

    sx?: SxProps<Theme>

    MUI sx styling prop

    Settings

    Member Visibility

    On This Page

    Properties