webrtc-stats.idl (11790B)
1 // GENERATED CONTENT - DO NOT EDIT 2 // Content was automatically extracted by Reffy into webref 3 // (https://github.com/w3c/webref) 4 // Source: Identifiers for WebRTC's Statistics API (https://w3c.github.io/webrtc-stats/) 5 6 enum RTCStatsType { 7 "codec", 8 "inbound-rtp", 9 "outbound-rtp", 10 "remote-inbound-rtp", 11 "remote-outbound-rtp", 12 "media-source", 13 "media-playout", 14 "peer-connection", 15 "data-channel", 16 "transport", 17 "candidate-pair", 18 "local-candidate", 19 "remote-candidate", 20 "certificate" 21 }; 22 23 dictionary RTCRtpStreamStats : RTCStats { 24 required unsigned long ssrc; 25 required DOMString kind; 26 DOMString transportId; 27 DOMString codecId; 28 }; 29 30 dictionary RTCCodecStats : RTCStats { 31 required unsigned long payloadType; 32 required DOMString transportId; 33 required DOMString mimeType; 34 unsigned long clockRate; 35 unsigned long channels; 36 DOMString sdpFmtpLine; 37 }; 38 39 dictionary RTCReceivedRtpStreamStats : RTCRtpStreamStats { 40 unsigned long long packetsReceived; 41 unsigned long long packetsReceivedWithEct1; 42 unsigned long long packetsReceivedWithCe; 43 unsigned long long packetsReportedAsLost; 44 unsigned long long packetsReportedAsLostButRecovered; 45 long long packetsLost; 46 double jitter; 47 }; 48 49 dictionary RTCInboundRtpStreamStats : RTCReceivedRtpStreamStats { 50 required DOMString trackIdentifier; 51 DOMString mid; 52 DOMString remoteId; 53 unsigned long framesDecoded; 54 unsigned long keyFramesDecoded; 55 unsigned long framesRendered; 56 unsigned long framesDropped; 57 unsigned long frameWidth; 58 unsigned long frameHeight; 59 double framesPerSecond; 60 unsigned long long qpSum; 61 double totalDecodeTime; 62 double totalInterFrameDelay; 63 double totalSquaredInterFrameDelay; 64 unsigned long pauseCount; 65 double totalPausesDuration; 66 unsigned long freezeCount; 67 double totalFreezesDuration; 68 DOMHighResTimeStamp lastPacketReceivedTimestamp; 69 unsigned long long headerBytesReceived; 70 unsigned long long packetsDiscarded; 71 unsigned long long fecBytesReceived; 72 unsigned long long fecPacketsReceived; 73 unsigned long long fecPacketsDiscarded; 74 unsigned long long bytesReceived; 75 unsigned long nackCount; 76 unsigned long firCount; 77 unsigned long pliCount; 78 double totalProcessingDelay; 79 DOMHighResTimeStamp estimatedPlayoutTimestamp; 80 double jitterBufferDelay; 81 double jitterBufferTargetDelay; 82 unsigned long long jitterBufferEmittedCount; 83 double jitterBufferMinimumDelay; 84 unsigned long long totalSamplesReceived; 85 unsigned long long concealedSamples; 86 unsigned long long silentConcealedSamples; 87 unsigned long long concealmentEvents; 88 unsigned long long insertedSamplesForDeceleration; 89 unsigned long long removedSamplesForAcceleration; 90 double audioLevel; 91 double totalAudioEnergy; 92 double totalSamplesDuration; 93 unsigned long framesReceived; 94 DOMString decoderImplementation; 95 DOMString playoutId; 96 boolean powerEfficientDecoder; 97 unsigned long framesAssembledFromMultiplePackets; 98 double totalAssemblyTime; 99 unsigned long long retransmittedPacketsReceived; 100 unsigned long long retransmittedBytesReceived; 101 unsigned long rtxSsrc; 102 unsigned long fecSsrc; 103 double totalCorruptionProbability; 104 double totalSquaredCorruptionProbability; 105 unsigned long long corruptionMeasurements; 106 }; 107 108 dictionary RTCRemoteInboundRtpStreamStats : RTCReceivedRtpStreamStats { 109 DOMString localId; 110 double roundTripTime; 111 double totalRoundTripTime; 112 double fractionLost; 113 unsigned long long roundTripTimeMeasurements; 114 unsigned long long packetsWithBleachedEct1Marking; 115 }; 116 117 dictionary RTCSentRtpStreamStats : RTCRtpStreamStats { 118 unsigned long long packetsSent; 119 unsigned long long bytesSent; 120 }; 121 122 dictionary RTCOutboundRtpStreamStats : RTCSentRtpStreamStats { 123 DOMString mid; 124 DOMString mediaSourceId; 125 DOMString remoteId; 126 DOMString rid; 127 unsigned long encodingIndex; 128 unsigned long long headerBytesSent; 129 unsigned long long retransmittedPacketsSent; 130 unsigned long long retransmittedBytesSent; 131 unsigned long rtxSsrc; 132 double targetBitrate; 133 unsigned long long totalEncodedBytesTarget; 134 unsigned long frameWidth; 135 unsigned long frameHeight; 136 double framesPerSecond; 137 unsigned long framesSent; 138 unsigned long hugeFramesSent; 139 unsigned long framesEncoded; 140 unsigned long keyFramesEncoded; 141 unsigned long long qpSum; 142 record<DOMString, double> psnrSum; 143 unsigned long long psnrMeasurements; 144 double totalEncodeTime; 145 double totalPacketSendDelay; 146 RTCQualityLimitationReason qualityLimitationReason; 147 record<DOMString, double> qualityLimitationDurations; 148 unsigned long qualityLimitationResolutionChanges; 149 unsigned long nackCount; 150 unsigned long firCount; 151 unsigned long pliCount; 152 DOMString encoderImplementation; 153 boolean powerEfficientEncoder; 154 boolean active; 155 DOMString scalabilityMode; 156 unsigned long long packetsSentWithEct1; 157 }; 158 159 enum RTCQualityLimitationReason { 160 "none", 161 "cpu", 162 "bandwidth", 163 "other", 164 }; 165 166 dictionary RTCRemoteOutboundRtpStreamStats : RTCSentRtpStreamStats { 167 DOMString localId; 168 DOMHighResTimeStamp remoteTimestamp; 169 unsigned long long reportsSent; 170 double roundTripTime; 171 double totalRoundTripTime; 172 unsigned long long roundTripTimeMeasurements; 173 }; 174 175 dictionary RTCMediaSourceStats : RTCStats { 176 required DOMString trackIdentifier; 177 required DOMString kind; 178 }; 179 180 dictionary RTCAudioSourceStats : RTCMediaSourceStats { 181 double audioLevel; 182 double totalAudioEnergy; 183 double totalSamplesDuration; 184 double echoReturnLoss; 185 double echoReturnLossEnhancement; 186 }; 187 188 dictionary RTCVideoSourceStats : RTCMediaSourceStats { 189 unsigned long width; 190 unsigned long height; 191 unsigned long frames; 192 double framesPerSecond; 193 }; 194 195 dictionary RTCAudioPlayoutStats : RTCStats { 196 required DOMString kind; 197 double synthesizedSamplesDuration; 198 unsigned long synthesizedSamplesEvents; 199 double totalSamplesDuration; 200 double totalPlayoutDelay; 201 unsigned long long totalSamplesCount; 202 }; 203 204 dictionary RTCPeerConnectionStats : RTCStats { 205 unsigned long dataChannelsOpened; 206 unsigned long dataChannelsClosed; 207 }; 208 209 dictionary RTCDataChannelStats : RTCStats { 210 DOMString label; 211 DOMString protocol; 212 unsigned short dataChannelIdentifier; 213 required RTCDataChannelState state; 214 unsigned long messagesSent; 215 unsigned long long bytesSent; 216 unsigned long messagesReceived; 217 unsigned long long bytesReceived; 218 }; 219 220 dictionary RTCTransportStats : RTCStats { 221 unsigned long long packetsSent; 222 unsigned long long packetsReceived; 223 unsigned long long bytesSent; 224 unsigned long long bytesReceived; 225 RTCIceRole iceRole; 226 DOMString iceLocalUsernameFragment; 227 required RTCDtlsTransportState dtlsState; 228 RTCIceTransportState iceState; 229 DOMString selectedCandidatePairId; 230 DOMString localCertificateId; 231 DOMString remoteCertificateId; 232 DOMString tlsVersion; 233 DOMString dtlsCipher; 234 RTCDtlsRole dtlsRole; 235 DOMString srtpCipher; 236 unsigned long selectedCandidatePairChanges; 237 unsigned long ccfbMessagesSent; 238 unsigned long ccfbMessagesReceived; 239 }; 240 241 enum RTCDtlsRole { 242 "client", 243 "server", 244 "unknown", 245 }; 246 247 dictionary RTCIceCandidateStats : RTCStats { 248 required DOMString transportId; 249 DOMString? address; 250 long port; 251 DOMString protocol; 252 required RTCIceCandidateType candidateType; 253 long priority; 254 DOMString url; 255 RTCIceServerTransportProtocol relayProtocol; 256 DOMString foundation; 257 DOMString relatedAddress; 258 long relatedPort; 259 DOMString usernameFragment; 260 RTCIceTcpCandidateType tcpType; 261 }; 262 263 dictionary RTCIceCandidatePairStats : RTCStats { 264 required DOMString transportId; 265 required DOMString localCandidateId; 266 required DOMString remoteCandidateId; 267 required RTCStatsIceCandidatePairState state; 268 boolean nominated; 269 unsigned long long packetsSent; 270 unsigned long long packetsReceived; 271 unsigned long long bytesSent; 272 unsigned long long bytesReceived; 273 DOMHighResTimeStamp lastPacketSentTimestamp; 274 DOMHighResTimeStamp lastPacketReceivedTimestamp; 275 double totalRoundTripTime; 276 double currentRoundTripTime; 277 double availableOutgoingBitrate; 278 double availableIncomingBitrate; 279 unsigned long long requestsReceived; 280 unsigned long long requestsSent; 281 unsigned long long responsesReceived; 282 unsigned long long responsesSent; 283 unsigned long long consentRequestsSent; 284 unsigned long packetsDiscardedOnSend; 285 unsigned long long bytesDiscardedOnSend; 286 }; 287 288 enum RTCStatsIceCandidatePairState { 289 "frozen", 290 "waiting", 291 "in-progress", 292 "failed", 293 "succeeded" 294 }; 295 296 dictionary RTCCertificateStats : RTCStats { 297 required DOMString fingerprint; 298 required DOMString fingerprintAlgorithm; 299 required DOMString base64Certificate; 300 DOMString issuerCertificateId; 301 };