peerix - v0.1.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

    Properties

    audioParameters? label? managed? stream videoParameters?

    Properties

    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 will be used.

    managed?: boolean

    Whether the peer should manage the lifecycle of the stream's tracks. If true, tracks will be stopped when the stream is unpublished or replaced.

    stream: MediaStream

    Media stream to publish.

    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.

    Settings

    Member Visibility

    On This Page

    Properties