WebRTC: Guía de migración getStats() heredada

Henrik Boström

La API heredada de WebRTC getStats() se quitará en Chrome 117, por lo que las apps que la usen deberán migrar a la API estándar. En este artículo, se explica cómo migrar tu código y qué hacer si necesitas más tiempo para realizar este cambio.

Históricamente, hubo dos versiones en competencia de la API de getStats() de WebRTC. La API heredada getStats(), que es anterior al proceso de estandarización y toma un argumento de devolución de llamada, y la API estandarizada y ampliamente admitida que muestra una promesa.

La API estándar tiene más funciones y métricas bien definidas documentadas públicamente en la especificación del W3C Identifiers for WebRTC's Statistics API. La especificación incluye descripciones de cada métrica que se menciona en esta guía y muchas más.

A partir de Chrome 117, la API heredada de getStats() arrojará una excepción en el canal de versiones estables (la excepción se lanzará de forma gradual). Sigue esta guía para facilitar la transición a la API estándar.

Tipos de estadísticas heredados frente a estándares

Para ver la lista completa de los tipos de estadísticas estándar, consulta la enumeración RTCStatsType en la especificación. Esto incluye qué definición del diccionario de estadísticas describe las métricas recopiladas para cada tipo.

Todos los objetos de estadísticas tienen un atributo id que identifica de forma única el objeto subyacente en varias llamadas a getStats(). El mismo objeto tendrá el mismo ID cada vez que se llame al método. Esto es útil para calcular la tasa de cambio de las métricas (hay un ejemplo en la siguiente sección). Los IDs también forman relaciones de referencias. Por ejemplo, el objeto de estadísticas outbound-rtp hace referencia al objeto de estadísticas media-source asociado a través del atributo outbound-rtp.mediaSourceId. Si dibujas todas las relaciones ...Id, obtienes un gráfico.

La API heredada tiene los siguientes tipos de estadísticas, que corresponden a los tipos estándar de la siguiente manera:

Asignación de métricas heredadas a métricas estándares

El objetivo de esta asignación es ayudar a los desarrolladores a encontrar qué métrica heredada corresponde a qué métrica estándar, pero ten en cuenta que la métrica correspondiente puede usar unidades diferentes o expresarse como un contador total en lugar de un valor instantáneo. Consulta la especificación para ver las definiciones de las métricas.
La API estándar prefiere exponer contadores totales en lugar de tasas. Esto significa que, para obtener la tasa correspondiente (por ejemplo, la tasa de bits) como en la API heredada, la app debe calcular la tasa promedio tomando el delta entre dos llamadas a getStats(). Por ejemplo:

// Periodically (e.g. every second or every 10 seconds)...
const currReport = await pc.getStats();
// Calculate bitrate since the last getStats() call.
// Handling of undefined is omitted for clarity.
const currOutboundRtp = currReport.values().find(s => s.type == 'outbound-rtp');
const prevOutboundRtp = prevReport.get(currOutboundRtp.id);
const deltaBits = (currOutboundRtp.bytesSent - prevOutboundRtp.bytesSent) * 8;
const deltaSeconds = (currOutboundRtp.timestamp - prevOutboundRtp.timestamp) / 1000;
logBitrateMeasurement(deltaBits / deltaSeconds);
// Remember the report for next time.
prevReport = currReport;

Tener que calcular las tarifas y los promedios por tu cuenta de esta manera puede parecer un paso adicional engorroso, pero tiene la ventaja de permitirte obtener promedios en cualquier intervalo de tiempo que desees. Llamar a la API estándar con menos frecuencia de la que podrías haber hecho con la API heredada tiene algunos beneficios de rendimiento.

La API estándar es compatible con la transmisión simultánea.

Si usas la transmisión simultánea, es posible que hayas notado que la API heredada solo informa un SSRC único, incluso cuando usas la transmisión simultánea para enviar (por ejemplo) tres transmisiones RTP a través de tres SSRC independientes.

La API estándar no comparte esta limitación y mostrará tres objetos de estadísticas outbound-rtp, uno para cada uno de los SSRC. Esto significa que puedes analizar cada flujo de RTP de forma individual, pero también significa que, para obtener la tasa de bits total de todos los flujos de envío de RTP, deberás agregarlos por tu cuenta.

Por otro lado, las transmisiones SVC o RTP con varias capas espaciales configuradas a través de la API de scalabilityMode aún aparecen como una sola outbound-rtp porque se envían a través de un solo SSRC.

Si necesitas más tiempo para la migración

Cuando se quite la API heredada en Chrome 117, usarla generará una excepción. Si no puedes migrar tu código a tiempo, la prueba de origen para la API de getStats() basada en devoluciones de llamada de RTCPeerConnection les brinda a los sitios web registrados más tiempo para migrar. Con un token de prueba de origen, la API heredada de getStats() se podrá seguir usando hasta la versión 121 de Chrome.