Observabilidad del cliente: Android

El SDK de video de Vonage expone métricas detalladas de la calidad de la transmisión a través de una API de estadísticas de alto nivel, recomendada para la mayoría de los casos de uso, que proporciona estadísticas de audio, video, red y del lado del emisor en una forma unificada y consciente de la sesión que permanece estable a través de las transiciones de conexión entre pares. Para la depuración avanzada, el SDK también ofrece acceso al informe de estadísticas WebRTC sin procesar, que refleja los datos de la conexión entre pares sin procesar.

El SDK también expone métricas del estado de la red que proporcionan una evaluación de alto nivel del estado de la conexión tanto para editores como para abonados. Estas métricas incluyen una puntuación del estado de la red, el motivo de dicha puntuación y, para los abonados, una fuente de degradación que indica qué lado de la conexión es responsable de cualquier problema observado. Véase Estado de la red y fuente de degradación para más detalles.

API de estadísticas de audio, vídeo y enlaces multimedia

El SDK para Android de Vonage Video envía estadísticas periódicas de audio, video y enlaces multimedia tanto para editores como para suscriptores. Estas incluyen recuentos de paquetes, tasas de bits, datos de velocidad de fotogramas, métricas de pausa/congelación, información de códec y métricas de red a nivel de transporte, como estimación de ancho de banda y puntuación del estado de la red.

Las estadísticas se transmiten a través de oyentes independientes:

Editorial:

  • PublisherKit.VideoStatsListener - estadísticas de vídeo y eventos de calidad de vídeo
  • PublisherKit.AudioStatsListener - estadísticas de audio
  • PublisherKit.MediaLinkStatsListener - estadísticas de enlace de medios (nivel de transporte)

Abonado:

  • SubscriberKit.VideoStatsListener - estadísticas de vídeo y eventos de calidad de vídeo
  • SubscriberKit.AudioStatsListener - estadísticas de audio
  • SubscriberKit.MediaLinkStatsListener - estadísticas de enlace de medios (nivel de transporte)

Estadísticas para editores

Estadísticas en vídeo

publisher.setVideoStatsListener(new PublisherKit.VideoStatsListener() {
    @Override
    public void onVideoStats(PublisherKit publisher, PublisherKit.PublisherVideoStats[] statsArray) {
        if (statsArray != null && statsArray.length > 0) {
            // For routed sessions, first element is sufficient.
            // For relayed sessions, iterate all statsArray elements to get per-subscriber info.
            PublisherKit.PublisherVideoStats stats = statsArray[0];

            String connectionId = (stats.connectionId != null && !stats.connectionId.isEmpty())
                    ? stats.connectionId
                    : "<none>";
            String subscriberId = (stats.subscriberId != null && !stats.subscriberId.isEmpty())
                    ? stats.subscriberId
                    : "<none>";

            Log.d("VideoStats", "Publisher Video Stats for connectionId: " + connectionId
                    + ", subscriberId: " + subscriberId);

            Log.d("VideoStats", "Video bytes sent: " + stats.videoBytesSent);
            Log.d("VideoStats", "Video packets sent: " + stats.videoPacketsSent);
            Log.d("VideoStats", "Video packets lost: " + stats.videoPacketsLost);
            Log.d("VideoStats", "Stats timestamp: " + stats.timeStamp + " ms");

            if (stats.videoLayers != null) {
                for (PublisherKit.VideoLayerStats layer : stats.videoLayers) {
                    Log.d("VideoStats", "Layer: " + layer.width + "x" + layer.height);
                    Log.d("VideoStats", "  Encoded FPS: " + layer.encodedFrameRate);
                    Log.d("VideoStats", "  Bitrate: " + layer.bitrate + " bps");
                    Log.d("VideoStats", "  Total bitrate (incl. RTP overhead): " + layer.totalBitrate + " bps");
                    Log.d("VideoStats", "  Codec: " + (layer.codec != null ? layer.codec : "unknown"));
                    Log.d("VideoStats", "  Scalability mode: " + (layer.scalabilityMode != null ? layer.scalabilityMode : "none"));
                    Log.d("VideoStats", "  Quality limitation: " + layer.qualityLimitationReason);
                }
            }
        }
    }

    @Override
    public void onVideoQualityChanged(PublisherKit publisher, PublisherKit.PublisherVideoStats stats, String reason) {
        Log.d("Stats", "Publisher video quality event: " + reason);
    }
});

Estadísticas de audio

