Stats

The stats dictionaries of the WebRTC Statistics specification, and the report that holds them.

class webrtc.models.rtc_stats.RTCStats(**members)

The members every stats dictionary has, and the base of all of them.

A report holds the dictionary of the type of the stats, like webrtc.RTCOutboundRtpStreamStats. It holds this base one for a type this library doesn’t model, or when a required member is missing from the stats. Members are keyword-only. A string value that its enum lacks is kept as a plain str.

Parameters:

• timestamp (float) – When the stats were collected, in milliseconds since the Unix epoch.

• type (webrtc.RTCStatsType) – The type of the stats, like 'outbound-rtp'.

• id (str) – Identifies the stats in its report.

Raises:

TypeError – If a required member is missing, or a member is unknown.

class webrtc.models.rtc_stats.RTCRtpStreamStats(**members)

Stats of an RTP stream.

It has the members of webrtc.RTCStats too.

Parameters:

• ssrc (int) – The SSRC of the RTP stream. See MDN: RTCInboundRtpStreamStats/ssrc.

• kind (str) – The kind of the media, 'audio' or 'video'. See MDN: RTCInboundRtpStreamStats/kind.

• transport_id (str, optional) – The id of the stats of the transport of the stream. See MDN: RTCInboundRtpStreamStats/transportId.

• codec_id (str, optional) – The id of the stats of the codec of the stream. See MDN: RTCInboundRtpStreamStats/codecId.

class webrtc.models.rtc_stats.RTCCodecStats(**members)

Stats of a codec negotiated on a transport, of type 'codec'.

It has the members of webrtc.RTCStats too.

See MDN: RTCCodecStats.

Parameters:

• payload_type (int) – The RTP payload type of the codec. See MDN: RTCCodecStats/payloadType.

• transport_id (str) – The id of the stats of the transport the codec is negotiated on. See MDN: RTCCodecStats/transportId.

• mime_type (str) – The type and subtype of the codec, like 'audio/opus'. See MDN: RTCCodecStats/mimeType.

• clock_rate (int, optional) – The clock rate in Hz. See MDN: RTCCodecStats/clockRate.

• channels (int, optional) – The number of audio channels. See MDN: RTCCodecStats/channels.

• sdp_fmtp_line (str, optional) – The parameters of the codec, as in the a=fmtp line of SDP. See MDN: RTCCodecStats/sdpFmtpLine.

class webrtc.models.rtc_stats.RTCReceivedRtpStreamStats(**members)

Stats of an RTP stream, as its receiver measures it.

It has the members of webrtc.RTCRtpStreamStats too.

Parameters:

• packets_received (int, optional) – The packets received. See MDN: RTCInboundRtpStreamStats/packetsReceived.

• packets_received_with_ect1 (int, optional) – The packets received with the ECT(1) ECN marking.

• packets_received_with_ce (int, optional) – The packets received with the CE ECN marking.

• packets_reported_as_lost (int, optional) – The packets reported lost in congestion control feedback.

• packets_reported_as_lost_but_recovered (int, optional) – The packets reported lost that were received later.

• packets_lost (int, optional) – The packets lost, as RTCP reports count them. See MDN: RTCInboundRtpStreamStats/packetsLost.

• jitter (float, optional) – The packet jitter in seconds. See MDN: RTCInboundRtpStreamStats/jitter.

class webrtc.models.rtc_stats.RTCInboundRtpStreamStats(**members)

Stats of an RTP stream the connection receives, of type 'inbound-rtp'.

It has the members of webrtc.RTCReceivedRtpStreamStats too.

See MDN: RTCInboundRtpStreamStats.

Parameters:

• track_identifier (str) – The id of the track. See MDN: RTCInboundRtpStreamStats/trackIdentifier.

• mid (str, optional) – The media id of the transceiver. See MDN: RTCInboundRtpStreamStats/mid.

• remote_id (str, optional) – The id of the remote-outbound-rtp stats of the stream. See MDN: RTCInboundRtpStreamStats/remoteId.

• frames_decoded (int, optional) – The frames decoded. See MDN: RTCInboundRtpStreamStats/framesDecoded.

• key_frames_decoded (int, optional) – The key frames decoded. See MDN: RTCInboundRtpStreamStats/keyFramesDecoded.

• frames_rendered (int, optional) – The frames rendered.

• frames_dropped (int, optional) – The frames dropped before decoding.

