Class VideoPreference

Hierarchy

VideoPreference

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new VideoPreference(attendeeId: string, priority: number, targetSize?: TargetDisplaySize): VideoPreference

- Defined in src/videodownlinkbandwidthpolicy/VideoPreference.ts:11
Initializes a VideoPreference with the given properties.

Parameters
- attendeeId: string
  
  Attendee ID of the client
- priority: number
  
  The relative priority of this attendee against others.
- Optional targetSize: TargetDisplaySize
  
  The desired maximum simulcast layers to receive.
Returns VideoPreference

Properties

attendeeId

attendeeId: string

priority

priority: number

targetSize

targetSize: TargetDisplaySize

The desired maximum simulcast layers to receive.

Methods

clone

clone(): VideoPreference

- Defined in src/videodownlinkbandwidthpolicy/VideoPreference.ts:35
Returns VideoPreference

equals

equals(other: VideoPreference): boolean

Implementation of Eq.equals
- Defined in src/videodownlinkbandwidthpolicy/VideoPreference.ts:27
Return true if the other value is exactly equal to this value.

Parameters
- other: VideoPreference
Returns boolean

partialCompare

partialCompare(other: VideoPreference): number

Implementation of PartialOrd.partialCompare
- Defined in src/videodownlinkbandwidthpolicy/VideoPreference.ts:23
Compare this value to another, returning a relative value as documented by Array.sort

Parameters
- other: VideoPreference
Returns number

targetSizeToBitrateKbps

targetSizeToBitrateKbps(targetSize: TargetDisplaySize): number

- Defined in src/videodownlinkbandwidthpolicy/VideoPreference.ts:44
Parameters
- targetSize: TargetDisplaySize
Returns number

Generated using TypeDoc