Class MediaTrackStats

Hierarchy

MediaTrackStats

Index

Constructors

Properties

bitrate codec framerate isAlive isEnabled isMuted jitter kind loss resolution trackId type

Accessors

alive enabled muted

Methods

getBitrate getCodec getFramerate getJitter getLoss getResolution getType resetBitrate setBitrate setCodec setFramerate setJitter setLoss setResolution

Constructors

constructor

new MediaTrackStats(trackId: string, type: TrackStatsType, kind: "audio" | "video"): MediaTrackStats
Parameters
- trackId: string
- type: TrackStatsType
- kind: "audio" | "video"
Returns MediaTrackStats
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:54

Properties

`Private` bitrate

bitrate: Bitrate = ...

`Private` codec

codec: string = ""

`Private` framerate

framerate: number = 0

`Private` isAlive

isAlive: boolean = true

`Private` isEnabled

isEnabled: boolean = true

`Private` isMuted

isMuted: boolean = false

`Private` jitter

jitter: number = 0

`Readonly` kind

kind: "audio" | "video"

`Private` loss

loss: PacketLoss = ...

`Private` resolution

resolution: Resolution = ...

`Readonly` trackId

trackId: string

`Readonly` type

type: TrackStatsType

Accessors

alive

get alive(): boolean
A MediaTrackState is alive if the corresponding MediaStreamTrack track bound to a transceiver and the MediaStreamTrack is in state MediaStreamTrack.readyState === live

Returns boolean
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:117
set alive(isAlive: boolean): void
Parameters
- isAlive: boolean
Returns void
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:109

enabled

get enabled(): boolean
A MediaTrackState.isEnabled corresponding to MediaStreamTrack.enabled. But these values only match if MediaTrackState.isAlive.

Returns boolean
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:141
set enabled(isEnabled: boolean): void
Parameters
- isEnabled: boolean
Returns void
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:133

muted

get muted(): boolean
A MediaTrackState.isMuted corresponding to MediaStreamTrack.muted. But these values only match if MediaTrackState.isAlive.

Returns boolean
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:129
set muted(isMuted: boolean): void
Parameters
- isMuted: boolean
Returns void
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:121

Methods

getBitrate

getBitrate(): Bitrate
Returns Bitrate
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:92

getCodec

getCodec(): string
Returns string
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:101

getFramerate

getFramerate(): number
Returns number
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:84

getJitter

getJitter(): number
Jitter in milliseconds

Returns number
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:152

getLoss

getLoss(): PacketLoss
Returns PacketLoss
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:68

getResolution

getResolution(): Resolution
Returns Resolution
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:76

getType

getType(): TrackStatsType
Returns TrackStatsType
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:60

resetBitrate

resetBitrate(): void
Returns void
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:105

setBitrate

setBitrate(bitrate: Bitrate): void
Parameters
- bitrate: Bitrate
Returns void
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:88

setCodec

setCodec(codecShortType: string): boolean
Parameters
- codecShortType: string
Returns boolean
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:96

setFramerate

setFramerate(framerate: number): void
Parameters
- framerate: number
Returns void
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:80

setJitter

setJitter(jitter: number): void
Parameters
- jitter: number
Returns void
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:145

setLoss

setLoss(loos: PacketLoss): void
Parameters
- loos: PacketLoss
Returns void
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:64

setResolution

setResolution(resolution: Resolution): void
Parameters
- resolution: Resolution
Returns void
- Defined in src/webrtc/stats/media/mediaTrackStats.ts:72

Generated using TypeDoc