publisher.setAudioStatsListener(new PublisherKit.AudioStatsListener() {
    @Override
    public void onAudioStats(PublisherKit publisher, PublisherKit.PublisherAudioStats[] statsArray) {
        if (statsArray != null && statsArray.length > 0) {
            // For routed sessions, first element is sufficient.
            // For relayed sessions, iterate all statsArray elements to get per-subscriber info.
            PublisherKit.PublisherAudioStats stats = statsArray[0];

            String connectionId = (stats.connectionId != null && !stats.connectionId.isEmpty())
                    ? stats.connectionId
                    : "<none>";
            String subscriberId = (stats.subscriberId != null && !stats.subscriberId.isEmpty())
                    ? stats.subscriberId
                    : "<none>";

            Log.d("AudioStats", "Publisher Audio Stats for connectionId: " + connectionId
                    + ", subscriberId: " + subscriberId);

            Log.d("AudioStats", "Audio bytes sent: " + stats.audioBytesSent);
            Log.d("AudioStats", "Audio packets sent: " + stats.audioPacketsSent);
            Log.d("AudioStats", "Audio packets lost: " + stats.audioPacketsLost);
            Log.d("AudioStats", "Stats timestamp: " + stats.timeStamp + " ms");
        }
    }
});

Estadísticas de enlaces multimedia

publisher.setMediaLinkStatsListener(new PublisherKit.MediaLinkStatsListener() {
    @Override
    public void onMediaLinkStats(PublisherKit publisher, PublisherKit.PublisherMediaLinkStats[] mediaLinkStats) {
        if (mediaLinkStats != null && mediaLinkStats.length > 0) {
            PublisherKit.PublisherMediaLinkStats stats = mediaLinkStats[0];
            if (stats.transport != null) {
                Log.d("MediaLinkStats", "Uplink bandwidth: " + stats.transport.getConnectionEstimatedBandwidth() + " bps");
                Log.d("MediaLinkStats", "Network condition: " + stats.transport.networkCondition);
                Log.d("MediaLinkStats", "Condition reason: " + stats.transport.networkConditionReason);
            }
        }
    }

    @Override
    public void onNetworkConditionChanged(PublisherKit publisher, PublisherKit.PublisherMediaLinkStats mediaLinkStats, String reason) {
        if (mediaLinkStats.transport != null) {
            Log.d("Stats", "Publisher network condition: " + mediaLinkStats.transport.networkCondition);
            Log.d("Stats", "Reason: " + mediaLinkStats.transport.networkConditionReason);
        }
    }
});

Véase Estado de la red y fuente de degradación para más detalles sobre la interpretación de las puntuaciones y razones del estado de la red.

Para un editor en una sesión enrutada (que utiliza la función Router multimedia de vídeo de Vonage), la matriz de estadísticas incluye un objeto, que define las estadísticas para el flujo de medios de audio o video único que se envía al enrutador de medios de video de Vonage. En una sesión retransmitida, la matriz de estadísticas incluye un objeto para cada suscriptor del flujo publicado. la transmisión publicada.

Activación de estadísticas para abonados

Estadísticas en vídeo

subscriber.setVideoStatsListener(new SubscriberKit.VideoStatsListener() {
    @Override
    public void onVideoStats(SubscriberKit subscriber, SubscriberKit.SubscriberVideoStats stats) {
        Log.d("Stats", "Video bytes received: " + stats.videoBytesReceived);
    }

    @Override
    public void onVideoQualityChanged(SubscriberKit subscriber, SubscriberKit.SubscriberVideoStats stats, String reason) {
        Log.d("Stats", "Subscriber video quality event: " + reason);
    }
});

Estadísticas de audio

subscriber.setAudioStatsListener(new SubscriberKit.AudioStatsListener() {
    @Override
    public void onAudioStats(SubscriberKit subscriber, SubscriberKit.SubscriberAudioStats stats) {
        Log.d("Stats", "Audio packets received: " + stats.audioPacketsReceived);
    }
});

Estadísticas de enlaces multimedia

subscriber.setMediaLinkStatsListener(new SubscriberKit.MediaLinkStatsListener() {
    @Override
    public void onMediaLinkStats(SubscriberKit subscriber, SubscriberKit.SubscriberMediaLinkStats mediaLinkStats) {
        if (mediaLinkStats.transport != null) {
            Log.d("MediaLinkStats", "Downlink bandwidth: " + mediaLinkStats.transport.getConnectionEstimatedBandwidth() + " bps");
        }
        if (mediaLinkStats.remotePublisherTransport != null) {
            Log.d("MediaLinkStats", "Remote publisher uplink bandwidth: " + mediaLinkStats.remotePublisherTransport.getConnectionEstimatedBandwidth() + " bps");
        }
        Log.d("MediaLinkStats", "Degradation source: " + mediaLinkStats.networkDegradationSource);
    }

    @Override
    public void onNetworkConditionChanged(SubscriberKit subscriber, SubscriberKit.SubscriberMediaLinkStats mediaLinkStats, String reason) {
        if (mediaLinkStats.transport != null) {
            Log.d("Stats", "Local network condition: " + mediaLinkStats.transport.networkCondition);
        }
        if (mediaLinkStats.remotePublisherTransport != null) {
            Log.d("Stats", "Remote publisher network condition: " + mediaLinkStats.remotePublisherTransport.networkCondition);
        }
        Log.d("Stats", "Degradation source: " + mediaLinkStats.networkDegradationSource);
    }
});

