MediaSFU Shared
    Preparing search index...

    Interface AttachPlaybackOptions

    interface AttachPlaybackOptions {
        source: string | PlaybackSource;
        video?: HTMLVideoElement | null;
        protocol?: PlaybackProtocol;
        hlsFactory?: () => any;
        headers?: Record<string, string>;
        iceServers?: RTCIceServer[];
    }
    Index

    Properties

    source video? protocol? hlsFactory? headers? iceServers?

    Properties

    source: string | PlaybackSource

    Playback URL, or a PlaybackSource from getPlaybackSources.

    video?: HTMLVideoElement | null

    The element to play into. Required for HLS; optional for WHEP.

    protocol?: PlaybackProtocol

    Force a protocol. Inferred from the URL when omitted.

    hlsFactory?: () => any

    Factory returning an hls.js instance, e.g. () => new Hls({ lowLatencyMode: true }).

    Required for HLS anywhere except Safari, and injected rather than imported so hls.js never becomes a dependency of this SDK — most rooms never play HLS, and React Native cannot use it at all.

    headers?: Record<string, string>

    Extra headers for the WHEP POST, e.g. an auth token.

    iceServers?: RTCIceServer[]

    ICE servers for WHEP. Defaults to the room's own when available.

    Settings

    Member Visibility

    On This Page

    Properties