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

    Interface StreamingState

    Streaming state for live broadcasts.

    Tracks whether the meeting is being live-streamed. Like recording, streaming is asynchronous -- isStreamingStarting is true while the streaming bot is spinning up, and isStreaming becomes true once the broadcast is live.

    Streaming status display:

    function StreamingBadge() {
      const { isStreaming, isStreamingStarting, streamingUrl } = useStreaming();

      if (isStreamingStarting) return <Text>Going live...</Text>;
      if (!isStreaming) return null;

      return <Text>LIVE {streamingUrl ? `at ${streamingUrl}` : ''}</Text>;
    }

    StreamingOptions for streaming configuration

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

    Properties

    error featuredUserId isStreaming isStreamingStarting streamingId streamingStartTime streamingUrl

    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 the server confirms streaming has started.

    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

    Settings

    Member Visibility

    On This Page

    Properties