Interface StreamingOptions

Streaming options that can be configured before starting a stream.

These options are passed to the client's startStreaming method.

const options: StreamingOptions = {
  createMp4: true,
  mode: 'multi',
  rtmpUrl: 'rtmp://a.rtmp.youtube.com/live2/your-stream-key',
};

interface StreamingOptions {
    createMp4?: boolean;
    mode?: StreamingMode;
    rtmpUrl?: string;
}

Properties

createMp4?: boolean

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

Streaming mode: 'single' focuses on one participant, 'multi' shows multiple participants.

'single'

rtmpUrl?: string

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