• frame_width (int, optional) – The width of the last frame. See MDN: RTCInboundRtpStreamStats/frameWidth.

• frame_height (int, optional) – The height of the last frame. See MDN: RTCInboundRtpStreamStats/frameHeight.

• frames_per_second (float, optional) – The frames per second over the last second. See MDN: RTCInboundRtpStreamStats/framesPerSecond.

• qp_sum (int, optional) – The sum of the quantization parameters of the frames. See MDN: RTCInboundRtpStreamStats/qpSum.

• total_decode_time (float, optional) – The total seconds spent decoding. See MDN: RTCInboundRtpStreamStats/totalDecodeTime.

• total_inter_frame_delay (float, optional) – The total seconds between rendered frames. See MDN: RTCInboundRtpStreamStats/totalInterFrameDelay.

• total_squared_inter_frame_delay (float, optional) – The sum of the squared seconds between rendered frames. See MDN: RTCInboundRtpStreamStats/totalSquaredInterFrameDelay.

• pause_count (int, optional) – The video pauses. See MDN: RTCInboundRtpStreamStats/pauseCount.

• total_pauses_duration (float, optional) – The total seconds of the pauses. See MDN: RTCInboundRtpStreamStats/totalPausesDuration.

• freeze_count (int, optional) – The video freezes. See MDN: RTCInboundRtpStreamStats/freezeCount.

• total_freezes_duration (float, optional) – The total seconds of the freezes. See MDN: RTCInboundRtpStreamStats/totalFreezesDuration.

• last_packet_received_timestamp (float, optional) – When the last packet was received, in milliseconds since the epoch. See MDN: RTCInboundRtpStreamStats/lastPacketReceivedTimestamp.

• header_bytes_received (int, optional) – The bytes of RTP headers and padding received. See MDN: RTCInboundRtpStreamStats/headerBytesReceived.

• packets_discarded (int, optional) – The packets the jitter buffer discarded. See MDN: RTCInboundRtpStreamStats/packetsDiscarded.

• fec_bytes_received (int, optional) – The bytes of FEC payload received.

• fec_packets_received (int, optional) – The FEC packets received. See MDN: RTCInboundRtpStreamStats/fecPacketsReceived.

• fec_packets_discarded (int, optional) – The FEC packets discarded. See MDN: RTCInboundRtpStreamStats/fecPacketsDiscarded.

• bytes_received (int, optional) – The bytes received. See MDN: RTCInboundRtpStreamStats/bytesReceived.

• nack_count (int, optional) – The NACK packets. See MDN: RTCInboundRtpStreamStats/nackCount.

• fir_count (int, optional) – The FIR packets.

• pli_count (int, optional) – The PLI packets.

• total_processing_delay (float, optional) – The total seconds from receiving frames or samples to decoding them. See MDN: RTCInboundRtpStreamStats/totalProcessingDelay.

• estimated_playout_timestamp (float, optional) – When the last frame or sample is estimated to play out, in milliseconds since the epoch. See MDN: RTCInboundRtpStreamStats/estimatedPlayoutTimestamp.

• jitter_buffer_delay (float, optional) – The total seconds frames or samples spent in the jitter buffer. See MDN: RTCInboundRtpStreamStats/jitterBufferDelay.

• jitter_buffer_target_delay (float, optional) – The sum of the target delays of the jitter buffer, in seconds. See MDN: RTCInboundRtpStreamStats/jitterBufferTargetDelay.

• jitter_buffer_emitted_count (int, optional) – The frames or samples that left the jitter buffer. See MDN: RTCInboundRtpStreamStats/jitterBufferEmittedCount.

• jitter_buffer_minimum_delay (float, optional) – The sum of the minimum delays of the jitter buffer, in seconds. See MDN: RTCInboundRtpStreamStats/jitterBufferMinimumDelay.

• total_samples_received (int, optional) – The audio samples received. See MDN: RTCInboundRtpStreamStats/totalSamplesReceived.

• concealed_samples (int, optional) – The audio samples concealed. See MDN: RTCInboundRtpStreamStats/concealedSamples.

• silent_concealed_samples (int, optional) – The audio samples concealed with silence. See MDN: RTCInboundRtpStreamStats/silentConcealedSamples.

• concealment_events (int, optional) – The concealment events. See MDN: RTCInboundRtpStreamStats/concealmentEvents.

• inserted_samples_for_deceleration (int, optional) – The audio samples inserted to slow playout down. See MDN: RTCInboundRtpStreamStats/insertedSamplesForDeceleration.

