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

    Interface StreamingConfig

    Complete streaming configuration combining mode, MP4 recording, and RTMP settings.

    Used by applications to manage the full streaming configuration state. Combines the individual streaming options into a single object for easier state management and persistence.

    import { StreamingConfig, defaultStreamingConfig } from '@hiyve/react-capture';

    const [config, setConfig] = useState<StreamingConfig>(defaultStreamingConfig);
    interface StreamingConfig {
        createMp4: boolean;
        mode: StreamingMode;
        rtmpUrl: string;
    }
    Index

    Properties

    createMp4 mode rtmpUrl

    Properties

    createMp4: boolean

    Whether to save an MP4 file when streaming ends

    mode: StreamingMode

    How participants are displayed: 'single' (active speaker) or 'multi' (grid)

    rtmpUrl: string

    RTMP URL for external streaming (empty for cloud streaming)

    Settings

    Member Visibility

    On This Page

    Properties