Véase Estado de la red y fuente de degradación para más detalles sobre la interpretación de las puntuaciones y razones del estado de la red.

Estructuras de datos estadísticos

Esta sección describe las estructuras y propiedades proporcionadas por la API de estadísticas de audio y vídeo de Android. Aunque todas las plataformas Video SDK exponen el mismo conjunto de estadísticas, puede haber pequeñas diferencias en la forma en que cada plataforma estructura o nombra los campos individuales. Estas variaciones reflejan convenciones de diseño del SDK específicas de cada plataforma más que diferencias en las métricas subyacentes.

Para una explicación independiente de la plataforma de las estadísticas disponibles y lo que representan, consulte visión general de la observabilidad del cliente.

TransportStats

Representa métricas compartidas a nivel de transporte.

  • connectionEstimatedBandwidth - Ancho de banda de conexión disponible estimado (bps).
  • networkCondition - Puntuación del estado actual de la red (NETWORK_CONDITION_UNKNOWN, NETWORK_CONDITION_CRITICAL, NETWORK_CONDITION_WARNING, NETWORK_CONDITION_FAIR, NETWORK_CONDITION_GOODo NETWORK_CONDITION_EXCELLENT).
  • networkConditionReason - Razón principal que afecta al estado de la red (NETWORK_CONDITION_REASON_NONE, NETWORK_CONDITION_REASON_UNKNOWN, NETWORK_CONDITION_REASON_BANDWIDTHo NETWORK_CONDITION_REASON_PACKET_LOSS).

PublisherKit.PublisherVideoStats

Proporciona estadísticas sobre la pista de vídeo de un editor. Incluye:

  • connectionId - En una sesión retransmitida, el identificador de conexión del cliente que se suscribe al flujo. No definido en una sesión enrutada.
  • subscriberId - En una sesión retransmitida, el ID suscrito del cliente que se suscribe al flujo. No definido en una sesión enrutada.
  • videoPacketsLost - Estimación de paquetes de vídeo perdidos.
  • videoPacketsSent - Paquetes de vídeo enviados.
  • videoBytesSent - Bytes de vídeo enviados.
  • timeStamp - Marca de tiempo Unix en milisegundos cuando se recopilaron las estadísticas.
  • startTime - La marca de tiempo, en milisegundos desde la época Unix, a partir de la cual comenzaron a acumularse los totales acumulados.
  • videoLayers - La matriz de estadísticas de la capa de vídeo (véase OTPublisherKitVideoLayerStats).

PublisherKit.PublisherAudioStats

Proporciona estadísticas sobre la pista de audio de un editor. Incluye:

  • connectionId - En una sesión retransmitida, el identificador de conexión del cliente que se suscribe al flujo. No definido en una sesión enrutada.
  • subscriberId - En una sesión retransmitida, el ID suscrito del cliente que se suscribe al flujo. No definido en una sesión enrutada.
  • audioPacketsLost - Estimación de paquetes perdidos.
  • audioPacketsSent - Paquetes de audio enviados.
  • audioBytesSent - Bytes de audio enviados.
  • timeStamp - Marca de tiempo Unix en milisegundos.
  • startTime - La marca de tiempo, en milisegundos desde la época Unix, a partir de la cual comenzaron a acumularse los totales acumulados.

PublisherKit.VideoLayerStats

Representa una capa de emisión simultánea o capa SVC.

  • width - Anchura de trama codificada.
  • height - Altura del fotograma codificado.
  • encodedFrameRate - Fotogramas codificados por segundo.
  • bitrate - Velocidad de bits de capa (bps).
  • totalBitrate - Tasa de bits de capa, incluida la sobrecarga RTP (bps).
  • scalabilityMode - Descriptor SVC/escalabilidad (por ejemplo, "L3T3").
  • qualityLimitationReason - Motivo de la limitación de calidad (ancho de banda, CPU, códec, resolución o cambio de capa).
  • codec - El códec utilizado por esta capa de vídeo.