• removed_samples_for_acceleration (int, optional) – The audio samples removed to speed playout up. See MDN: RTCInboundRtpStreamStats/removedSamplesForAcceleration.

• audio_level (float, optional) – The audio level, between 0 and 1. See MDN: RTCInboundRtpStreamStats/audioLevel.

• total_audio_energy (float, optional) – The total audio energy. See MDN: RTCInboundRtpStreamStats/totalAudioEnergy.

• total_samples_duration (float, optional) – The total seconds of the audio samples. See MDN: RTCInboundRtpStreamStats/totalSamplesDuration.

• frames_received (int, optional) – The complete frames received. See MDN: RTCInboundRtpStreamStats/framesReceived.

• decoder_implementation (str, optional) – The decoder, like libvpx.

• playout_id (str, optional) – The id of the media-playout stats of the audio. See MDN: RTCInboundRtpStreamStats/playoutId.

• power_efficient_decoder (bool, optional) – Whether the decoder is power efficient.

• frames_assembled_from_multiple_packets (int, optional) – The frames assembled from more than one packet. See MDN: RTCInboundRtpStreamStats/framesAssembledFromMultiplePackets.

• total_assembly_time (float, optional) – The total seconds spent assembling those frames. See MDN: RTCInboundRtpStreamStats/totalAssemblyTime.

• retransmitted_packets_received (int, optional) – The retransmitted packets received.

• retransmitted_bytes_received (int, optional) – The bytes of retransmitted payload received.

• rtx_ssrc (int, optional) – The SSRC of the RTX stream.

• fec_ssrc (int, optional) – The SSRC of the FEC stream.

• total_corruption_probability (float, optional) – The sum of the probabilities of video corruption.

• total_squared_corruption_probability (float, optional) – The sum of the squared probabilities of video corruption.

• corruption_measurements (int, optional) – The video corruption measurements.

class webrtc.models.rtc_stats.RTCRemoteInboundRtpStreamStats(**members)

Stats of a stream the connection sends, as the remote peer receives it. Its type is 'remote-inbound-rtp'.

It has the members of webrtc.RTCReceivedRtpStreamStats too.

See MDN: RTCRemoteInboundRtpStreamStats.

Parameters:

• local_id (str, optional) – The id of the outbound-rtp stats of the stream. See MDN: RTCRemoteInboundRtpStreamStats/localId.

• round_trip_time (float, optional) – The last round trip time in seconds. See MDN: RTCRemoteInboundRtpStreamStats/roundTripTime.

• total_round_trip_time (float, optional) – The total seconds of the round trip times. See MDN: RTCRemoteInboundRtpStreamStats/totalRoundTripTime.

• fraction_lost (float, optional) – The fraction of packets lost in the last RTCP report. See MDN: RTCRemoteInboundRtpStreamStats/fractionLost.

• round_trip_time_measurements (int, optional) – The round trip time measurements. See MDN: RTCRemoteInboundRtpStreamStats/roundTripTimeMeasurements.

• packets_with_bleached_ect1_marking (int, optional) – The packets sent with ECT(1) that arrived without it.

class webrtc.models.rtc_stats.RTCSentRtpStreamStats(**members)

Stats of an RTP stream, as its sender measures it.

It has the members of webrtc.RTCRtpStreamStats too.

Parameters:

• packets_sent (int, optional) – The packets sent. See MDN: RTCOutboundRtpStreamStats/packetsSent.

• bytes_sent (int, optional) – The bytes sent. See MDN: RTCOutboundRtpStreamStats/bytesSent.

class webrtc.models.rtc_stats.RTCOutboundRtpStreamStats(**members)

Stats of an RTP stream the connection sends, of type 'outbound-rtp'.

It has the members of webrtc.RTCSentRtpStreamStats too.

See MDN: RTCOutboundRtpStreamStats.

Parameters:

• mid (str, optional) – The media id of the transceiver. See MDN: RTCOutboundRtpStreamStats/mid.

• media_source_id (str, optional) – The id of the media-source stats of the track sent. See MDN: RTCOutboundRtpStreamStats/mediaSourceId.

• remote_id (str, optional) – The id of the remote-inbound-rtp stats of the stream. See MDN: RTCOutboundRtpStreamStats/remoteId.

• rid (str, optional) – The RTP stream id of the simulcast layer. See MDN: RTCOutboundRtpStreamStats/rid.

