peerix - v0.8.0
    Preparing search index...

    Interface StreamOptions

    Local stream publication options.

    interface StreamOptions {
        audioParameters?: { maxBitrate?: number; priority?: RTCPriorityType };
        label?: string;
        managed?: boolean;
        stream: MediaStream;
        videoParameters?: {
            maxBitrate?: number;
            maxFramerate?: number;
            priority?: RTCPriorityType;
            scaleResolutionDownBy?: number;
        };
    }
    Index
    audioParameters?: { maxBitrate?: number; priority?: RTCPriorityType }

    Preferred audio encoding parameters to apply to the stream's audio tracks, such as bitrate or priority.

    Type Declaration

    • OptionalmaxBitrate?: number

      Preferred maximum bitrate in bits per second to encode the audio tracks.

    • Optionalpriority?: RTCPriorityType

      Preferred priority for encoding the audio tracks.

    label?: string

    Stream label. If omitted, the default label is used. A MediaStream passed to share() or unshare() directly uses its id as the label.

    managed?: boolean

    Whether the caller manages the lifecycle of the stream's tracks. If true, tracks are not stopped when the stream is unshared or replaced, and the stream is not unshared automatically when its tracks end.

    stream: MediaStream

    Media stream to share.

    videoParameters?: {
        maxBitrate?: number;
        maxFramerate?: number;
        priority?: RTCPriorityType;
        scaleResolutionDownBy?: number;
    }

    Preferred video encoding parameters to apply to the stream's video tracks, such as bitrate, frame rate, or priority.

    Type Declaration

    • OptionalmaxBitrate?: number

      Preferred maximum bitrate in bits per second to encode the video tracks.

    • OptionalmaxFramerate?: number

      Preferred maximum frame rate to encode the video tracks.

    • Optionalpriority?: RTCPriorityType

      Preferred priority for encoding the video tracks.

    • OptionalscaleResolutionDownBy?: number

      Preferred scale factor to downscale the video resolution.