Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VideoUplinkBandwidthPolicy

A VideoUplinkBandwidthPolicy makes decisions about uplink video bandwidth usage and related camera capture parameters.

Hierarchy

Implemented by

Index

Methods

chooseCaptureAndEncodeParameters

chooseEncodingParameters

  • chooseEncodingParameters(): Map<string, RTCRtpEncodingParameters>

chooseMediaTrackConstraints

  • chooseMediaTrackConstraints(): MediaTrackConstraints

maxBandwidthKbps

  • maxBandwidthKbps(): number

Optional reset

  • reset(): void

setHasBandwidthPriority

  • setHasBandwidthPriority(hasBandwidthPriority: boolean): void

setIdealMaxBandwidthKbps

  • setIdealMaxBandwidthKbps(maxBandwidthKbps: number): void

Optional setTransceiverController

  • Set a reference to the current transceiver controller. The audio video controller should call this method to pass down a transceiver controller to the policy when the meeting starts and set it to undefined when the meeting ends. If a meeting is stopped and started repeatedly, this pair of calls will be repeated to match. All calls to updateTransceiverController will occur between this pair of calls. This method should not throw.

    Parameters

    Returns void

updateConnectionMetric

updateIndex

Optional updateTransceiverController

  • updateTransceiverController(): void
  • Update the transceiver controller that is set from setTransceiverController such as setEncodingParameters. Only used when unified plan is enabled but not available for simulcast for now. This method should be called when the policy needs to update the local video encoding parameters such as after setHasBandwidthPriority has been called. The default audio video controller calls this after a video is on/off or when an active speakers changes. This method should not throw.

    Returns void

wantsResubscribe

  • wantsResubscribe(): boolean

Generated using TypeDoc