Interface VideoStreamIdSet

VideoStreamIdSet holds the set of video streams by stream id.

Hierarchy

VideoStreamIdSet

Implemented by

DefaultVideoStreamIdSet

Index

Methods

Methods

add

add(streamId: number): void

- Defined in src/videostreamidset/VideoStreamIdSet.ts:11
Adds stream id to the set

Parameters
- streamId: number
Returns void

array

array(): number[]

- Defined in src/videostreamidset/VideoStreamIdSet.ts:16
Returns the sorted array representation of VideoStreamIdSet

Returns number[]

clone

clone(): VideoStreamIdSet

- Defined in src/videostreamidset/VideoStreamIdSet.ts:46
Returns a copy of the current set

Returns VideoStreamIdSet

contain

contain(streamId: number): boolean

- Defined in src/videostreamidset/VideoStreamIdSet.ts:21
Checks whether the current set contains a stream id

Parameters
- streamId: number
Returns boolean

empty

empty(): boolean

- Defined in src/videostreamidset/VideoStreamIdSet.ts:31
Checks whether the current set is empty

Returns boolean

equal

equal(other: VideoStreamIdSet): boolean

- Defined in src/videostreamidset/VideoStreamIdSet.ts:41
Checks whether two sets are equivalent

Parameters
- other: VideoStreamIdSet
Returns boolean

Optional forEach

forEach(callbackFn: (streamId: number) => void): void

- Defined in src/videostreamidset/VideoStreamIdSet.ts:26
Checks whether the current set contains a stream id

Parameters
- callbackFn: (streamId: number) => void
  - - (streamId: number): void
    - Parameters
      - streamId: number
      Returns void
Returns void

remove

remove(streamId: number): void

- Defined in src/videostreamidset/VideoStreamIdSet.ts:51
Removes a stream id

Parameters
- streamId: number
Returns void

size

size(): number

- Defined in src/videostreamidset/VideoStreamIdSet.ts:36
Returns the size of the current set

Returns number

toJSON

toJSON(): number[]

- Defined in src/videostreamidset/VideoStreamIdSet.ts:56
Converts VideoStreamIdSet to JSON format

Returns number[]

truncate

truncate(length: number): VideoStreamIdSet

- Defined in src/videostreamidset/VideoStreamIdSet.ts:65
Returns a copy of the current set, with only N values copied from the original set.

Parameters
- length: number
  
  the total number of values to be included in the new set.
Returns VideoStreamIdSet

Generated using TypeDoc