SubscriberKit.SenderStats

Métricas de estimación del lado del emisor (reflejadas tanto en audio como en vídeo).

  • connectionMaxAllocatedBitrate - Tasa de bits máxima estimada para la conexión del remitente.
  • connectionEstimatedBandwidth - Estimación del ancho de banda actual (bps).

SubscriberKit.SubscriberVideoStats

Proporciona estadísticas sobre la pista de vídeo de un abonado. Incluye:

  • videoPacketsLost - Estimación de paquetes de vídeo perdidos.
  • videoPacketsReceived - Paquetes de vídeo recibidos.
  • videoBytesReceived - Bytes de vídeo recibidos.
  • timeStamp - Marca de tiempo Unix en milisegundos cuando se recopilaron las estadísticas.
  • senderStats - Métricas del lado del remitente (opcional).
  • width - Anchura del fotograma descodificado en píxeles.
  • height - Altura del fotograma descodificado en píxeles.
  • decodedFrameRate - Fotogramas decodificados por segundo.
  • bitrate - Velocidad de bits de vídeo (bps).
  • totalBitrate - Bitrate incluyendo la sobrecarga RTP (bps).
  • pauseCount - Numbers de pausas (>5s desde el último fotograma). Incluye desactivaciones intencionadas y casos de audio-fallback.
  • totalPausesDuration - Duración total de la pausa (ms).
  • freezeCount - Recuento de congelaciones (evento de congelación definido por WebRTC).
  • totalFreezesDuration - Duración total de la congelación (ms).
  • codec - Códec decodificador actual.

SubscriberKit.SubscriberAudioStats

Proporciona estadísticas sobre la pista de audio de un abonado. Incluye:

  • audioPacketsLost - Estimación de paquetes perdidos.
  • audioPacketsReceived - Paquetes recibidos.
  • audioBytesReceived - Bytes recibidos.
  • timeStamp - Marca de tiempo Unix en milisegundos.
  • senderStats - Métricas del lado del remitente (opcional).

PublisherKit.PublisherMediaLinkStats

Proporciona estadísticas a nivel de transporte para la conexión de un editor.

  • transport - Estadísticas de transporte de este editor (véase TransportStats)

SubscriberKit.SubscriberMediaLinkStats

Proporciona estadísticas a nivel de transporte para las conexiones de un abonado, incluida la visibilidad del rendimiento de la red del editor remoto. Esto permite a las aplicaciones diagnosticar si los problemas de conexión se originan en el enlace descendente del abonado o en el enlace ascendente del editor.

  • transport - Estadísticas de transporte local y de red para este abonado. Puede estar limitado si las estadísticas del lado del emisor y/o el audio fallback están desactivados.
  • remotePublisherTransport - Estadísticas de transporte y red del editor remoto. Puede estar limitado si las estadísticas del lado del emisor y/o el audio fallback están desactivados.
  • networkDegradationSource - Indica la fuente de degradación de la red, si la hay (NetworkDegradationSource.NONE, NetworkDegradationSource.LOCAL, NetworkDegradationSource.REMOTEo NetworkDegradationSource.BOTH_OR_UNCLEAR).

Estadísticas del remitente

Véase el estadísticas del lado del remitente.

Activación de las estadísticas del lado del remitente

Las estadísticas del lado del emisor se reciben en los abonados. Para recibir las estadísticas del lado del emisor, habilítelas para el editor del flujo estableciendo el parámetro senderStatisticsTrack propiedad a true al construir el editor:

Publisher publisher = new Publisher.Builder(context)
        .senderStatsTrack(true) // Enable sender-side stats
        .build();

Si senderStatsTrack no está activado, no se publicará ningún canal de estadísticas del remitente para este editor. El valor por defecto es false.

Recepción de estadísticas del lado del remitente

Si el editor ha activado las estadísticas del lado del remitente, los abonados las recibirán automáticamente a través de las devoluciones de llamada de las estadísticas de vídeo y audio descrito anteriormente. En senderStats propiedad en ambos SubscriberKit.SubscriberVideoStats y SubscriberKit.SubscriberAudioStats proporciona dos métricas:

  • connectionMaxAllocatedBitrate - El bitrate máximo que puede estimarse para la conexión
  • connectionEstimatedBandwidth - El ancho de banda estimado actual para la conexión

Estas métricas se calculan por paquete de audio y vídeo, por lo que aparecen los mismos valores en las estadísticas de vídeo y audio.

subscriber.setVideoStatsListener((subscriber, stats) -> {
    if (stats.senderStats != null) {
        Log.d(TAG, "Connection max allocated bitrate: " + stats.senderStats.connectionMaxAllocatedBitrate);
        Log.d(TAG, "Connection current estimated bandwidth: " + stats.senderStats.connectionEstimatedBandwidth);
    }
});