• encoding_index (int, optional) – The index of the encoding in the parameters of the sender.

• header_bytes_sent (int, optional) – The bytes of RTP headers and padding sent. See MDN: RTCOutboundRtpStreamStats/headerBytesSent.

• retransmitted_packets_sent (int, optional) – The packets retransmitted. See MDN: RTCOutboundRtpStreamStats/retransmittedPacketsSent.

• retransmitted_bytes_sent (int, optional) – The bytes of payload retransmitted. See MDN: RTCOutboundRtpStreamStats/retransmittedBytesSent.

• rtx_ssrc (int, optional) – The SSRC of the RTX stream.

• target_bitrate (float, optional) – The target bitrate of the encoder, in bits per second. See MDN: RTCOutboundRtpStreamStats/targetBitrate.

• total_encoded_bytes_target (int, optional) – The sum of the target sizes of the encoded frames, in bytes. See MDN: RTCOutboundRtpStreamStats/totalEncodedBytesTarget.

• frame_width (int, optional) – The width of the last frame. See MDN: RTCOutboundRtpStreamStats/frameWidth.

• frame_height (int, optional) – The height of the last frame. See MDN: RTCOutboundRtpStreamStats/frameHeight.

• frames_per_second (float, optional) – The frames per second over the last second. See MDN: RTCOutboundRtpStreamStats/framesPerSecond.

• frames_sent (int, optional) – The frames sent. See MDN: RTCOutboundRtpStreamStats/framesSent.

• huge_frames_sent (int, optional) – The huge frames sent, like key frames.

• frames_encoded (int, optional) – The frames encoded. See MDN: RTCOutboundRtpStreamStats/framesEncoded.

• key_frames_encoded (int, optional) – The key frames encoded. See MDN: RTCOutboundRtpStreamStats/keyFramesEncoded.

• qp_sum (int, optional) – The sum of the quantization parameters of the frames. See MDN: RTCOutboundRtpStreamStats/qpSum.

• psnr_sum (dict of str to float, optional) – The sums of the PSNR of the encoded frames, by component (y, u, v).

• psnr_measurements (int, optional) – The PSNR measurements.

• total_encode_time (float, optional) – The total seconds spent encoding. See MDN: RTCOutboundRtpStreamStats/totalEncodeTime.

• total_packet_send_delay (float, optional) – The total seconds packets waited to be sent. See MDN: RTCOutboundRtpStreamStats/totalPacketSendDelay.

• quality_limitation_reason (webrtc.RTCQualityLimitationReason, optional) – What limits the resolution or frame rate the most. See MDN: RTCOutboundRtpStreamStats/qualityLimitationReason.

• quality_limitation_durations (dict of str to float, optional) – The seconds limited by each reason. See MDN: RTCOutboundRtpStreamStats/qualityLimitationDurations.

• quality_limitation_resolution_changes (int, optional) – The resolution changes because of quality limitations.

• nack_count (int, optional) – The NACK packets. See MDN: RTCOutboundRtpStreamStats/nackCount.

• fir_count (int, optional) – The FIR packets.

• pli_count (int, optional) – The PLI packets.

• encoder_implementation (str, optional) – The encoder, like libvpx.

• power_efficient_encoder (bool, optional) – Whether the encoder is power efficient.

• active (bool, optional) – Whether the encoding is sent. See MDN: RTCOutboundRtpStreamStats/active.

• scalability_mode (str, optional) – The scalability mode, like 'L1T3'. See MDN: RTCOutboundRtpStreamStats/scalabilityMode.

• packets_sent_with_ect1 (int, optional) – The packets sent with the ECT(1) ECN marking.

class webrtc.models.rtc_stats.RTCRemoteOutboundRtpStreamStats(**members)

Stats of a stream the connection receives, as the remote peer sends it. Its type is 'remote-outbound-rtp'.

It has the members of webrtc.RTCSentRtpStreamStats too.

See MDN: RTCRemoteOutboundRtpStreamStats.

Parameters:

• local_id (str, optional) – The id of the inbound-rtp stats of the stream. See MDN: RTCRemoteOutboundRtpStreamStats/localId.

• remote_timestamp (float, optional) – When the remote peer sent its report, in milliseconds since the epoch. See MDN: RTCRemoteOutboundRtpStreamStats/remoteTimestamp.

• reports_sent (int, optional) – The RTCP sender reports sent.

