New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@observertc/sample-schemas-js
Advanced tools
@observertc/sample-schemas-js - npm Package Compare versions
Comparing version 2.2.1-767ac02.0 to 2.2.1-ed2c0af.0
| { | ||
| "name": "@observertc/sample-schemas-js", | ||
| "version": "2.2.1-767ac02.0", | ||
| "version": "2.2.1-ed2c0af.0", | ||
| "description": "ObserveRTC Generated Library for Sample Schemas", | ||
| "main": "lib/index.js", | ||
| "types": "lib/index.d.ts", | ||
| "main": "dist/index.js", | ||
| "types": "dist/index.d.ts", | ||
| "engines": { | ||
@@ -8,0 +8,0 @@ "node": ">=10" |
220
README.md
@@ -69,4 +69,4 @@ ObserveRTC Schemas | ||
| --- | --- | ||
| name | The name of the operation system (e.g.: linux) the webrtc app uses | ||
| version | The version of the operation system | ||
| name | The name of the operating system (e.g., Linux) the WebRTC app uses | ||
| version | The version of the operating system | ||
@@ -78,5 +78,5 @@ ## OperationSystem | ||
| --- | --- | ||
| name | The name of the operation system (e.g.: linux) the webrtc app uses | ||
| version | The version of the operation system | ||
| versionName | The name of the version of the operation system | ||
| name | The name of the operating system (e.g., Linux) the WebRTC app uses | ||
| version | The version of the operating system | ||
| versionName | The name of the version of the operating system | ||
@@ -134,5 +134,5 @@ ## MediaDevice | ||
| state | The state of the data channel | ||
| messageSent | The total number of message sent on the data channel | ||
| messageSent | The total number of messages sent on the data channel | ||
| bytesSent | The total number of bytes sent on the data channel | ||
| messageReceived | The total number of message received on the data channel | ||
| messageReceived | The total number of messages received on the data channel | ||
| bytesReceived | The total number of bytes received on the data channel | ||
@@ -145,21 +145,21 @@ | ||
| --- | --- | ||
| transportId (**Mandatory**) | The identifier of the transport the ice candidate pair is negotiated on | ||
| transportId (**Mandatory**) | The identifier of the transport the ICE candidate pair is negotiated on | ||
| peerConnectionId (**Mandatory**) | The unique identifier of the peer connection | ||
| label | The label associated with the peer connection | ||
| packetsSent | Represents the total number of packets sent on the corresponded transport | ||
| packetsReceived | Represents the total number of packets received on the corresponded transport | ||
| bytesSent | Represents the total amount of bytes sent on the corresponded transport | ||
| bytesReceived | Represents the total amount of bytes received on the corresponded transport | ||
| iceRole | Represent the current role of ICE under DTLS Transport | ||
| iceLocalUsernameFragment | Represent the current local username fragment used in message validation procedures for ICE under DTLS Transport | ||
| packetsSent | Represents the total number of packets sent on the corresponding transport | ||
| packetsReceived | Represents the total number of packets received on the corresponding transport | ||
| bytesSent | Represents the total amount of bytes sent on the corresponding transport | ||
| bytesReceived | Represents the total amount of bytes received on the corresponding transport | ||
| iceRole | Represents the current role of ICE under DTLS Transport | ||
| iceLocalUsernameFragment | Represents the current local username fragment used in message validation procedures for ICE under DTLS Transport | ||
| dtlsState | Represents the current state of DTLS for the peer connection transport layer | ||
| selectedCandidatePairId | The identifier of the candidate pair the transport currently uses | ||
| iceState | Represents the current transport state (RTCIceTransportState) of ICE for the peer connection transport layer | ||
| localCertificateId | If DTLS negotiated it gives the id of the local certificate | ||
| remoteCertificateId | If DTLS negotiated it gives the id of the remote certificate | ||
| tlsVersion | Represents the version number of the TLS used in the corresponded transport | ||
| dtlsCipher | Represents the name of the DTLS cipher used in the corresponded transport | ||
| localCertificateId | If DTLS negotiated, it gives the ID of the local certificate | ||
| remoteCertificateId | If DTLS negotiated, it gives the ID of the remote certificate | ||
| tlsVersion | Represents the version number of the TLS used in the corresponding transport | ||
| dtlsCipher | Represents the name of the DTLS cipher used in the corresponding transport | ||
| dtlsRole | The role this host plays in DTLS negotiations (Possible values are: client,<br />server,<br />unknown) | ||
| srtpCipher | Represents the name of the SRTP cipher used in the corresponded transport | ||
| tlsGroup | Represents the name of the IANA TLS Supported Groups used in the corresponded transport | ||
| srtpCipher | Represents the name of the SRTP cipher used in the corresponding transport | ||
| tlsGroup | Represents the name of the IANA TLS Supported Groups used in the corresponding transport | ||
| selectedCandidatePairChanges | The total number of candidate pair changes over the peer connection | ||
@@ -174,25 +174,25 @@ | ||
| peerConnectionId (**Mandatory**) | The unique identifier of the peer connection | ||
| label | The label associated to the peer connection | ||
| label | The label associated with the peer connection | ||
| transportId | The identifier of the transport the ice candidate pair is negotiated on | ||
| localCandidateId | The unique identifier of the candidate the negotiated pair is selected at local side | ||
| remoteCandidateId | The unique identifier of the candidate the negotiated pair is selected at remote side | ||
| state | The state of ICE Candidate Pairs (RTCStatsIceState) on the corresponded transport | ||
| nominated | indicate if the ice candidate pair is nominated or not | ||
| packetsSent | The total number of packets sent using the last selected candidate pair over the corresponded transport | ||
| packetsReceived | The total number of packets received using the last selected candidate pair over the corresponded transport | ||
| bytesSent | The total number of bytes sent using the last selected candidate pair over the corresponded transport | ||
| bytesReceived | The total number of bytes received using the last selected candidate pair over the corresponded transport | ||
| lastPacketSentTimestamp | Represents the timestamp at which the last packet was sent on the selected candidate pair, excluding STUN packets over the corresponded transport (UTC Epoch in ms) | ||
| lastPacketReceivedTimestamp | Represents the timestamp at which the last packet was received on the selected candidate pair, excluding STUN packets over the corresponded transport (UTC Epoch in ms) | ||
| totalRoundTripTime | Represents the sum of all round trip time measurements in seconds since the beginning of the session, based on STUN connectivity check over the corresponded transport | ||
| currentRoundTripTime | Represents the last round trip time measurements in seconds based on STUN connectivity check over the corresponded transport | ||
| availableOutgoingBitrate | The sum of the underlying cc algorithm provided outgoing bitrate for the RTP streams over the corresponded transport | ||
| availableIncomingBitrate | The sum of the underlying cc algorithm provided incoming bitrate for the RTP streams over the corresponded transport | ||
| requestsReceived | Represents the total number of connectivity check requests received on the selected candidate pair using the corresponded transport | ||
| requestsSent | Represents the total number of connectivity check requests sent on the selected candidate pair using the corresponded transport | ||
| responsesReceived | Represents the total number of connectivity check responses received on the selected candidate pair using the corresponded transport | ||
| responsesSent | Represents the total number of connectivity check responses sent on the selected candidate pair using the corresponded transport | ||
| consentRequestsSent | Represents the total number of consent requests sent on the selected candidate pair using the corresponded transport | ||
| packetsDiscardedOnSend | Total amount of packets for this candidate pair that have been discarded due to socket errors on the selected candidate pair using the corresponded transport | ||
| bytesDiscardedOnSend | Total amount of bytes for this candidate pair that have been discarded due to socket errors on the selected candidate pair using the corresponded transport | ||
| localCandidateId | The unique identifier of the candidate the negotiated pair is selected on the local side | ||
| remoteCandidateId | The unique identifier of the candidate the negotiated pair is selected on the remote side | ||
| state | The state of ICE Candidate Pairs (RTCStatsIceState) on the corresponding transport | ||
| nominated | Indicates if the ice candidate pair is nominated or not | ||
| packetsSent | The total number of packets sent using the last selected candidate pair over the corresponding transport | ||
| packetsReceived | The total number of packets received using the last selected candidate pair over the corresponding transport | ||
| bytesSent | The total number of bytes sent using the last selected candidate pair over the corresponding transport | ||
| bytesReceived | The total number of bytes received using the last selected candidate pair over the corresponding transport | ||
| lastPacketSentTimestamp | Represents the timestamp at which the last packet was sent on the selected candidate pair, excluding STUN packets over the corresponding transport (UTC Epoch in ms) | ||
| lastPacketReceivedTimestamp | Represents the timestamp at which the last packet was received on the selected candidate pair, excluding STUN packets over the corresponding transport (UTC Epoch in ms) | ||
| totalRoundTripTime | Represents the sum of all round trip time measurements in seconds since the beginning of the session, based on STUN connectivity check over the corresponding transport | ||
| currentRoundTripTime | Represents the last round trip time measurement in seconds based on STUN connectivity check over the corresponding transport | ||
| availableOutgoingBitrate | The sum of the underlying cc algorithm provided outgoing bitrate for the RTP streams over the corresponding transport | ||
| availableIncomingBitrate | The sum of the underlying cc algorithm provided incoming bitrate for the RTP streams over the corresponding transport | ||
| requestsReceived | Represents the total number of connectivity check requests received on the selected candidate pair using the corresponding transport | ||
| requestsSent | Represents the total number of connectivity check requests sent on the selected candidate pair using the corresponding transport | ||
| responsesReceived | Represents the total number of connectivity check responses received on the selected candidate pair using the corresponding transport | ||
| responsesSent | Represents the total number of connectivity check responses sent on the selected candidate pair using the corresponding transport | ||
| consentRequestsSent | Represents the total number of consent requests sent on the selected candidate pair using the corresponding transport | ||
| packetsDiscardedOnSend | Total number of packets for this candidate pair that have been discarded due to socket errors on the selected candidate pair using the corresponding transport | ||
| bytesDiscardedOnSend | Total number of bytes for this candidate pair that have been discarded due to socket errors on the selected candidate pair using the corresponding transport | ||
@@ -204,4 +204,4 @@ ## MediaSourceStat | ||
| --- | --- | ||
| trackIdentifier | The unique identifier of the corresponded media track | ||
| kind | The type of the media the Mediasource produces. (Possible values are: audio,<br />video) | ||
| trackIdentifier | The unique identifier of the corresponding media track | ||
| kind | The type of the media the MediaSource produces. (Possible values are: audio,<br />video) | ||
| relayedSource | Flag indicating if the media source is relayed or not, meaning the local endpoint is not the actual source of the media, but a proxy for that media. | ||
@@ -213,3 +213,3 @@ audioLevel | The value is between 0..1 (linear), where 1.0 represents 0 dBov, 0 represents silence, and 0.5 represents approximately 6 dBSPL change in the sound pressure level from 0 dBov. | ||
| echoReturnLossEnhancement | www.itu.int/rec/T-REC-G.168-201504-I/en | ||
| droppedSamplesDuration | . The total duration, in seconds, of samples produced by the device that got dropped before reaching the media source | ||
| droppedSamplesDuration | The total duration, in seconds, of samples produced by the device that got dropped before reaching the media source | ||
| droppedSamplesEvents | A counter increases every time a sample is dropped after a non-dropped sample | ||
@@ -220,4 +220,4 @@ totalCaptureDelay | Total delay, in seconds, for each audio sample between the time the sample was emitted by the capture device and the sample reaching the source | ||
| height | The height, in pixels, of the last frame originating from the media source | ||
| frames | The total number of frames originated from the media source | ||
| framesPerSecond | The number of frames origianted from the media source in the last second | ||
| frames | The total number of frames originating from the media source | ||
| framesPerSecond | The number of frames originating from the media source in the last second | ||
@@ -229,7 +229,7 @@ ## MediaCodecStats | ||
| --- | --- | ||
| payloadType | Payload type used in RTP encoding / decoding process. | ||
| payloadType | Payload type used in the RTP encoding/decoding process. | ||
| codecType | Indicates the role of the codec (encode or decode) (Possible values are: encode,<br />decode) | ||
| mimeType | The MIME type of the media. eg.: audio/opus. | ||
| clockRate | the clock rate used in RTP transport to generate the timestamp for the carried frames | ||
| channels | Audio Only. Represnts the number of chanels an audio media source have. Only interesting if stereo is presented | ||
| mimeType | The MIME type of the media, e.g., audio/opus. | ||
| clockRate | The clock rate used in RTP transport to generate the timestamp for the carried frames | ||
| channels | Audio Only. Represents the number of channels an audio media source has. Only interesting if stereo is presented | ||
| sdpFmtpLine | The SDP line determines the codec | ||
@@ -242,6 +242,6 @@ | ||
| --- | --- | ||
| fingerprint | The fingerprint of the certificate. | ||
| fingerprint | The fingerprint of the certificate. | ||
| fingerprintAlgorithm | The hash function used to generate the fingerprint. | ||
| base64Certificate | The DER encoded base-64 representation of the certificate. | ||
| issuerCertificateId | The id of the next certificate in the certificate chain | ||
| issuerCertificateId | The ID of the next certificate in the certificate chain | ||
@@ -254,22 +254,22 @@ ## InboundAudioTrack | ||
| ssrc (**Mandatory**) | The RTP SSRC field | ||
| trackId | The id of the track | ||
| peerConnectionId | The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| remoteClientId | The remote clientId the source outbound track belongs to | ||
| sfuStreamId | The id of the SFU stream this track is sinked from | ||
| sfuSinkId | The id of the sink this track belongs to in the SFU | ||
| packetsReceived | The total number of packets received on the corresponded synchronization source | ||
| packetsLost | The total number of bytes received on the corresponded synchronization source | ||
| jitter | The corresponded synchronization source reported jitter | ||
| lastPacketReceivedTimestamp | Represents the timestamp at which the last packet was received on the corresponded synchronization source (ssrc) | ||
| trackId | The ID of the track | ||
| peerConnectionId | The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| remoteClientId | The remote client ID the source outbound track belongs to | ||
| sfuStreamId | The ID of the SFU stream this track is synced from | ||
| sfuSinkId | The ID of the sink this track belongs to in the SFU | ||
| packetsReceived | The total number of packets received on the corresponding synchronization source | ||
| packetsLost | The total number of bytes received on the corresponding synchronization source | ||
| jitter | The corresponding synchronization source reported jitter | ||
| lastPacketReceivedTimestamp | Represents the timestamp at which the last packet was received on the corresponding synchronization source (ssrc) | ||
| headerBytesReceived | Total number of RTP header and padding bytes received over the corresponding synchronization source (ssrc) | ||
| packetsDiscarded | The total number of packets missed the playout point and therefore discarded by the jitterbuffer | ||
| packetsDiscarded | The total number of packets that missed the playout point and were therefore discarded by the jitter buffer | ||
| fecPacketsReceived | Total number of FEC packets received over the corresponding synchronization source (ssrc) | ||
| fecPacketsDiscarded | Total number of FEC packets discarded over the corresponding synchronization source (ssrc) due to 1) late arrive; 2) the target RTP packet has already been repaired. | ||
| bytesReceived | Total number of bytes received over the corresponding synchronization source (ssrc) due to 1) late arrive; 2) the target RTP packet has already been repaired. | ||
| nackCount | Count the total number of Negative ACKnowledgement (NACK) packets sent and belongs to the corresponded synchronization source (ssrc) | ||
| totalProcessingDelay | The total processing delay in seconds spend on buffering RTP packets from received up until packets are decoded | ||
| estimatedPlayoutTimestamp | The estimated playout time of the corresponded synchronization source | ||
| jitterBufferDelay | The total time of RTP packets spent in jitterbuffer waiting for frame completion due to network uncertenity. | ||
| jitterBufferTargetDelay | This value is increased by the target jitter buffer delay every time a sample is emitted by the jitter buffer. The added target is the target delay, in seconds, at the time that the sample was emitted from the jitter buffer. | ||
| jitterBufferEmittedCount | The total number of audio samples or video frames that have come out of the jitter buffer on the corresponded synchronization source (ssrc) | ||
| fecPacketsDiscarded | Total number of FEC packets discarded over the corresponding synchronization source (ssrc) due to 1) late arrival; 2) the target RTP packet has already been repaired. | ||
| bytesReceived | Total number of bytes received over the corresponding synchronization source (ssrc) due to 1) late arrival; 2) the target RTP packet has already been repaired. | ||
| nackCount | Count the total number of Negative ACKnowledgement (NACK) packets sent and belongs to the corresponding synchronization source (ssrc) | ||
| totalProcessingDelay | The total processing delay in seconds spent on buffering RTP packets from receipt until packets are decoded | ||
| estimatedPlayoutTimestamp | The estimated playout time of the corresponding synchronization source | ||
| jitterBufferDelay | The total time of RTP packets spent in the jitter buffer waiting for frame completion due to network uncertainty. | ||
| jitterBufferTargetDelay | This value is increased by the target jitter buffer delay every time a sample is emitted by the jitter buffer. The added target is the target delay, in seconds, at the time that the sample was emitted from the jitter buffer. | ||
| jitterBufferEmittedCount | The total number of audio samples or video frames that have come out of the jitter buffer on the corresponding synchronization source (ssrc) | ||
| jitterBufferMinimumDelay | This metric is purely based on the network characteristics such as jitter and packet loss, and can be seen as the minimum obtainable jitter buffer delay if no external factors would affect it | ||
@@ -305,3 +305,3 @@ totalSamplesReceived | The total number of audio samples received on the corresponded RTP stream | ||
| trackId | The id of the track | ||
| peerConnectionId | The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| peerConnectionId | The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| remoteClientId | The remote clientId the source outbound track belongs to | ||
@@ -329,19 +329,19 @@ sfuStreamId | The id of the SFU stream this track is sinked from | ||
| framesDecoded | The total number of frames decoded on the corresponded RTP stream | ||
| keyFramesDecoded | The total number of keyframes decoded on the corresponded RTP stream | ||
| frameWidth | The width of the frame of the video sent by the remote source on the corresponded RTP stream | ||
| frameHeight | The height of the frame of the video sent by the remote source on the corresponded RTP stream | ||
| framesPerSecond | The frame per seconds of the video sent by the remote source on the corresponded RTP stream | ||
| qpSum | The QP sum (only interested in VP8,9) of the frame of the video sent by the remote source on the corresponded RTP stream | ||
| totalDecodeTime | The total tiem spent on decoding video on the corresponded RTP stream | ||
| totalInterFrameDelay | The total interframe delay | ||
| totalSquaredInterFrameDelay | The total number of inter frame delay squere on the corresponded synchronization source (ssrc) Useful for variance calculation for interframe delays | ||
| firCount | The total number FIR packets sent from this endpoint to the source on the corresponded RTP stream | ||
| pliCount | The total number of Picture Loss Indication sent on the corresponded RTP stream | ||
| framesReceived | The total number of frames received on the corresponded RTP stream. | ||
| keyFramesDecoded | The total number of keyframes decoded on the corresponding RTP stream | ||
| frameWidth | The width of the frame of the video sent by the remote source on the corresponding RTP stream | ||
| frameHeight | The height of the frame of the video sent by the remote source on the corresponding RTP stream | ||
| framesPerSecond | The frame rate of the video sent by the remote source on the corresponding RTP stream | ||
| qpSum | The QP sum (only interested in VP8,9) of the frame of the video sent by the remote source on the corresponding RTP stream | ||
| totalDecodeTime | The total time spent on decoding video on the corresponding RTP stream | ||
| totalInterFrameDelay | The total interframe delay on the corresponding RTP stream | ||
| totalSquaredInterFrameDelay | The total squared interframe delay on the corresponding synchronization source (ssrc). Useful for variance calculation for interframe delays | ||
| firCount | The total number of Full Intra Request (FIR) packets sent from this endpoint to the source on the corresponding RTP stream | ||
| pliCount | The total number of Picture Loss Indication (PLI) packets sent on the corresponding RTP stream | ||
| framesReceived | The total number of frames received on the corresponding RTP stream | ||
| packetsSent | Total number of RTP packets sent at the remote endpoint to this endpoint on this synchronization source | ||
| bytesSent | Total number of payload bytes sent at the remote endpoint to this endpoint on this synchronization source | ||
| remoteTimestamp | The timestamp corresnponds to the time in UTC Epoch the remote endpoint reported the statistics belong to the sender side and correspond to the synchronization source (ssrc) | ||
| remoteTimestamp | The timestamp corresponds to the time in UTC Epoch the remote endpoint reported the statistics belong to the sender side and correspond to the synchronization source (ssrc) | ||
| reportsSent | The number of SR reports the remote endpoint sent corresponded to synchronization source (ssrc) this report belongs to | ||
| roundTripTime | Estimated round trip time for the SR reports based on DLRR reports on the corresponded RTP stream | ||
| totalRoundTripTime | Represents the cumulative sum of all round trip time measurements performed on the corresponded RTP stream | ||
| totalRoundTripTime | Represents the cumulative sum of all round trip time measurements performed on the corresponded RTP stream | ||
| roundTripTimeMeasurements | Represents the total number of SR reports received with DLRR reports to be able to calculate the round trip time on the corresponded RTP stream | ||
@@ -360,3 +360,3 @@ | ||
| bytesSent | The total number of bytes sent on the corresponded synchronization source | ||
| rid | The rid encoding parameter of the corresponded synchronization source | ||
| rid | The rid encoding parameter of the corresponded synchronization source | ||
| headerBytesSent | Total number of RTP header and padding bytes sent over the corresponding synchronization source (ssrc) | ||
@@ -384,4 +384,4 @@ retransmittedPacketsSent | Total number of retransmitted packets sent over the corresponding synchronization source (ssrc). | ||
| echoReturnLoss | Represents the echo cancellation in decibels corresponded to the media source. | ||
| echoReturnLossEnhancement | Represents the echo cancellation in decibels added as a postprocessing by the library after the audio is catched from the emdia source. | ||
| droppedSamplesDuration | . The total duration, in seconds, of samples produced by the device that got dropped before reaching the media source | ||
| echoReturnLossEnhancement | Represents the echo cancellation in decibels added as a postprocessing by the library after the audio is caught from the media source. | ||
| droppedSamplesDuration | The total duration, in seconds, of samples produced by the device that got dropped before reaching the media source | ||
| droppedSamplesEvents | A counter increases every time a sample is dropped after a non-dropped sample | ||
@@ -398,7 +398,7 @@ totalCaptureDelay | Total delay, in seconds, for each audio sample between the time the sample was emitted by the capture device and the sample reaching the source | ||
| trackId | The id of the track | ||
| peerConnectionId | The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| peerConnectionId | The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| sfuStreamId | The id of the SFU stream this track is related to | ||
| packetsSent | The total number of packets sent on the corresponded synchronization source | ||
| bytesSent | The total number of bytes sent on the corresponded synchronization source | ||
| rid | The rid encoding parameter of the corresponded synchronization source | ||
| rid | The rid encoding parameter of the corresponded synchronization source | ||
| headerBytesSent | Total number of RTP header and padding bytes sent over the corresponding synchronization source (ssrc) | ||
@@ -415,10 +415,10 @@ retransmittedPacketsSent | Total number of retransmitted packets sent over the corresponding synchronization source (ssrc). | ||
| frameWidth | The frame width in pixels of the frames targeted by the media encoder | ||
| frameHeight | The frame width the media encoder targeted | ||
| framesPerSecond | The encoded number of frames in the last second on the corresponded media source | ||
| framesSent | TThe total number of frames sent on the corresponded RTP stream | ||
| hugeFramesSent | The total number of huge frames (avgFrameSize * 2.5) on the corresponded RTP stream | ||
| frameHeight | The frame height in pixels of the frames targeted by the media encoder | ||
| framesPerSecond | The encoded number of frames in the last second on the corresponding media source | ||
| framesSent | The total number of frames sent on the corresponding RTP stream | ||
| hugeFramesSent | The total number of huge frames (avgFrameSize * 2.5) on the corresponding RTP stream | ||
| framesEncoded | The total number of frames encoded by the media source | ||
| keyFramesEncoded | The total number of keyframes encoded on the corresponded RTP stream | ||
| qpSum | The sum of the QP the media encoder provided on the corresponded RTP stream. | ||
| totalEncodeTime | The total time in seconds spent in encoding media frames for the corresponded RTP stream. | ||
| keyFramesEncoded | The total number of keyframes encoded on the corresponding RTP stream | ||
| qpSum | The sum of the QP the media encoder provided on the corresponding RTP stream. | ||
| totalEncodeTime | The total time in seconds spent in encoding media frames for the corresponding RTP stream. | ||
| qualityLimitationDurationNone | Time elapsed in seconds when the RTC connection has not limited the quality | ||
@@ -429,3 +429,3 @@ qualityLimitationDurationCPU | Time elapsed in seconds the RTC connection had a limitation because of CPU | ||
| qualityLimitationReason | Indicate a reason for the quality limitation of the corresponded synchronization source | ||
| qualityLimitationResolutionChanges | The total number of resolution changes occured ont he corresponded RTP stream due to quality changes | ||
| qualityLimitationResolutionChanges | The total number of resolution changes occurred on the corresponded RTP stream due to quality changes | ||
| firCount | The total number FIR packets sent from this endpoint to the source on the corresponded RTP stream | ||
@@ -440,3 +440,3 @@ pliCount | The total number of Picture Loss Indication sent on the corresponded RTP stream | ||
| roundTripTimeMeasurements | The total number of calculated RR measurements received on this source | ||
| framesDropped | The total number of frames reported to be lost by the remote endpoit on the corresponded RTP stream | ||
| framesDropped | The total number of frames reported to be lost by the remote endpoint on the corresponded RTP stream | ||
| relayedSource | True if the corresponded media source is remote, false otherwise (or null depending on browser and version) | ||
@@ -483,21 +483,21 @@ width | The width, in pixels, of the last frame originating from the media source | ||
| --- | --- | ||
| clientId (**Mandatory**) | Unique id of the client providing samples. Must be a valid UUID | ||
| clientId (**Mandatory**) | Unique id of the client providing samples. Must be a valid UUID. | ||
| timestamp (**Mandatory**) | The timestamp the sample is created in GMT | ||
| callId | If it is provided the server uses the given id to match clients in the same call. Must be a valid UUID. | ||
| sampleSeq | The sequence number a source assigns to the sample. Every time the source make a sample at a client this number should be monothonically incremented. | ||
| callId | If provided, the server uses the given id to match clients in the same call. Must be a valid UUID. | ||
| sampleSeq | The sequence number a source assigns to the sample. Each time the source takes a sample at a client, this number should be monotonically incremented. | ||
| roomId | The WebRTC app configured room id the client joined for the call. | ||
| userId | The WebRTC app configured human readable user id the client is joined. | ||
| userId | The WebRTC app configured human-readable user id the client is joined. | ||
| engine | WebRTC App provided information related to the engine the client uses. | ||
| platform | WebRTC App provided information related to the platform the client uses. | ||
| browser | WebRTC App provided information related to the browser the client uses. | ||
| os | WebRTC App provided information related to the operation system the client uses. | ||
| mediaConstraints | The WebRTC app provided List of the media constraints the client has. | ||
| mediaDevices | The WebRTC app provided List of the media devices the client has. | ||
| userMediaErrors | The WebRTC app provided List of user media errors the client has. | ||
| os | WebRTC App provided information related to the operating system the client uses. | ||
| mediaConstraints | The WebRTC app provided list of the media constraints the client has. | ||
| mediaDevices | The WebRTC app provided list of the media devices the client has. | ||
| userMediaErrors | The WebRTC app provided list of user media errors the client has. | ||
| extensionStats | The WebRTC app provided custom stats payload | ||
| customCallEvents | User provided custom call events | ||
| customObserverEvents | User provided custom call events | ||
| iceServers | The WebRTC app provided List of ICE server the client used. | ||
| customObserverEvents | User provided custom observer events | ||
| iceServers | The WebRTC app provided list of ICE servers the client used. | ||
| localSDPs | The local part of the Signal Description Protocol to establish connections | ||
| dataChannels | Measurements about the data channels currently avaialble on peer connections | ||
| dataChannels | Measurements about the data channels currently available on peer connections | ||
| pcTransports | Transport stats of Peer Connection | ||
@@ -504,0 +504,0 @@ iceCandidatePairs | Candidate pair stats |
@@ -0,1 +1,4 @@ | ||
| export const schemaVersion = "2.2.0"; | ||
| /** | ||
@@ -1058,3 +1061,3 @@ * Session data | ||
| /** | ||
| * The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| * The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| */ | ||
@@ -1079,3 +1082,3 @@ peerConnectionId?: string; | ||
| /** | ||
| * The rid encoding parameter of the corresponded synchronization source | ||
| * The rid encoding parameter of the corresponded synchronization source | ||
| */ | ||
@@ -1140,3 +1143,3 @@ rid?: string; | ||
| /** | ||
| * The frame width the media encoder targeted | ||
| * The frame height in pixels of the frames targeted by the media encoder | ||
| */ | ||
@@ -1146,3 +1149,3 @@ frameHeight?: number; | ||
| /** | ||
| * The encoded number of frames in the last second on the corresponded media source | ||
| * The encoded number of frames in the last second on the corresponding media source | ||
| */ | ||
@@ -1152,3 +1155,3 @@ framesPerSecond?: number; | ||
| /** | ||
| * TThe total number of frames sent on the corresponded RTP stream | ||
| * The total number of frames sent on the corresponding RTP stream | ||
| */ | ||
@@ -1158,3 +1161,3 @@ framesSent?: number; | ||
| /** | ||
| * The total number of huge frames (avgFrameSize * 2.5) on the corresponded RTP stream | ||
| * The total number of huge frames (avgFrameSize * 2.5) on the corresponding RTP stream | ||
| */ | ||
@@ -1169,3 +1172,3 @@ hugeFramesSent?: number; | ||
| /** | ||
| * The total number of keyframes encoded on the corresponded RTP stream | ||
| * The total number of keyframes encoded on the corresponding RTP stream | ||
| */ | ||
@@ -1175,3 +1178,3 @@ keyFramesEncoded?: number; | ||
| /** | ||
| * The sum of the QP the media encoder provided on the corresponded RTP stream. | ||
| * The sum of the QP the media encoder provided on the corresponding RTP stream. | ||
| */ | ||
@@ -1181,3 +1184,3 @@ qpSum?: number; | ||
| /** | ||
| * The total time in seconds spent in encoding media frames for the corresponded RTP stream. | ||
| * The total time in seconds spent in encoding media frames for the corresponding RTP stream. | ||
| */ | ||
@@ -1212,3 +1215,3 @@ totalEncodeTime?: number; | ||
| /** | ||
| * The total number of resolution changes occured ont he corresponded RTP stream due to quality changes | ||
| * The total number of resolution changes occurred on the corresponded RTP stream due to quality changes | ||
| */ | ||
@@ -1263,3 +1266,3 @@ qualityLimitationResolutionChanges?: number; | ||
| /** | ||
| * The total number of frames reported to be lost by the remote endpoit on the corresponded RTP stream | ||
| * The total number of frames reported to be lost by the remote endpoint on the corresponded RTP stream | ||
| */ | ||
@@ -1325,3 +1328,3 @@ framesDropped?: number; | ||
| /** | ||
| * The rid encoding parameter of the corresponded synchronization source | ||
| * The rid encoding parameter of the corresponded synchronization source | ||
| */ | ||
@@ -1441,3 +1444,3 @@ rid?: string; | ||
| /** | ||
| * Represents the echo cancellation in decibels added as a postprocessing by the library after the audio is catched from the emdia source. | ||
| * Represents the echo cancellation in decibels added as a postprocessing by the library after the audio is caught from the media source. | ||
| */ | ||
@@ -1447,3 +1450,3 @@ echoReturnLossEnhancement?: number; | ||
| /** | ||
| * . The total duration, in seconds, of samples produced by the device that got dropped before reaching the media source | ||
| * The total duration, in seconds, of samples produced by the device that got dropped before reaching the media source | ||
| */ | ||
@@ -1484,3 +1487,3 @@ droppedSamplesDuration?: number; | ||
| /** | ||
| * The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| * The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| */ | ||
@@ -1600,3 +1603,3 @@ peerConnectionId?: string; | ||
| /** | ||
| * The total number of keyframes decoded on the corresponded RTP stream | ||
| * The total number of keyframes decoded on the corresponding RTP stream | ||
| */ | ||
@@ -1606,3 +1609,3 @@ keyFramesDecoded?: number; | ||
| /** | ||
| * The width of the frame of the video sent by the remote source on the corresponded RTP stream | ||
| * The width of the frame of the video sent by the remote source on the corresponding RTP stream | ||
| */ | ||
@@ -1612,3 +1615,3 @@ frameWidth?: number; | ||
| /** | ||
| * The height of the frame of the video sent by the remote source on the corresponded RTP stream | ||
| * The height of the frame of the video sent by the remote source on the corresponding RTP stream | ||
| */ | ||
@@ -1618,3 +1621,3 @@ frameHeight?: number; | ||
| /** | ||
| * The frame per seconds of the video sent by the remote source on the corresponded RTP stream | ||
| * The frame rate of the video sent by the remote source on the corresponding RTP stream | ||
| */ | ||
@@ -1624,3 +1627,3 @@ framesPerSecond?: number; | ||
| /** | ||
| * The QP sum (only interested in VP8,9) of the frame of the video sent by the remote source on the corresponded RTP stream | ||
| * The QP sum (only interested in VP8,9) of the frame of the video sent by the remote source on the corresponding RTP stream | ||
| */ | ||
@@ -1630,3 +1633,3 @@ qpSum?: number; | ||
| /** | ||
| * The total tiem spent on decoding video on the corresponded RTP stream | ||
| * The total time spent on decoding video on the corresponding RTP stream | ||
| */ | ||
@@ -1636,3 +1639,3 @@ totalDecodeTime?: number; | ||
| /** | ||
| * The total interframe delay | ||
| * The total interframe delay on the corresponding RTP stream | ||
| */ | ||
@@ -1642,3 +1645,3 @@ totalInterFrameDelay?: number; | ||
| /** | ||
| * The total number of inter frame delay squere on the corresponded synchronization source (ssrc) Useful for variance calculation for interframe delays | ||
| * The total squared interframe delay on the corresponding synchronization source (ssrc). Useful for variance calculation for interframe delays | ||
| */ | ||
@@ -1648,3 +1651,3 @@ totalSquaredInterFrameDelay?: number; | ||
| /** | ||
| * The total number FIR packets sent from this endpoint to the source on the corresponded RTP stream | ||
| * The total number of Full Intra Request (FIR) packets sent from this endpoint to the source on the corresponding RTP stream | ||
| */ | ||
@@ -1654,3 +1657,3 @@ firCount?: number; | ||
| /** | ||
| * The total number of Picture Loss Indication sent on the corresponded RTP stream | ||
| * The total number of Picture Loss Indication (PLI) packets sent on the corresponding RTP stream | ||
| */ | ||
@@ -1660,3 +1663,3 @@ pliCount?: number; | ||
| /** | ||
| * The total number of frames received on the corresponded RTP stream. | ||
| * The total number of frames received on the corresponding RTP stream | ||
| */ | ||
@@ -1676,3 +1679,3 @@ framesReceived?: number; | ||
| /** | ||
| * The timestamp corresnponds to the time in UTC Epoch the remote endpoint reported the statistics belong to the sender side and correspond to the synchronization source (ssrc) | ||
| * The timestamp corresponds to the time in UTC Epoch the remote endpoint reported the statistics belong to the sender side and correspond to the synchronization source (ssrc) | ||
| */ | ||
@@ -1692,3 +1695,3 @@ remoteTimestamp?: number; | ||
| /** | ||
| * Represents the cumulative sum of all round trip time measurements performed on the corresponded RTP stream | ||
| * Represents the cumulative sum of all round trip time measurements performed on the corresponded RTP stream | ||
| */ | ||
@@ -1714,3 +1717,3 @@ totalRoundTripTime?: number; | ||
| /** | ||
| * The id of the track | ||
| * The ID of the track | ||
| */ | ||
@@ -1720,3 +1723,3 @@ trackId?: string; | ||
| /** | ||
| * The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| * The unique generated identifier of the peer connection the inbound audio track belongs to | ||
| */ | ||
@@ -1726,3 +1729,3 @@ peerConnectionId?: string; | ||
| /** | ||
| * The remote clientId the source outbound track belongs to | ||
| * The remote client ID the source outbound track belongs to | ||
| */ | ||
@@ -1732,3 +1735,3 @@ remoteClientId?: string; | ||
| /** | ||
| * The id of the SFU stream this track is sinked from | ||
| * The ID of the SFU stream this track is synced from | ||
| */ | ||
@@ -1738,3 +1741,3 @@ sfuStreamId?: string; | ||
| /** | ||
| * The id of the sink this track belongs to in the SFU | ||
| * The ID of the sink this track belongs to in the SFU | ||
| */ | ||
@@ -1744,3 +1747,3 @@ sfuSinkId?: string; | ||
| /** | ||
| * The total number of packets received on the corresponded synchronization source | ||
| * The total number of packets received on the corresponding synchronization source | ||
| */ | ||
@@ -1750,3 +1753,3 @@ packetsReceived?: number; | ||
| /** | ||
| * The total number of bytes received on the corresponded synchronization source | ||
| * The total number of bytes received on the corresponding synchronization source | ||
| */ | ||
@@ -1756,3 +1759,3 @@ packetsLost?: number; | ||
| /** | ||
| * The corresponded synchronization source reported jitter | ||
| * The corresponding synchronization source reported jitter | ||
| */ | ||
@@ -1762,3 +1765,3 @@ jitter?: number; | ||
| /** | ||
| * Represents the timestamp at which the last packet was received on the corresponded synchronization source (ssrc) | ||
| * Represents the timestamp at which the last packet was received on the corresponding synchronization source (ssrc) | ||
| */ | ||
@@ -1773,3 +1776,3 @@ lastPacketReceivedTimestamp?: number; | ||
| /** | ||
| * The total number of packets missed the playout point and therefore discarded by the jitterbuffer | ||
| * The total number of packets that missed the playout point and were therefore discarded by the jitter buffer | ||
| */ | ||
@@ -1784,3 +1787,3 @@ packetsDiscarded?: number; | ||
| /** | ||
| * Total number of FEC packets discarded over the corresponding synchronization source (ssrc) due to 1) late arrive; 2) the target RTP packet has already been repaired. | ||
| * Total number of FEC packets discarded over the corresponding synchronization source (ssrc) due to 1) late arrival; 2) the target RTP packet has already been repaired. | ||
| */ | ||
@@ -1790,3 +1793,3 @@ fecPacketsDiscarded?: number; | ||
| /** | ||
| * Total number of bytes received over the corresponding synchronization source (ssrc) due to 1) late arrive; 2) the target RTP packet has already been repaired. | ||
| * Total number of bytes received over the corresponding synchronization source (ssrc) due to 1) late arrival; 2) the target RTP packet has already been repaired. | ||
| */ | ||
@@ -1796,3 +1799,3 @@ bytesReceived?: number; | ||
| /** | ||
| * Count the total number of Negative ACKnowledgement (NACK) packets sent and belongs to the corresponded synchronization source (ssrc) | ||
| * Count the total number of Negative ACKnowledgement (NACK) packets sent and belongs to the corresponding synchronization source (ssrc) | ||
| */ | ||
@@ -1802,3 +1805,3 @@ nackCount?: number; | ||
| /** | ||
| * The total processing delay in seconds spend on buffering RTP packets from received up until packets are decoded | ||
| * The total processing delay in seconds spent on buffering RTP packets from receipt until packets are decoded | ||
| */ | ||
@@ -1808,3 +1811,3 @@ totalProcessingDelay?: number; | ||
| /** | ||
| * The estimated playout time of the corresponded synchronization source | ||
| * The estimated playout time of the corresponding synchronization source | ||
| */ | ||
@@ -1814,3 +1817,3 @@ estimatedPlayoutTimestamp?: number; | ||
| /** | ||
| * The total time of RTP packets spent in jitterbuffer waiting for frame completion due to network uncertenity. | ||
| * The total time of RTP packets spent in the jitter buffer waiting for frame completion due to network uncertainty. | ||
| */ | ||
@@ -1820,3 +1823,3 @@ jitterBufferDelay?: number; | ||
| /** | ||
| * This value is increased by the target jitter buffer delay every time a sample is emitted by the jitter buffer. The added target is the target delay, in seconds, at the time that the sample was emitted from the jitter buffer. | ||
| * This value is increased by the target jitter buffer delay every time a sample is emitted by the jitter buffer. The added target is the target delay, in seconds, at the time that the sample was emitted from the jitter buffer. | ||
| */ | ||
@@ -1826,3 +1829,3 @@ jitterBufferTargetDelay?: number; | ||
| /** | ||
| * The total number of audio samples or video frames that have come out of the jitter buffer on the corresponded synchronization source (ssrc) | ||
| * The total number of audio samples or video frames that have come out of the jitter buffer on the corresponding synchronization source (ssrc) | ||
| */ | ||
@@ -1948,3 +1951,3 @@ jitterBufferEmittedCount?: number; | ||
| /** | ||
| * The fingerprint of the certificate. | ||
| * The fingerprint of the certificate. | ||
| */ | ||
@@ -1964,3 +1967,3 @@ fingerprint?: string; | ||
| /** | ||
| * The id of the next certificate in the certificate chain | ||
| * The ID of the next certificate in the certificate chain | ||
| */ | ||
@@ -1976,3 +1979,3 @@ issuerCertificateId?: string; | ||
| /** | ||
| * Payload type used in RTP encoding / decoding process. | ||
| * Payload type used in the RTP encoding/decoding process. | ||
| */ | ||
@@ -1987,3 +1990,3 @@ payloadType?: string; | ||
| /** | ||
| * The MIME type of the media. eg.: audio/opus. | ||
| * The MIME type of the media, e.g., audio/opus. | ||
| */ | ||
@@ -1993,3 +1996,3 @@ mimeType?: string; | ||
| /** | ||
| * the clock rate used in RTP transport to generate the timestamp for the carried frames | ||
| * The clock rate used in RTP transport to generate the timestamp for the carried frames | ||
| */ | ||
@@ -1999,3 +2002,3 @@ clockRate?: number; | ||
| /** | ||
| * Audio Only. Represnts the number of chanels an audio media source have. Only interesting if stereo is presented | ||
| * Audio Only. Represents the number of channels an audio media source has. Only interesting if stereo is presented | ||
| */ | ||
@@ -2016,3 +2019,3 @@ channels?: number; | ||
| /** | ||
| * The unique identifier of the corresponded media track | ||
| * The unique identifier of the corresponding media track | ||
| */ | ||
@@ -2022,3 +2025,3 @@ trackIdentifier?: string; | ||
| /** | ||
| * The type of the media the Mediasource produces. | ||
| * The type of the media the MediaSource produces. | ||
| */ | ||
@@ -2058,3 +2061,3 @@ kind?: "audio" | "video"; | ||
| /** | ||
| * . The total duration, in seconds, of samples produced by the device that got dropped before reaching the media source | ||
| * The total duration, in seconds, of samples produced by the device that got dropped before reaching the media source | ||
| */ | ||
@@ -2089,3 +2092,3 @@ droppedSamplesDuration?: number; | ||
| /** | ||
| * The total number of frames originated from the media source | ||
| * The total number of frames originating from the media source | ||
| */ | ||
@@ -2095,3 +2098,3 @@ frames?: number; | ||
| /** | ||
| * The number of frames origianted from the media source in the last second | ||
| * The number of frames originating from the media source in the last second | ||
| */ | ||
@@ -2117,3 +2120,3 @@ framesPerSecond?: number; | ||
| /** | ||
| * The label associated to the peer connection | ||
| * The label associated with the peer connection | ||
| */ | ||
@@ -2128,3 +2131,3 @@ label?: string; | ||
| /** | ||
| * The unique identifier of the candidate the negotiated pair is selected at local side | ||
| * The unique identifier of the candidate the negotiated pair is selected on the local side | ||
| */ | ||
@@ -2134,3 +2137,3 @@ localCandidateId?: string; | ||
| /** | ||
| * The unique identifier of the candidate the negotiated pair is selected at remote side | ||
| * The unique identifier of the candidate the negotiated pair is selected on the remote side | ||
| */ | ||
@@ -2140,3 +2143,3 @@ remoteCandidateId?: string; | ||
| /** | ||
| * The state of ICE Candidate Pairs (RTCStatsIceState) on the corresponded transport | ||
| * The state of ICE Candidate Pairs (RTCStatsIceState) on the corresponding transport | ||
| */ | ||
@@ -2146,3 +2149,3 @@ state?: string; | ||
| /** | ||
| * indicate if the ice candidate pair is nominated or not | ||
| * Indicates if the ice candidate pair is nominated or not | ||
| */ | ||
@@ -2152,3 +2155,3 @@ nominated?: boolean; | ||
| /** | ||
| * The total number of packets sent using the last selected candidate pair over the corresponded transport | ||
| * The total number of packets sent using the last selected candidate pair over the corresponding transport | ||
| */ | ||
@@ -2158,3 +2161,3 @@ packetsSent?: number; | ||
| /** | ||
| * The total number of packets received using the last selected candidate pair over the corresponded transport | ||
| * The total number of packets received using the last selected candidate pair over the corresponding transport | ||
| */ | ||
@@ -2164,3 +2167,3 @@ packetsReceived?: number; | ||
| /** | ||
| * The total number of bytes sent using the last selected candidate pair over the corresponded transport | ||
| * The total number of bytes sent using the last selected candidate pair over the corresponding transport | ||
| */ | ||
@@ -2170,3 +2173,3 @@ bytesSent?: number; | ||
| /** | ||
| * The total number of bytes received using the last selected candidate pair over the corresponded transport | ||
| * The total number of bytes received using the last selected candidate pair over the corresponding transport | ||
| */ | ||
@@ -2176,3 +2179,3 @@ bytesReceived?: number; | ||
| /** | ||
| * Represents the timestamp at which the last packet was sent on the selected candidate pair, excluding STUN packets over the corresponded transport (UTC Epoch in ms) | ||
| * Represents the timestamp at which the last packet was sent on the selected candidate pair, excluding STUN packets over the corresponding transport (UTC Epoch in ms) | ||
| */ | ||
@@ -2182,3 +2185,3 @@ lastPacketSentTimestamp?: number; | ||
| /** | ||
| * Represents the timestamp at which the last packet was received on the selected candidate pair, excluding STUN packets over the corresponded transport (UTC Epoch in ms) | ||
| * Represents the timestamp at which the last packet was received on the selected candidate pair, excluding STUN packets over the corresponding transport (UTC Epoch in ms) | ||
| */ | ||
@@ -2188,3 +2191,3 @@ lastPacketReceivedTimestamp?: number; | ||
| /** | ||
| * Represents the sum of all round trip time measurements in seconds since the beginning of the session, based on STUN connectivity check over the corresponded transport | ||
| * Represents the sum of all round trip time measurements in seconds since the beginning of the session, based on STUN connectivity check over the corresponding transport | ||
| */ | ||
@@ -2194,3 +2197,3 @@ totalRoundTripTime?: number; | ||
| /** | ||
| * Represents the last round trip time measurements in seconds based on STUN connectivity check over the corresponded transport | ||
| * Represents the last round trip time measurement in seconds based on STUN connectivity check over the corresponding transport | ||
| */ | ||
@@ -2200,3 +2203,3 @@ currentRoundTripTime?: number; | ||
| /** | ||
| * The sum of the underlying cc algorithm provided outgoing bitrate for the RTP streams over the corresponded transport | ||
| * The sum of the underlying cc algorithm provided outgoing bitrate for the RTP streams over the corresponding transport | ||
| */ | ||
@@ -2206,3 +2209,3 @@ availableOutgoingBitrate?: number; | ||
| /** | ||
| * The sum of the underlying cc algorithm provided incoming bitrate for the RTP streams over the corresponded transport | ||
| * The sum of the underlying cc algorithm provided incoming bitrate for the RTP streams over the corresponding transport | ||
| */ | ||
@@ -2212,3 +2215,3 @@ availableIncomingBitrate?: number; | ||
| /** | ||
| * Represents the total number of connectivity check requests received on the selected candidate pair using the corresponded transport | ||
| * Represents the total number of connectivity check requests received on the selected candidate pair using the corresponding transport | ||
| */ | ||
@@ -2218,3 +2221,3 @@ requestsReceived?: number; | ||
| /** | ||
| * Represents the total number of connectivity check requests sent on the selected candidate pair using the corresponded transport | ||
| * Represents the total number of connectivity check requests sent on the selected candidate pair using the corresponding transport | ||
| */ | ||
@@ -2224,3 +2227,3 @@ requestsSent?: number; | ||
| /** | ||
| * Represents the total number of connectivity check responses received on the selected candidate pair using the corresponded transport | ||
| * Represents the total number of connectivity check responses received on the selected candidate pair using the corresponding transport | ||
| */ | ||
@@ -2230,3 +2233,3 @@ responsesReceived?: number; | ||
| /** | ||
| * Represents the total number of connectivity check responses sent on the selected candidate pair using the corresponded transport | ||
| * Represents the total number of connectivity check responses sent on the selected candidate pair using the corresponding transport | ||
| */ | ||
@@ -2236,3 +2239,3 @@ responsesSent?: number; | ||
| /** | ||
| * Represents the total number of consent requests sent on the selected candidate pair using the corresponded transport | ||
| * Represents the total number of consent requests sent on the selected candidate pair using the corresponding transport | ||
| */ | ||
@@ -2242,3 +2245,3 @@ consentRequestsSent?: number; | ||
| /** | ||
| * Total amount of packets for this candidate pair that have been discarded due to socket errors on the selected candidate pair using the corresponded transport | ||
| * Total number of packets for this candidate pair that have been discarded due to socket errors on the selected candidate pair using the corresponding transport | ||
| */ | ||
@@ -2248,3 +2251,3 @@ packetsDiscardedOnSend?: number; | ||
| /** | ||
| * Total amount of bytes for this candidate pair that have been discarded due to socket errors on the selected candidate pair using the corresponded transport | ||
| * Total number of bytes for this candidate pair that have been discarded due to socket errors on the selected candidate pair using the corresponding transport | ||
| */ | ||
@@ -2260,3 +2263,3 @@ bytesDiscardedOnSend?: number; | ||
| /** | ||
| * The identifier of the transport the ice candidate pair is negotiated on | ||
| * The identifier of the transport the ICE candidate pair is negotiated on | ||
| */ | ||
@@ -2276,3 +2279,3 @@ transportId: string; | ||
| /** | ||
| * Represents the total number of packets sent on the corresponded transport | ||
| * Represents the total number of packets sent on the corresponding transport | ||
| */ | ||
@@ -2282,3 +2285,3 @@ packetsSent?: number; | ||
| /** | ||
| * Represents the total number of packets received on the corresponded transport | ||
| * Represents the total number of packets received on the corresponding transport | ||
| */ | ||
@@ -2288,3 +2291,3 @@ packetsReceived?: number; | ||
| /** | ||
| * Represents the total amount of bytes sent on the corresponded transport | ||
| * Represents the total amount of bytes sent on the corresponding transport | ||
| */ | ||
@@ -2294,3 +2297,3 @@ bytesSent?: number; | ||
| /** | ||
| * Represents the total amount of bytes received on the corresponded transport | ||
| * Represents the total amount of bytes received on the corresponding transport | ||
| */ | ||
@@ -2300,3 +2303,3 @@ bytesReceived?: number; | ||
| /** | ||
| * Represent the current role of ICE under DTLS Transport | ||
| * Represents the current role of ICE under DTLS Transport | ||
| */ | ||
@@ -2306,3 +2309,3 @@ iceRole?: string; | ||
| /** | ||
| * Represent the current local username fragment used in message validation procedures for ICE under DTLS Transport | ||
| * Represents the current local username fragment used in message validation procedures for ICE under DTLS Transport | ||
| */ | ||
@@ -2327,3 +2330,3 @@ iceLocalUsernameFragment?: string; | ||
| /** | ||
| * If DTLS negotiated it gives the id of the local certificate | ||
| * If DTLS negotiated, it gives the ID of the local certificate | ||
| */ | ||
@@ -2333,3 +2336,3 @@ localCertificateId?: string; | ||
| /** | ||
| * If DTLS negotiated it gives the id of the remote certificate | ||
| * If DTLS negotiated, it gives the ID of the remote certificate | ||
| */ | ||
@@ -2339,3 +2342,3 @@ remoteCertificateId?: string; | ||
| /** | ||
| * Represents the version number of the TLS used in the corresponded transport | ||
| * Represents the version number of the TLS used in the corresponding transport | ||
| */ | ||
@@ -2345,3 +2348,3 @@ tlsVersion?: string; | ||
| /** | ||
| * Represents the name of the DTLS cipher used in the corresponded transport | ||
| * Represents the name of the DTLS cipher used in the corresponding transport | ||
| */ | ||
@@ -2356,3 +2359,3 @@ dtlsCipher?: string; | ||
| /** | ||
| * Represents the name of the SRTP cipher used in the corresponded transport | ||
| * Represents the name of the SRTP cipher used in the corresponding transport | ||
| */ | ||
@@ -2362,3 +2365,3 @@ srtpCipher?: string; | ||
| /** | ||
| * Represents the name of the IANA TLS Supported Groups used in the corresponded transport | ||
| * Represents the name of the IANA TLS Supported Groups used in the corresponding transport | ||
| */ | ||
@@ -2375,3 +2378,3 @@ tlsGroup?: string; | ||
| /** | ||
| * Measurements about the data channels currently avaialble on peer connections | ||
| * Measurements about the data channels currently available on peer connections | ||
| */ | ||
@@ -2405,3 +2408,3 @@ export type DataChannel = { | ||
| /** | ||
| * The total number of message sent on the data channel | ||
| * The total number of messages sent on the data channel | ||
| */ | ||
@@ -2416,3 +2419,3 @@ messageSent?: number; | ||
| /** | ||
| * The total number of message received on the data channel | ||
| * The total number of messages received on the data channel | ||
| */ | ||
@@ -2429,3 +2432,3 @@ messageReceived?: number; | ||
| /** | ||
| * User provided custom call events | ||
| * User provided custom observer events | ||
| */ | ||
@@ -2518,3 +2521,3 @@ export type CustomObserverEvent = { | ||
| /** | ||
| * The WebRTC app provided List of the media devices the client has. | ||
| * The WebRTC app provided list of the media devices the client has. | ||
| */ | ||
@@ -2540,7 +2543,7 @@ export type MediaDevice = { | ||
| /** | ||
| * WebRTC App provided information related to the operation system the client uses. | ||
| * WebRTC App provided information related to the operating system the client uses. | ||
| */ | ||
| export type OperationSystem = { | ||
| /** | ||
| * The name of the operation system (e.g.: linux) the webrtc app uses | ||
| * The name of the operating system (e.g., Linux) the WebRTC app uses | ||
| */ | ||
@@ -2550,3 +2553,3 @@ name?: string; | ||
| /** | ||
| * The version of the operation system | ||
| * The version of the operating system | ||
| */ | ||
@@ -2556,3 +2559,3 @@ version?: string; | ||
| /** | ||
| * The name of the version of the operation system | ||
| * The name of the version of the operating system | ||
| */ | ||
@@ -2568,3 +2571,3 @@ versionName?: string; | ||
| /** | ||
| * The name of the operation system (e.g.: linux) the webrtc app uses | ||
| * The name of the operating system (e.g., Linux) the WebRTC app uses | ||
| */ | ||
@@ -2574,3 +2577,3 @@ name?: string; | ||
| /** | ||
| * The version of the operation system | ||
| * The version of the operating system | ||
| */ | ||
@@ -2623,3 +2626,3 @@ version?: string; | ||
| /** | ||
| * Unique id of the client providing samples. Must be a valid UUID | ||
| * Unique id of the client providing samples. Must be a valid UUID. | ||
| */ | ||
@@ -2634,3 +2637,3 @@ clientId: string; | ||
| /** | ||
| * If it is provided the server uses the given id to match clients in the same call. Must be a valid UUID. | ||
| * If provided, the server uses the given id to match clients in the same call. Must be a valid UUID. | ||
| */ | ||
@@ -2640,3 +2643,3 @@ callId?: string; | ||
| /** | ||
| * The sequence number a source assigns to the sample. Every time the source make a sample at a client this number should be monothonically incremented. | ||
| * The sequence number a source assigns to the sample. Each time the source takes a sample at a client, this number should be monotonically incremented. | ||
| */ | ||
@@ -2651,3 +2654,3 @@ sampleSeq?: number; | ||
| /** | ||
| * The WebRTC app configured human readable user id the client is joined. | ||
| * The WebRTC app configured human-readable user id the client is joined. | ||
| */ | ||
@@ -2672,3 +2675,3 @@ userId?: string; | ||
| /** | ||
| * WebRTC App provided information related to the operation system the client uses. | ||
| * WebRTC App provided information related to the operating system the client uses. | ||
| */ | ||
@@ -2678,3 +2681,3 @@ os?: OperationSystem; | ||
| /** | ||
| * The WebRTC app provided List of the media constraints the client has. | ||
| * The WebRTC app provided list of the media constraints the client has. | ||
| */ | ||
@@ -2684,3 +2687,3 @@ mediaConstraints?: string[]; | ||
| /** | ||
| * The WebRTC app provided List of the media devices the client has. | ||
| * The WebRTC app provided list of the media devices the client has. | ||
| */ | ||
@@ -2690,3 +2693,3 @@ mediaDevices?: MediaDevice[]; | ||
| /** | ||
| * The WebRTC app provided List of user media errors the client has. | ||
| * The WebRTC app provided list of user media errors the client has. | ||
| */ | ||
@@ -2706,3 +2709,3 @@ userMediaErrors?: string[]; | ||
| /** | ||
| * User provided custom call events | ||
| * User provided custom observer events | ||
| */ | ||
@@ -2712,3 +2715,3 @@ customObserverEvents?: CustomObserverEvent[]; | ||
| /** | ||
| * The WebRTC app provided List of ICE server the client used. | ||
| * The WebRTC app provided list of ICE servers the client used. | ||
| */ | ||
@@ -2723,3 +2726,3 @@ iceServers?: string[]; | ||
| /** | ||
| * Measurements about the data channels currently avaialble on peer connections | ||
| * Measurements about the data channels currently available on peer connections | ||
| */ | ||
@@ -2726,0 +2729,0 @@ dataChannels?: DataChannel[]; |
@@ -7,8 +7,8 @@ { | ||
| "target": "es2018", | ||
| "module": "es6", | ||
| // "moduleResolution": "node", | ||
| "module": "commonjs", | ||
| "moduleResolution": "node", | ||
| "esModuleInterop": true, | ||
| "isolatedModules": true, | ||
| "strict": true, | ||
| "outDir": "lib", | ||
| "outDir": "./dist", | ||
| "declaration": true, | ||
@@ -15,0 +15,0 @@ "declarationMap": true |
New alerts
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.87%
256662
- Lines of code
- increased by0.69%
5225
Worsened metrics
- Number of medium supply chain risk alerts
- increased byInfinity%
1
No dependency changes