Estado de la red y fuente de degradación

El SDK proporciona métricas del estado de la red en tiempo real tanto para editores como para suscriptores, incluyendo una puntuación del estado, la razón que impulsa esa puntuación y una fuente de degradación para los suscriptores. Para obtener una explicación completa del modelo de estado de la red, las puntuaciones, los motivos y cómo activarlo, consulte la página visión general de la observabilidad del cliente.

Los datos sobre el estado de la red están disponibles a través de dos canales:

  • Estadísticas periódicas: Los eventos de estadísticas de enlaces multimedia incluyen métricas de transporte con networkCondition y networkConditionReason. Para los abonados, las estadísticas de los enlaces multimedia también incluyen remotePublisherTransport y networkDegradationSource.
  • Eventos de cambio de estado de la red: Devoluciones de llamada dedicadas en ambos editor y abonado se activan cuando se detecta un cambio significativo en el estado de la red.

El siguiente ejemplo muestra cómo utilizar los datos de estado de la red del abonado para identificar la fuente de degradación:

@Override
public void onNetworkConditionChanged(SubscriberKit subscriber, SubscriberKit.SubscriberMediaLinkStats mediaLinkStats, String reason) {

    int localCondition = mediaLinkStats.transport != null ? mediaLinkStats.transport.networkCondition : TransportStats.NETWORK_CONDITION_UNKNOWN;
    int remoteCondition = mediaLinkStats.remotePublisherTransport != null ? mediaLinkStats.remotePublisherTransport.networkCondition : TransportStats.NETWORK_CONDITION_UNKNOWN;
    int source = mediaLinkStats.networkDegradationSource;

    if (source == NetworkDegradationSource.LOCAL) {
        Log.d("Stats", "Local network is degraded (condition: " + localCondition + ")");
    } else if (source == NetworkDegradationSource.REMOTE) {
        Log.d("Stats", "Remote publisher network is degraded (condition: " + remoteCondition + ")");
    } else if (source == NetworkDegradationSource.BOTH_OR_UNCLEAR) {
        Log.d("Stats", "Degradation source unclear — local: " + localCondition + ", remote: " + remoteCondition);
    }
}

Informe de estadísticas de RTC

Para obtener estadísticas de conexión entre pares de bajo nivel para un editor, utilice la función PublisherKit.getRtcStatsReport() método. Proporciona informes de estadísticas RTC para el flujo de medios. Se trata de una operación asíncrona. Llame al método PublisherKit.setRtcStatsReportListener(PublisherKit.PublisherRtcStatsReportListener listener) y, a continuación, aplicar el método PublisherKit.PublisherRtcStatsReportListener.onRtcStatsReport(PublisherKit publisher, PublisherKit.PublisherRtcStats[] stats) antes de llamar a PublisherKit.getRtcStatsReport().

Cuando se dispone de las estadísticas, la aplicación de la función PublisherKit.PublisherRtcStatsReportListener.onRtcStatsReport(PublisherKit publisher, PublisherKit.PublisherRtcStats[] stats) se llama al método.

Una matriz de PublisherRtcStats se pasa a ese método. La dirección PublisherRtcStats incluye un objeto jsonArrayOfReports propiedad. Se trata de una matriz JSON de informes de estadísticas RTC, que son similares al formato del objeto RtcStatsReport implementado en los navegadores web (véase estos documentos de Mozilla).

Para obtener estadísticas de conexión entre pares de bajo nivel para un abonado, utilice la función SubscriberKit.getRtcStatsReport() método. Esto proporciona un informe de estadísticas RTC para el flujo de medios.

Se trata de una operación asíncrona. Llame al SubscriberKit.setRtcStatsReportListener(SubscriberKit.SubscriberRtcStatsReportListener listener) y, a continuación, aplicar el método SubscriberKit.SubscriberRtcStatsReportListener.onRtcStatsReport(SubscriberKit subscriber, java.lang.String jsonArrayOfReports) antes de llamar a SubscriberKit.getRtcStatsReport().

Cuando se dispone de las estadísticas, la aplicación de la función SubscriberKit.SubscriberRtcStatsReportListener.onRtcStatsReport(SubscriberKit subscriber, java.lang.String jsonArrayOfReports) . La dirección jsonArrayOfReports es una matriz JSON de informes de estadísticas RTC, que son similares al formato del objeto RtcStatsReport implementado en los navegadores web (véase estos documentos de Mozilla).

Véase también esta documentación del W3C.