livekit-client 2.22.2 → 2.22.4

package/dist/ts4.2/room/track/options.d.ts

@@ -1,403 +1,403 @@
-import type { FrameMetadataPublishOptions } from '../../frameMetadata/types';
-import type { Track } from './Track';
-import type { AudioProcessorOptions, TrackProcessor, VideoProcessorOptions } from './processor/types';
-export interface TrackPublishDefaults {
-    /**
-     * encoding parameters for camera track
-     */
-    videoEncoding?: VideoEncoding;
-    /**
-     * Advanced codecs (VP9/AV1/H265) are not supported by all browser clients. When backupCodec is
-     * set, when an incompatible client attempts to subscribe to the track, LiveKit
-     * will automatically publish a secondary track encoded with the backup codec.
-     *
-     * You could customize specific encoding parameters of the backup track by
-     * explicitly setting codec and encoding fields.
-     *
-     * Defaults to `true`
-     */
-    backupCodec?: true | false | {
-        codec: BackupVideoCodec;
-        encoding?: VideoEncoding;
-    };
-    /**
-     * When backup codec is enabled, there are two options to decide whether to
-     * send the primary codec at the same time:
-     *   * codec regression: publisher stops sending primary codec and all subscribers
-     *       will receive backup codec even if the primary codec is supported on their browser. It is the default
-     *       behavior and provides maximum compatibility. It also reduces CPU
-     *       and bandwidth consumption for publisher.
-     *   * multi-codec simulcast: publisher encodes and sends both codecs at same time,
-     *       subscribers will get most efficient codec. It will provide most bandwidth
-     *       efficiency, especially in the large 1:N room but requires more device performance
-     *       and bandwidth consumption for publisher.
-     */
-    backupCodecPolicy?: BackupCodecPolicy;
-    /**
-     * encoding parameters for screen share track
-     */
-    screenShareEncoding?: VideoEncoding;
-    /**
-     * codec, defaults to vp8; for svc codecs, auto enable vp8
-     * as backup. (TBD)
-     */
-    videoCodec?: VideoCodec;
-    /**
-     * which audio preset should be used for publishing (audio) tracks
-     * defaults to [[AudioPresets.music]]
-     */
-    audioPreset?: AudioPreset;
-    /**
-     * dtx (Discontinuous Transmission of audio), enabled by default for mono tracks.
-     */
-    dtx?: boolean;
-    /**
-     * red (Redundant Audio Data), enabled by default for mono tracks.
-     */
-    red?: boolean;
-    /**
-     * publish track in stereo mode (or set to false to disable). defaults determined by capture channel count.
-     */
-    forceStereo?: boolean;
-    /**
-     * use simulcast, defaults to true.
-     * When using simulcast, LiveKit will publish up to three versions of the stream
-     * at various resolutions.
-     */
-    simulcast?: boolean;
-    /**
-     * scalability mode for svc codecs, defaults to 'L3T3_KEY'.
-     * for svc codecs, simulcast is disabled.
-     */
-    scalabilityMode?: ScalabilityMode;
-    /**
-     * Controls how the encoder trades off between resolution and framerate
-     * when bandwidth is constrained.
-     *
-     * - 'maintain-framerate': Prioritizes framerate, reduces resolution if needed
-     * - 'maintain-resolution': Prioritizes resolution, drops frames if needed
-     * - 'balanced': Balances between both
-     *
-     * If not set, the SDK uses defaults based on track source:
-     * - Camera: 'maintain-framerate' (smoother video for real-time communication)
-     * - Screen share: 'maintain-resolution' (clarity is critical for text/UI)
-     * - Other/unknown: 'balanced'
-     */
-    degradationPreference?: RTCDegradationPreference;
-    /**
-     * Up to two additional simulcast layers to publish in addition to the original
-     * Track.
-     * When left blank, it defaults to h180, h360.
-     * If a SVC codec is used (VP9 or AV1), this field has no effect.
-     *
-     * To publish three total layers, you would specify:
-     * {
-     *   videoEncoding: {...}, // encoding of the primary layer
-     *   videoSimulcastLayers: [
-     *     VideoPresets.h540,
-     *     VideoPresets.h216,
-     *   ],
-     * }
-     */
-    videoSimulcastLayers?: Array<VideoPreset>;
-    /**
-     * custom video simulcast layers for screen tracks
-     * Note: the layers need to be ordered from lowest to highest quality
-     */
-    screenShareSimulcastLayers?: Array<VideoPreset>;
-    /**
-     * For local tracks, stop the underlying MediaStreamTrack when the track is muted (or paused)
-     * on some platforms, this option is necessary to disable the microphone recording indicator.
-     * Note: when this is enabled, and BT devices are connected, they will transition between
-     * profiles (e.g. HFP to A2DP) and there will be an audible difference in playback.
-     *
-     * defaults to false
-     */
-    stopMicTrackOnMute?: boolean;
-    /**
-     * Enables preconnect buffer for a user's microphone track.
-     * This is useful for reducing perceived latency when the user starts to speak before the connection is established.
-     * Only works for agent use cases.
-     *
-     * Defaults to false.
-     */
-    preConnectBuffer?: boolean;
-    /**
-     * Frame metadata to append to published video frames.
-     *
-     * Requires either room-level frame metadata worker configuration or E2EE,
-     * because encoded frame transforms are used to write the metadata.
-     *
-     * @experimental
-     */
-    frameMetadata?: FrameMetadataPublishOptions;
-    /**
-     * @deprecated Use {@link TrackPublishDefaults.frameMetadata} instead.
-     */
-    packetTrailer?: FrameMetadataPublishOptions;
-}
-/**
- * Options when publishing tracks
- */
-export interface TrackPublishOptions extends TrackPublishDefaults {
-    /**
-     * set a track name
-     */
-    name?: string;
-    /**
-     * Source of track, camera, microphone, or screen
-     */
-    source?: Track.Source;
-    /**
-     * Set stream name for the track. Audio and video tracks with the same stream name
-     * will be placed in the same `MediaStream` and offer better synchronization.
-     * By default, camera and microphone will be placed in a stream; as would screen_share and screen_share_audio
-     */
-    stream?: string;
-}
-export interface CreateLocalTracksOptions {
-    /**
-     * audio track options, true to create with defaults. false if audio shouldn't be created
-     * default true
-     */
-    audio?: boolean | AudioCaptureOptions;
-    /**
-     * video track options, true to create with defaults. false if video shouldn't be created
-     * default true
-     */
-    video?: boolean | VideoCaptureOptions;
-}
-export interface VideoCaptureOptions {
-    /**
-     * A ConstrainDOMString object specifying a device ID or an array of device
-     * IDs which are acceptable and/or required.
-     */
-    deviceId?: ConstrainDOMString;
-    /**
-     * A ConstrainDouble specifying the frame rate or range of frame rates which are acceptable and/or required.
-     */
-    frameRate?: ConstrainDouble;
-    /**
-     * a facing or an array of facings which are acceptable and/or required.
-     */
-    facingMode?: 'user' | 'environment' | 'left' | 'right';
-    resolution?: VideoResolution;
-    /**
-     * initialize the track with a given processor
-     */
-    processor?: TrackProcessor<Track.Kind.Video, VideoProcessorOptions>;
-}
-export interface ScreenShareCaptureOptions {
-    /**
-     * true to capture audio shared. browser support for audio capturing in
-     * screenshare is limited: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#browser_compatibility
-     */
-    audio?: boolean | AudioCaptureOptions;
-    /**
-     * only allows for 'true' and chrome allows for additional options to be passed in
-     * https://developer.chrome.com/docs/web-platform/screen-sharing-controls/#displaySurface
-     */
-    video?: true | {
-        displaySurface?: 'window' | 'browser' | 'monitor';
-    };
-    /**
-     * capture resolution, defaults to 1080 for all browsers other than Safari
-     * On Safari 17, default resolution is not capped, due to a bug, specifying
-     * any resolution at all would lead to a low-resolution capture.
-     * https://bugs.webkit.org/show_bug.cgi?id=263015
-     */
-    resolution?: VideoResolution;
-    /** a CaptureController object instance containing methods that can be used to further manipulate the capture session if included. */
-    controller?: unknown;
-    /** specifies whether the browser should allow the user to select the current tab for capture */
-    selfBrowserSurface?: 'include' | 'exclude';
-    /** specifies whether the browser should display a control to allow the user to dynamically switch the shared tab during screen-sharing. */
-    surfaceSwitching?: 'include' | 'exclude';
-    /** specifies whether the browser should include the system audio among the possible audio sources offered to the user */
-    systemAudio?: 'include' | 'exclude';
-    /** specify the type of content, see: https://www.w3.org/TR/mst-content-hint/#video-content-hints */
-    contentHint?: 'detail' | 'text' | 'motion';
-    /**
-     * Experimental option to control whether the audio playing in a tab will continue to be played out of a user's
-     * local speakers when the tab is captured.
-     */
-    suppressLocalAudioPlayback?: boolean;
-    /**
-     * Experimental option to instruct the browser to offer the current tab as the most prominent capture source
-     * @experimental
-     * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#prefercurrenttab
-     */
-    preferCurrentTab?: boolean;
-}
-export interface AudioCaptureOptions {
-    /**
-     * specifies whether automatic gain control is preferred and/or required
-     */
-    autoGainControl?: ConstrainBoolean;
-    /**
-     * the channel count or range of channel counts which are acceptable and/or required
-     */
-    channelCount?: ConstrainULong;
-    /**
-     * A ConstrainDOMString object specifying a device ID or an array of device
-     * IDs which are acceptable and/or required.
-     */
-    deviceId?: ConstrainDOMString;
-    /**
-     * whether or not echo cancellation is preferred and/or required
-     */
-    echoCancellation?: ConstrainBoolean;
-    /**
-     * the latency or range of latencies which are acceptable and/or required.
-     */
-    latency?: ConstrainDouble;
-    /**
-     * whether noise suppression is preferred and/or required.
-     */
-    noiseSuppression?: ConstrainBoolean;
-    /**
-     * @experimental
-     * a stronger version of 'noiseSuppression', browser support is not widespread yet.
-     * If this is set (and supported) the value for 'noiseSuppression' will be ignored
-     * @see https://w3c.github.io/mediacapture-extensions/#voiceisolation-constraint
-     */
-    voiceIsolation?: ConstrainBoolean;
-    /**
-     * @experimental
-     * when capturing system/screen-share audio, excludes the local participant's own audio
-     * from the captured stream to prevent echo. Browser support is not widespread yet
-     * (as of mid 2026, Chromium-based browsers only).
-     * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/restrictOwnAudio
-     */
-    restrictOwnAudio?: ConstrainBoolean;
-    /**
-     * the sample rate or range of sample rates which are acceptable and/or required.
-     */
-    sampleRate?: ConstrainULong;
-    /**
-     * sample size or range of sample sizes which are acceptable and/or required.
-     */
-    sampleSize?: ConstrainULong;
-    /**
-     * initialize the track with a given processor
-     */
-    processor?: TrackProcessor<Track.Kind.Audio, AudioProcessorOptions>;
-}
-export interface AudioOutputOptions {
-    /**
-     * deviceId to output audio
-     *
-     * Only supported on browsers where `setSinkId` is available
-     */
-    deviceId?: string;
-}
-export interface VideoResolution {
-    width: number;
-    height: number;
-    frameRate?: number;
-    aspectRatio?: number;
-}
-export interface VideoEncoding {
-    maxBitrate: number;
-    maxFramerate?: number;
-    priority?: RTCPriorityType;
-}
-export interface VideoPresetOptions {
-    width: number;
-    height: number;
-    aspectRatio?: number;
-    maxBitrate: number;
-    maxFramerate?: number;
-    priority?: RTCPriorityType;
-}
-export declare class VideoPreset {
-    encoding: VideoEncoding;
-    width: number;
-    height: number;
-    aspectRatio?: number;
-    constructor(videoPresetOptions: VideoPresetOptions);
-    constructor(width: number, height: number, maxBitrate: number, maxFramerate?: number, priority?: RTCPriorityType);
-    get resolution(): VideoResolution;
-}
-export interface AudioPreset {
-    maxBitrate: number;
-    priority?: RTCPriorityType;
-}
-export declare const audioCodecs: readonly [
-    "opus",
-    "red"
-];
-export type AudioCodec = (typeof audioCodecs)[number];
-declare const backupVideoCodecs: readonly [
-    "vp8",
-    "h264"
-];
-export declare const videoCodecs: readonly [
-    "vp8",
-    "h264",
-    "vp9",
-    "av1",
-    "h265"
-];
-export type VideoCodec = (typeof videoCodecs)[number];
-export type BackupVideoCodec = (typeof backupVideoCodecs)[number];
-export declare function isBackupVideoCodec(codec: string): codec is BackupVideoCodec;
-/** @deprecated Use {@link isBackupVideoCodec} instead */
-export declare const isBackupCodec: typeof isBackupVideoCodec;
-export declare enum BackupCodecPolicy {
-    PREFER_REGRESSION = 0,
-    SIMULCAST = 1,
-    REGRESSION = 2
-}
-/**
- * scalability modes for svc.
- */
-export type ScalabilityMode = 'L1T1' | 'L1T2' | 'L1T3' | 'L2T1' | 'L2T1h' | 'L2T1_KEY' | 'L2T2' | 'L2T2h' | 'L2T2_KEY' | 'L2T3' | 'L2T3h' | 'L2T3_KEY' | 'L3T1' | 'L3T1h' | 'L3T1_KEY' | 'L3T2' | 'L3T2h' | 'L3T2_KEY' | 'L3T3' | 'L3T3h' | 'L3T3_KEY';
-export declare namespace AudioPresets {
-    const telephone: AudioPreset;
-    const speech: AudioPreset;
-    const music: AudioPreset;
-    const musicStereo: AudioPreset;
-    const musicHighQuality: AudioPreset;
-    const musicHighQualityStereo: AudioPreset;
-}
-/**
- * Sane presets for video resolution/encoding
- */
-export declare const VideoPresets: {
-    readonly h90: VideoPreset;
-    readonly h180: VideoPreset;
-    readonly h216: VideoPreset;
-    readonly h360: VideoPreset;
-    readonly h540: VideoPreset;
-    readonly h720: VideoPreset;
-    readonly h1080: VideoPreset;
-    readonly h1440: VideoPreset;
-    readonly h2160: VideoPreset;
-};
-/**
- * Four by three presets
- */
-export declare const VideoPresets43: {
-    readonly h120: VideoPreset;
-    readonly h180: VideoPreset;
-    readonly h240: VideoPreset;
-    readonly h360: VideoPreset;
-    readonly h480: VideoPreset;
-    readonly h540: VideoPreset;
-    readonly h720: VideoPreset;
-    readonly h1080: VideoPreset;
-    readonly h1440: VideoPreset;
-};
-export declare const ScreenSharePresets: {
-    readonly h360fps3: VideoPreset;
-    readonly h360fps15: VideoPreset;
-    readonly h720fps5: VideoPreset;
-    readonly h720fps15: VideoPreset;
-    readonly h720fps30: VideoPreset;
-    readonly h1080fps15: VideoPreset;
-    readonly h1080fps30: VideoPreset;
-    readonly original: VideoPreset;
-};
-export {};
-//# sourceMappingURL=options.d.ts.map
+import type { FrameMetadataPublishOptions } from '../../frameMetadata/types';
+import type { Track } from './Track';
+import type { AudioProcessorOptions, TrackProcessor, VideoProcessorOptions } from './processor/types';
+export interface TrackPublishDefaults {
+    /**
+     * encoding parameters for camera track
+     */
+    videoEncoding?: VideoEncoding;
+    /**
+     * Advanced codecs (VP9/AV1/H265) are not supported by all browser clients. When backupCodec is
+     * set, when an incompatible client attempts to subscribe to the track, LiveKit
+     * will automatically publish a secondary track encoded with the backup codec.
+     *
+     * You could customize specific encoding parameters of the backup track by
+     * explicitly setting codec and encoding fields.
+     *
+     * Defaults to `true`
+     */
+    backupCodec?: true | false | {
+        codec: BackupVideoCodec;
+        encoding?: VideoEncoding;
+    };
+    /**
+     * When backup codec is enabled, there are two options to decide whether to
+     * send the primary codec at the same time:
+     *   * codec regression: publisher stops sending primary codec and all subscribers
+     *       will receive backup codec even if the primary codec is supported on their browser. It is the default
+     *       behavior and provides maximum compatibility. It also reduces CPU
+     *       and bandwidth consumption for publisher.
+     *   * multi-codec simulcast: publisher encodes and sends both codecs at same time,
+     *       subscribers will get most efficient codec. It will provide most bandwidth
+     *       efficiency, especially in the large 1:N room but requires more device performance
+     *       and bandwidth consumption for publisher.
+     */
+    backupCodecPolicy?: BackupCodecPolicy;
+    /**
+     * encoding parameters for screen share track
+     */
+    screenShareEncoding?: VideoEncoding;
+    /**
+     * codec, defaults to vp8; for svc codecs, auto enable vp8
+     * as backup. (TBD)
+     */
+    videoCodec?: VideoCodec;
+    /**
+     * which audio preset should be used for publishing (audio) tracks
+     * defaults to [[AudioPresets.music]]
+     */
+    audioPreset?: AudioPreset;
+    /**
+     * dtx (Discontinuous Transmission of audio), enabled by default for mono tracks.
+     */
+    dtx?: boolean;
+    /**
+     * red (Redundant Audio Data), enabled by default for mono tracks.
+     */
+    red?: boolean;
+    /**
+     * publish track in stereo mode (or set to false to disable). defaults determined by capture channel count.
+     */
+    forceStereo?: boolean;
+    /**
+     * use simulcast, defaults to true.
+     * When using simulcast, LiveKit will publish up to three versions of the stream
+     * at various resolutions.
+     */
+    simulcast?: boolean;
+    /**
+     * scalability mode for svc codecs, defaults to 'L3T3_KEY'.
+     * for svc codecs, simulcast is disabled if more than one spatial layer is used ('L2Tx' or 'L3Tx').
+     */
+    scalabilityMode?: ScalabilityMode;
+    /**
+     * Controls how the encoder trades off between resolution and framerate
+     * when bandwidth is constrained.
+     *
+     * - 'maintain-framerate': Prioritizes framerate, reduces resolution if needed
+     * - 'maintain-resolution': Prioritizes resolution, drops frames if needed
+     * - 'balanced': Balances between both
+     *
+     * If not set, the SDK uses defaults based on track source:
+     * - Camera: 'maintain-framerate' (smoother video for real-time communication)
+     * - Screen share: 'maintain-resolution' (clarity is critical for text/UI)
+     * - Other/unknown: 'balanced'
+     */
+    degradationPreference?: RTCDegradationPreference;
+    /**
+     * Up to two additional simulcast layers to publish in addition to the original
+     * Track.
+     * When left blank, it defaults to h180, h360.
+     * If a SVC codec is used (VP9 or AV1), this field has no effect.
+     *
+     * To publish three total layers, you would specify:
+     * {
+     *   videoEncoding: {...}, // encoding of the primary layer
+     *   videoSimulcastLayers: [
+     *     VideoPresets.h540,
+     *     VideoPresets.h216,
+     *   ],
+     * }
+     */
+    videoSimulcastLayers?: Array<VideoPreset>;
+    /**
+     * custom video simulcast layers for screen tracks
+     * Note: the layers need to be ordered from lowest to highest quality
+     */
+    screenShareSimulcastLayers?: Array<VideoPreset>;
+    /**
+     * For local tracks, stop the underlying MediaStreamTrack when the track is muted (or paused)
+     * on some platforms, this option is necessary to disable the microphone recording indicator.
+     * Note: when this is enabled, and BT devices are connected, they will transition between
+     * profiles (e.g. HFP to A2DP) and there will be an audible difference in playback.
+     *
+     * defaults to false
+     */
+    stopMicTrackOnMute?: boolean;
+    /**
+     * Enables preconnect buffer for a user's microphone track.
+     * This is useful for reducing perceived latency when the user starts to speak before the connection is established.
+     * Only works for agent use cases.
+     *
+     * Defaults to false.
+     */
+    preConnectBuffer?: boolean;
+    /**
+     * Frame metadata to append to published video frames.
+     *
+     * Requires either room-level frame metadata worker configuration or E2EE,
+     * because encoded frame transforms are used to write the metadata.
+     *
+     * @experimental
+     */
+    frameMetadata?: FrameMetadataPublishOptions;
+    /**
+     * @deprecated Use {@link TrackPublishDefaults.frameMetadata} instead.
+     */
+    packetTrailer?: FrameMetadataPublishOptions;
+}
+/**
+ * Options when publishing tracks
+ */
+export interface TrackPublishOptions extends TrackPublishDefaults {
+    /**
+     * set a track name
+     */
+    name?: string;
+    /**
+     * Source of track, camera, microphone, or screen
+     */
+    source?: Track.Source;
+    /**
+     * Set stream name for the track. Audio and video tracks with the same stream name
+     * will be placed in the same `MediaStream` and offer better synchronization.
+     * By default, camera and microphone will be placed in a stream; as would screen_share and screen_share_audio
+     */
+    stream?: string;
+}
+export interface CreateLocalTracksOptions {
+    /**
+     * audio track options, true to create with defaults. false if audio shouldn't be created
+     * default true
+     */
+    audio?: boolean | AudioCaptureOptions;
+    /**
+     * video track options, true to create with defaults. false if video shouldn't be created
+     * default true
+     */
+    video?: boolean | VideoCaptureOptions;
+}
+export interface VideoCaptureOptions {
+    /**
+     * A ConstrainDOMString object specifying a device ID or an array of device
+     * IDs which are acceptable and/or required.
+     */
+    deviceId?: ConstrainDOMString;
+    /**
+     * A ConstrainDouble specifying the frame rate or range of frame rates which are acceptable and/or required.
+     */
+    frameRate?: ConstrainDouble;
+    /**
+     * a facing or an array of facings which are acceptable and/or required.
+     */
+    facingMode?: 'user' | 'environment' | 'left' | 'right';
+    resolution?: VideoResolution;
+    /**
+     * initialize the track with a given processor
+     */
+    processor?: TrackProcessor<Track.Kind.Video, VideoProcessorOptions>;
+}
+export interface ScreenShareCaptureOptions {
+    /**
+     * true to capture audio shared. browser support for audio capturing in
+     * screenshare is limited: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#browser_compatibility
+     */
+    audio?: boolean | AudioCaptureOptions;
+    /**
+     * only allows for 'true' and chrome allows for additional options to be passed in
+     * https://developer.chrome.com/docs/web-platform/screen-sharing-controls/#displaySurface
+     */
+    video?: true | {
+        displaySurface?: 'window' | 'browser' | 'monitor';
+    };
+    /**
+     * capture resolution, defaults to 1080 for all browsers other than Safari
+     * On Safari 17, default resolution is not capped, due to a bug, specifying
+     * any resolution at all would lead to a low-resolution capture.
+     * https://bugs.webkit.org/show_bug.cgi?id=263015
+     */
+    resolution?: VideoResolution;
+    /** a CaptureController object instance containing methods that can be used to further manipulate the capture session if included. */
+    controller?: unknown;
+    /** specifies whether the browser should allow the user to select the current tab for capture */
+    selfBrowserSurface?: 'include' | 'exclude';
+    /** specifies whether the browser should display a control to allow the user to dynamically switch the shared tab during screen-sharing. */
+    surfaceSwitching?: 'include' | 'exclude';
+    /** specifies whether the browser should include the system audio among the possible audio sources offered to the user */
+    systemAudio?: 'include' | 'exclude';
+    /** specify the type of content, see: https://www.w3.org/TR/mst-content-hint/#video-content-hints */
+    contentHint?: 'detail' | 'text' | 'motion';
+    /**
+     * Experimental option to control whether the audio playing in a tab will continue to be played out of a user's
+     * local speakers when the tab is captured.
+     */
+    suppressLocalAudioPlayback?: boolean;
+    /**
+     * Experimental option to instruct the browser to offer the current tab as the most prominent capture source
+     * @experimental
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#prefercurrenttab
+     */
+    preferCurrentTab?: boolean;
+}
+export interface AudioCaptureOptions {
+    /**
+     * specifies whether automatic gain control is preferred and/or required
+     */
+    autoGainControl?: ConstrainBoolean;
+    /**
+     * the channel count or range of channel counts which are acceptable and/or required
+     */
+    channelCount?: ConstrainULong;
+    /**
+     * A ConstrainDOMString object specifying a device ID or an array of device
+     * IDs which are acceptable and/or required.
+     */
+    deviceId?: ConstrainDOMString;
+    /**
+     * whether or not echo cancellation is preferred and/or required
+     */
+    echoCancellation?: ConstrainBoolean;
+    /**
+     * the latency or range of latencies which are acceptable and/or required.
+     */
+    latency?: ConstrainDouble;
+    /**
+     * whether noise suppression is preferred and/or required.
+     */
+    noiseSuppression?: ConstrainBoolean;
+    /**
+     * @experimental
+     * a stronger version of 'noiseSuppression', browser support is not widespread yet.
+     * If this is set (and supported) the value for 'noiseSuppression' will be ignored
+     * @see https://w3c.github.io/mediacapture-extensions/#voiceisolation-constraint
+     */
+    voiceIsolation?: ConstrainBoolean;
+    /**
+     * @experimental
+     * when capturing system/screen-share audio, excludes the local participant's own audio
+     * from the captured stream to prevent echo. Browser support is not widespread yet
+     * (as of mid 2026, Chromium-based browsers only).
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/restrictOwnAudio
+     */
+    restrictOwnAudio?: ConstrainBoolean;
+    /**
+     * the sample rate or range of sample rates which are acceptable and/or required.
+     */
+    sampleRate?: ConstrainULong;
+    /**
+     * sample size or range of sample sizes which are acceptable and/or required.
+     */
+    sampleSize?: ConstrainULong;
+    /**
+     * initialize the track with a given processor
+     */
+    processor?: TrackProcessor<Track.Kind.Audio, AudioProcessorOptions>;
+}
+export interface AudioOutputOptions {
+    /**
+     * deviceId to output audio
+     *
+     * Only supported on browsers where `setSinkId` is available
+     */
+    deviceId?: string;
+}
+export interface VideoResolution {
+    width: number;
+    height: number;
+    frameRate?: number;
+    aspectRatio?: number;
+}
+export interface VideoEncoding {
+    maxBitrate: number;
+    maxFramerate?: number;
+    priority?: RTCPriorityType;
+}
+export interface VideoPresetOptions {
+    width: number;
+    height: number;
+    aspectRatio?: number;
+    maxBitrate: number;
+    maxFramerate?: number;
+    priority?: RTCPriorityType;
+}
+export declare class VideoPreset {
+    encoding: VideoEncoding;
+    width: number;
+    height: number;
+    aspectRatio?: number;
+    constructor(videoPresetOptions: VideoPresetOptions);
+    constructor(width: number, height: number, maxBitrate: number, maxFramerate?: number, priority?: RTCPriorityType);
+    get resolution(): VideoResolution;
+}
+export interface AudioPreset {
+    maxBitrate: number;
+    priority?: RTCPriorityType;
+}
+export declare const audioCodecs: readonly [
+    "opus",
+    "red"
+];
+export type AudioCodec = (typeof audioCodecs)[number];
+declare const backupVideoCodecs: readonly [
+    "vp8",
+    "h264"
+];
+export declare const videoCodecs: readonly [
+    "vp8",
+    "h264",
+    "vp9",
+    "av1",
+    "h265"
+];
+export type VideoCodec = (typeof videoCodecs)[number];
+export type BackupVideoCodec = (typeof backupVideoCodecs)[number];
+export declare function isBackupVideoCodec(codec: string): codec is BackupVideoCodec;
+/** @deprecated Use {@link isBackupVideoCodec} instead */
+export declare const isBackupCodec: typeof isBackupVideoCodec;
+export declare enum BackupCodecPolicy {
+    PREFER_REGRESSION = 0,
+    SIMULCAST = 1,
+    REGRESSION = 2
+}
+/**
+ * scalability modes for svc.
+ */
+export type ScalabilityMode = 'L1T1' | 'L1T2' | 'L1T3' | 'L2T1' | 'L2T1h' | 'L2T1_KEY' | 'L2T2' | 'L2T2h' | 'L2T2_KEY' | 'L2T3' | 'L2T3h' | 'L2T3_KEY' | 'L3T1' | 'L3T1h' | 'L3T1_KEY' | 'L3T2' | 'L3T2h' | 'L3T2_KEY' | 'L3T3' | 'L3T3h' | 'L3T3_KEY';
+export declare namespace AudioPresets {
+    const telephone: AudioPreset;
+    const speech: AudioPreset;
+    const music: AudioPreset;
+    const musicStereo: AudioPreset;
+    const musicHighQuality: AudioPreset;
+    const musicHighQualityStereo: AudioPreset;
+}
+/**
+ * Sane presets for video resolution/encoding
+ */
+export declare const VideoPresets: {
+    readonly h90: VideoPreset;
+    readonly h180: VideoPreset;
+    readonly h216: VideoPreset;
+    readonly h360: VideoPreset;
+    readonly h540: VideoPreset;
+    readonly h720: VideoPreset;
+    readonly h1080: VideoPreset;
+    readonly h1440: VideoPreset;
+    readonly h2160: VideoPreset;
+};
+/**
+ * Four by three presets
+ */
+export declare const VideoPresets43: {
+    readonly h120: VideoPreset;
+    readonly h180: VideoPreset;
+    readonly h240: VideoPreset;
+    readonly h360: VideoPreset;
+    readonly h480: VideoPreset;
+    readonly h540: VideoPreset;
+    readonly h720: VideoPreset;
+    readonly h1080: VideoPreset;
+    readonly h1440: VideoPreset;
+};
+export declare const ScreenSharePresets: {
+    readonly h360fps3: VideoPreset;
+    readonly h360fps15: VideoPreset;
+    readonly h720fps5: VideoPreset;
+    readonly h720fps15: VideoPreset;
+    readonly h720fps30: VideoPreset;
+    readonly h1080fps15: VideoPreset;
+    readonly h1080fps30: VideoPreset;
+    readonly original: VideoPreset;
+};
+export {};
+//# sourceMappingURL=options.d.ts.map