Class DefaultSimulcastUplinkPolicyForContentShare

[[DefaultSimulcastUplinkPolicyForContentShare]] sets the capture and encode parameters based on constructor input parameters

Implements

SimulcastUplinkPolicy

Index

Constructors

Methods

addObserver chooseCaptureAndEncodeParameters chooseEncodingParameters chooseMediaTrackConstraints forEachObserver maxBandwidthKbps removeObserver setHasBandwidthPriority setHighResolutionFeatureEnabled setIdealMaxBandwidthKbps updateConnectionMetric updateIndex wantsResubscribe

Constructors

constructor

new DefaultSimulcastUplinkPolicyForContentShare(
_logger: Logger,
encodingParams?: ContentShareSimulcastEncodingParameters,
): DefaultSimulcastUplinkPolicyForContentShare
Parameters
- _logger: Logger
- OptionalencodingParams: ContentShareSimulcastEncodingParameters
Returns DefaultSimulcastUplinkPolicyForContentShare
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:17

Methods

addObserver

addObserver(_observer: SimulcastUplinkObserver): void
Adds SimulcastUplinkObserver to observe simulcast encoding resolution layer changes
Parameters
- _observer: SimulcastUplinkObserver
Returns void
Implementation of SimulcastUplinkPolicy.addObserver
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:28

chooseCaptureAndEncodeParameters

chooseCaptureAndEncodeParameters(): DefaultVideoCaptureAndEncodeParameter
Update the internal state with the capture and encode parameters we expect to be used, and return the parameters.

Returns DefaultVideoCaptureAndEncodeParameter
Implementation of SimulcastUplinkPolicy.chooseCaptureAndEncodeParameters
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:23

chooseEncodingParameters

chooseEncodingParameters(): Map<string, RTCRtpEncodingParameters>
Returns the selected encoding parameter

Returns Map<string, RTCRtpEncodingParameters>
Implementation of SimulcastUplinkPolicy.chooseEncodingParameters
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:20

chooseMediaTrackConstraints

chooseMediaTrackConstraints(): MediaTrackConstraints
This function is deprecated and unused, and will be removed in a future release.

Returns MediaTrackConstraints
Implementation of SimulcastUplinkPolicy.chooseMediaTrackConstraints
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:19

forEachObserver

forEachObserver(
_observerFunc: (observer: SimulcastUplinkObserver) => void,
): void
Iterates through each observer, so that their notification functions may be called.
Parameters
- _observerFunc: (observer: SimulcastUplinkObserver) => void
Returns void
Implementation of SimulcastUplinkPolicy.forEachObserver
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:30

maxBandwidthKbps

maxBandwidthKbps(): number
Gets the maximum encoding bitrate kbps after bandwidth constraints are applied.

Returns number
Implementation of SimulcastUplinkPolicy.maxBandwidthKbps
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:24

removeObserver

removeObserver(_observer: SimulcastUplinkObserver): void
Removes SimulcastUplinkObserver
Parameters
- _observer: SimulcastUplinkObserver
Returns void
Implementation of SimulcastUplinkPolicy.removeObserver
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:29

setHasBandwidthPriority

setHasBandwidthPriority(_hasBandwidthPriority: boolean): void
Sets whether video uplink bandwidth is currently prioritized.
Parameters
- _hasBandwidthPriority: boolean
Returns void
Implementation of SimulcastUplinkPolicy.setHasBandwidthPriority
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:26

setHighResolutionFeatureEnabled

setHighResolutionFeatureEnabled(enabled: boolean): void
Set if high resultion feature (i.e., 1080p for camera and 4k for content) is enabled.
Parameters
- enabled: boolean
Returns void
Implementation of SimulcastUplinkPolicy.setHighResolutionFeatureEnabled
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:27

setIdealMaxBandwidthKbps

setIdealMaxBandwidthKbps(_idealMaxBandwidthKbps: number): void
Sets ideal maximum bandwidth kbps.
Parameters
- _idealMaxBandwidthKbps: number
Returns void
Implementation of SimulcastUplinkPolicy.setIdealMaxBandwidthKbps
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:25

updateConnectionMetric

updateConnectionMetric(_metrics: ConnectionMetrics): void
Updates VideoUplinkPolicy with connection metrics
Parameters
- _metrics: ConnectionMetrics
Returns void
Implementation of SimulcastUplinkPolicy.updateConnectionMetric
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:18

updateIndex

updateIndex(_videoIndex: VideoStreamIndex): void
Potentially update the optimal capture and encode parameters based on the given VideoStreamIndex.
Parameters
- _videoIndex: VideoStreamIndex
Returns void
Implementation of SimulcastUplinkPolicy.updateIndex
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:21

wantsResubscribe

wantsResubscribe(): boolean
Return true if the policy has decided that a change to the captured and transmitted video stream would be beneficial.

Returns boolean
Implementation of SimulcastUplinkPolicy.wantsResubscribe
- Defined in build/videouplinkbandwidthpolicy/DefaultSimulcastUplinkPolicyForContentShare.d.ts:22