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

    Interface StreamingOptions

    Options for starting a live stream.

    Configure streaming options when starting a live broadcast. The stream is hosted on Hiyve's cloud infrastructure.

    Starting a stream with MP4 recording:

    function StreamButton() {
      const { isStreaming, startStreaming, stopStreaming } = useStreaming();

      return (
        <button onClick={isStreaming ? stopStreaming : () => startStreaming({ createMp4: true })}>
          {isStreaming ? 'Stop Streaming' : 'Go Live'}
        </button>
      );
    }
    • StreamingState for streaming state
    • useStreaming for the streaming hook
    interface StreamingOptions {
        createMp4?: boolean;
        mode?: "single" | "multi";
        rtmpUrl?: string;
    }
    Index

    Properties

    createMp4? mode? rtmpUrl?

    Properties

    createMp4?: boolean

    Create an MP4 file when streaming stops (default: false)

    mode?: "single" | "multi"

    Streaming mode: 'single' focuses on one participant, 'multi' shows multiple participants (default: 'single')

    rtmpUrl?: string

    Custom RTMP URL for streaming to external platforms (e.g., YouTube, Twitch). If not provided, uses Hiyve cloud.

    Settings

    Member Visibility

    On This Page

    Properties