• round_trip_time (float, optional) – The last round trip time in seconds.

• total_round_trip_time (float, optional) – The total seconds of the round trip times. See MDN: RTCRemoteOutboundRtpStreamStats/totalRoundTripTime.

• round_trip_time_measurements (int, optional) – The round trip time measurements. See MDN: RTCRemoteOutboundRtpStreamStats/roundTripTimeMeasurements.

class webrtc.models.rtc_stats.RTCMediaSourceStats(**members)

Stats of a track a sender sends, of type 'media-source'.

It has the members of webrtc.RTCStats too.

Parameters:

• track_identifier (str) – The id of the track. See MDN: RTCAudioSourceStats/trackIdentifier.

• kind (str) – The kind of the track, 'audio' or 'video'. See MDN: RTCAudioSourceStats/kind.

class webrtc.models.rtc_stats.RTCAudioSourceStats(**members)

Stats of an audio track a sender sends, of type 'media-source'.

It has the members of webrtc.RTCMediaSourceStats too.

See MDN: RTCAudioSourceStats.

Parameters:

• audio_level (float, optional) – The audio level, between 0 and 1. See MDN: RTCAudioSourceStats/audioLevel.

• total_audio_energy (float, optional) – The total audio energy. See MDN: RTCAudioSourceStats/totalAudioEnergy.

• total_samples_duration (float, optional) – The total seconds of the audio samples. See MDN: RTCAudioSourceStats/totalSamplesDuration.

• echo_return_loss (float, optional) – The echo return loss in decibels.

• echo_return_loss_enhancement (float, optional) – The echo return loss enhancement in decibels.

class webrtc.models.rtc_stats.RTCVideoSourceStats(**members)

Stats of a video track a sender sends, of type 'media-source'.

It has the members of webrtc.RTCMediaSourceStats too.

See MDN: RTCVideoSourceStats.

Parameters:

• width (int, optional) – The width of the last frame. See MDN: RTCVideoSourceStats/width.

• height (int, optional) – The height of the last frame. See MDN: RTCVideoSourceStats/height.

• frames (int, optional) – The frames from the source. See MDN: RTCVideoSourceStats/frames.

• frames_per_second (float, optional) – The frames per second over the last second. See MDN: RTCVideoSourceStats/framesPerSecond.

class webrtc.models.rtc_stats.RTCAudioPlayoutStats(**members)

Stats of the playout of received audio, of type 'media-playout'.

It has the members of webrtc.RTCStats too.

Parameters:

• kind (str) – The kind of the media, 'audio'.

• synthesized_samples_duration (float, optional) – The total seconds of samples synthesized for playout.

• synthesized_samples_events (int, optional) – The events of synthesizing samples.

• total_samples_duration (float, optional) – The total seconds of samples played out.

• total_playout_delay (float, optional) – The sum of the playout delays of the samples, in seconds.

• total_samples_count (int, optional) – The samples played out.

class webrtc.models.rtc_stats.RTCPeerConnectionStats(**members)

Stats of the connection, of type 'peer-connection'.

It has the members of webrtc.RTCStats too.

See MDN: RTCPeerConnectionStats.

Parameters:

• data_channels_opened (int, optional) – The data channels opened. See MDN: RTCPeerConnectionStats/dataChannelsOpened.

• data_channels_closed (int, optional) – The data channels closed. See MDN: RTCPeerConnectionStats/dataChannelsClosed.

class webrtc.models.rtc_stats.RTCDataChannelStats(**members)

Stats of a data channel, of type 'data-channel'.

It has the members of webrtc.RTCStats too.

See MDN: RTCDataChannelStats.

Parameters:

• label (str, optional) – The label of the channel. See MDN: RTCDataChannelStats/label.

• protocol (str, optional) – The subprotocol of the channel. See MDN: RTCDataChannelStats/protocol.

• data_channel_identifier (int, optional) – The id of the channel. See MDN: RTCDataChannelStats/dataChannelIdentifier.

• state (webrtc.RTCDataChannelState) – The state of the channel. See MDN: RTCDataChannelStats/state.

• messages_sent (int, optional) – The messages sent. See MDN: RTCDataChannelStats/messagesSent.

• bytes_sent (int, optional) – The bytes sent. See MDN: RTCDataChannelStats/bytesSent.

• messages_received (int, optional) – The messages received. See MDN: RTCDataChannelStats/messagesReceived.

