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

    Interface StreamingState

    Streaming state for live broadcasts.

    Tracks whether the meeting is being streamed to an external Cloud-based streaming with optional MP4 recording.

    Streaming controls:

    function StreamingPanel() {
    const { isStreaming, startStreaming, stopStreaming } = useStreaming();
    const [createMp4, setCreateMp4] = useState(false);

    return (
    <div>
    {!isStreaming ? (
    <>
    <label>
    <input
    type="checkbox"
    checked={createMp4}
    onChange={(e) => setCreateMp4(e.target.checked)}
    />
    Also save as MP4
    </label>
    <button onClick={() => startStreaming({ createMp4 })}>
    Go Live
    </button>
    </>
    ) : (
    <button onClick={stopStreaming}>Stop Streaming</button>
    )}
    </div>
    );
    }

    useStreaming for the streaming hook

    interface StreamingState {
        error: string | null;
        featuredUserId: string | null;
        isStreaming: boolean;
        isStreamingStarting: boolean;
        streamingId: string | null;
        streamingStartTime: Date | null;
        streamingUrl: string | null;
    }
    Index

    Properties

    error: string | null

    Error message if streaming failed to start or encountered an error, null otherwise

    featuredUserId: string | null

    User ID being featured in the stream, null if grid view

    isStreaming: boolean

    Whether live streaming is active

    isStreamingStarting: boolean

    Whether a streaming start request is in progress. True from when startStreaming() is called until STREAMING_STARTED confirms start.

    streamingId: string | null

    Server-assigned streaming ID, null if not streaming

    streamingStartTime: Date | null

    When the streaming started, null if not streaming

    streamingUrl: string | null

    Playback URL for the stream, null if not available