• bytes_received (int, optional) – The bytes received. See MDN: RTCDataChannelStats/bytesReceived.

class webrtc.models.rtc_stats.RTCTransportStats(**members)

Stats of a transport, of type 'transport'.

It has the members of webrtc.RTCStats too.

See MDN: RTCTransportStats.

Parameters:

• packets_sent (int, optional) – The packets sent. See MDN: RTCTransportStats/packetsSent.

• packets_received (int, optional) – The packets received. See MDN: RTCTransportStats/packetsReceived.

• bytes_sent (int, optional) – The bytes sent. See MDN: RTCTransportStats/bytesSent.

• bytes_received (int, optional) – The bytes received. See MDN: RTCTransportStats/bytesReceived.

• ice_role (webrtc.RTCIceRole, optional) – The ICE role. See MDN: RTCTransportStats/iceRole.

• ice_local_username_fragment (str, optional) – The local ICE username fragment. See MDN: RTCTransportStats/iceLocalUsernameFragment.

• dtls_state (webrtc.RTCDtlsTransportState) – The DTLS state. See MDN: RTCTransportStats/dtlsState.

• ice_state (webrtc.RTCIceTransportState, optional) – The ICE state. See MDN: RTCTransportStats/iceState.

• selected_candidate_pair_id (str, optional) – The id of the stats of the selected candidate pair. See MDN: RTCTransportStats/selectedCandidatePairId.

• local_certificate_id (str, optional) – The id of the stats of the local certificate. See MDN: RTCTransportStats/localCertificateId.

• remote_certificate_id (str, optional) – The id of the stats of the remote certificate. See MDN: RTCTransportStats/remoteCertificateId.

• tls_version (str, optional) – The DTLS version, in hex. See MDN: RTCTransportStats/tlsVersion.

• dtls_cipher (str, optional) – The DTLS cipher suite. See MDN: RTCTransportStats/dtlsCipher.

• dtls_role (webrtc.RTCDtlsRole, optional) – The DTLS role. See MDN: RTCTransportStats/dtlsRole.

• srtp_cipher (str, optional) – The SRTP protection profile. See MDN: RTCTransportStats/srtpCipher.

• selected_candidate_pair_changes (int, optional) – The changes of the selected candidate pair. See MDN: RTCTransportStats/selectedCandidatePairChanges.

• ccfb_messages_sent (int, optional) – The congestion control feedback messages sent.

• ccfb_messages_received (int, optional) – The congestion control feedback messages received.

class webrtc.models.rtc_stats.RTCIceCandidateStats(**members)

Stats of an ICE candidate, of type 'local-candidate' or 'remote-candidate'.

It has the members of webrtc.RTCStats too.

See MDN: RTCIceCandidateStats.

Parameters:

• transport_id (str) – The id of the stats of the transport of the candidate. See MDN: RTCIceCandidateStats/transportId.

• address (str, optional) – The address of the candidate, or None if it isn’t exposed. See MDN: RTCIceCandidateStats/address.

• port (int, optional) – The port. See MDN: RTCIceCandidateStats/port.

• protocol (str, optional) – The protocol, 'udp' or 'tcp'. See MDN: RTCIceCandidateStats/protocol.

• candidate_type (webrtc.RTCIceCandidateType) – The type of the candidate. See MDN: RTCIceCandidateStats/candidateType.

• priority (int, optional) – The priority. See MDN: RTCIceCandidateStats/priority.

• url (str, optional) – The URL of the ICE server the candidate is from. See MDN: RTCIceCandidateStats/url.

• relay_protocol (webrtc.RTCIceServerTransportProtocol, optional) – The protocol between the client and the TURN server. See MDN: RTCIceCandidateStats/relayProtocol.

• foundation (str, optional) – The foundation. See MDN: RTCIceCandidateStats/foundation.

• related_address (str, optional) – The related address.

• related_port (int, optional) – The related port.

• username_fragment (str, optional) – The ICE username fragment. See MDN: RTCIceCandidateStats/usernameFragment.

• tcp_type (webrtc.RTCIceTcpCandidateType, optional) – The type of a TCP candidate.

class webrtc.models.rtc_stats.RTCIceCandidatePairStats(**members)

Stats of an ICE candidate pair, of type 'candidate-pair'.

It has the members of webrtc.RTCStats too.

See MDN: RTCIceCandidatePairStats.

Parameters:

• transport_id (str) – The id of the stats of the transport of the pair. See MDN: RTCIceCandidatePairStats/transportId.

• local_candidate_id (str) – The id of the stats of the local candidate. See MDN: RTCIceCandidatePairStats/localCandidateId.

• remote_candidate_id (str) – The id of the stats of the remote candidate. See MDN: RTCIceCandidatePairStats/remoteCandidateId.

• state (webrtc.RTCStatsIceCandidatePairState) – The state of the pair in the checklist. See MDN: RTCIceCandidatePairStats/state.

• nominated (bool, optional) – Whether the pair is nominated. See MDN: RTCIceCandidatePairStats/nominated.

• packets_sent (int, optional) – The packets sent. See MDN: RTCIceCandidatePairStats/packetsSent.

• packets_received (int, optional) – The packets received. See MDN: RTCIceCandidatePairStats/packetsReceived.

• bytes_sent (int, optional) – The bytes sent. See MDN: RTCIceCandidatePairStats/bytesSent.

• bytes_received (int, optional) – The bytes received. See MDN: RTCIceCandidatePairStats/bytesReceived.

• last_packet_sent_timestamp (float, optional) – When the last packet was sent, in milliseconds since the epoch. See MDN: RTCIceCandidatePairStats/lastPacketSentTimestamp.

• last_packet_received_timestamp (float, optional) – When the last packet was received, in milliseconds since the epoch. See MDN: RTCIceCandidatePairStats/lastPacketReceivedTimestamp.

• total_round_trip_time (float, optional) – The total seconds of the round trip times of STUN requests. See MDN: RTCIceCandidatePairStats/totalRoundTripTime.

• current_round_trip_time (float, optional) – The last round trip time of STUN requests, in seconds. See MDN: RTCIceCandidatePairStats/currentRoundTripTime.

• available_outgoing_bitrate (float, optional) – The estimated outgoing bitrate available, in bits per second. See MDN: RTCIceCandidatePairStats/availableOutgoingBitrate.

• available_incoming_bitrate (float, optional) – The estimated incoming bitrate available, in bits per second. See MDN: RTCIceCandidatePairStats/availableIncomingBitrate.

• requests_received (int, optional) – The connectivity check requests received. See MDN: RTCIceCandidatePairStats/requestsReceived.

• requests_sent (int, optional) – The connectivity check requests sent. See MDN: RTCIceCandidatePairStats/requestsSent.

• responses_received (int, optional) – The connectivity check responses received. See MDN: RTCIceCandidatePairStats/responsesReceived.

• responses_sent (int, optional) – The connectivity check responses sent. See MDN: RTCIceCandidatePairStats/responsesSent.

• consent_requests_sent (int, optional) – The consent requests sent. See MDN: RTCIceCandidatePairStats/consentRequestsSent.

• packets_discarded_on_send (int, optional) – The packets that failed to be sent. See MDN: RTCIceCandidatePairStats/packetsDiscardedOnSend.

• bytes_discarded_on_send (int, optional) – The bytes that failed to be sent. See MDN: RTCIceCandidatePairStats/bytesDiscardedOnSend.

class webrtc.models.rtc_stats.RTCCertificateStats(**members)

Stats of a certificate, of type 'certificate'.

It has the members of webrtc.RTCStats too.

See MDN: RTCCertificateStats.

Parameters:

• fingerprint (str) – The fingerprint of the certificate. See MDN: RTCCertificateStats/fingerprint.

• fingerprint_algorithm (str) – The hash function of the fingerprint, like 'sha-256'. See MDN: RTCCertificateStats/fingerprintAlgorithm.

• base64_certificate (str) – The DER of the certificate, in base64. See MDN: RTCCertificateStats/base64Certificate.

• issuer_certificate_id (str, optional) – The id of the stats of the issuer certificate. See MDN: RTCCertificateStats/issuerCertificateId.

class webrtc.models.rtc_stats.RTCStatsReport(stats)

The stats of a connection, a sender or a receiver, as a read-only mapping of stats ids to stats.

Each value is the dictionary of its type, like webrtc.RTCInboundRtpStreamStats for 'inbound-rtp'. The track_identifier of inbound RTP stats is the webrtc.MediaStreamTrack.id of the remote track, and the address of a candidate is None when it isn’t exposed, like for peer-reflexive ones.

See MDN: RTCStatsReport.

Parameters:

stats (dict of str to webrtc.RTCStats) – The stats, by their ids.