クライアントの観測可能性：iOS

Vonage Video SDKは、ほとんどのユースケースで推奨される高レベルの統計APIを通じて、詳細なストリーム品質メトリクスを公開します。このAPIは、音声、ビデオ、ネットワーク、および送信者側の統計を、ピア接続の遷移をまたいで安定したまま、統一されたセッション認識形式で提供します。高度なデバッグのために、SDKは未処理のピア接続データを反映する生のWebRTC統計レポートへのアクセスも提供します。

音声・ビデオ統計API

Vonage Video iOS SDKは、パブリッシャーとサブスクライバーの両方に対して、オーディオとビデオのネットワーク統計を定期的に送信します。これらには、パケット数、ビットレート、フレームレートデータ、一時停止/フリーズメトリクス、コーデック情報、およびオプションの送信側ネットワーク推定が含まれます。

統計は以下の方法で配信される：

OTPublisherKitNetworkStatsDelegate - パブリッシャー側の統計
OTSubscriberKitNetworkStatsDelegate - 加入者側の統計

それを受け取るには、パブリッシャーかサブスクライバーで適切なデリゲートを有効にしてください。

パブリッシャー向け統計の有効化

OTPublisherKitNetworkStatsDelegate を採用したクラスをアタッチします：

@interface MyViewController () <OTPublisherKitDelegate, OTPublisherKitNetworkStatsDelegate>
@end

OTPublisher *publisher = [[OTPublisher alloc] initWithDelegate:self
                                                      settings:settings];
publisher.networkStatsDelegate = self;

コールバックを実装する：

- (void)publisher:(OTPublisherKit *)publisher
videoNetworkStatsUpdated:(NSArray<OTPublisherKitVideoNetworkStats *> *)statsArray {

    OTPublisherKitVideoNetworkStats *stats = statsArray.firstObject;
    if (!stats) return;

    // For routed sessions, the first element is sufficient.
    // For relayed sessions, iterate all elements if you want per-subscriber stats.
    NSString *connectionId = stats.connectionId ?: @"<none>";
    NSString *subscriberId = stats.subscriberId ?: @"<none>";

    NSLog(@"Publisher Video Stats for connectionId: %@, subscriberId: %@", connectionId, subscriberId);
    NSLog(@"Video bytes sent: %lld", stats.videoBytesSent);
    NSLog(@"Video packets sent: %lld", stats.videoPacketsSent);
    NSLog(@"Video packets lost: %lld", stats.videoPacketsLost);
    NSLog(@"Stats timestamp: %f ms", stats.timestamp);

    for (OTPublisherKitVideoLayerStats *layer in stats.videoLayers) {
        NSLog(@"Layer: %dx%d", layer.width, layer.height);
        NSLog(@"  Encoded FPS: %f", layer.encodedFrameRate);
        NSLog(@"  Bitrate: %lld bps", layer.bitrate);
        NSLog(@"  Total bitrate (incl. RTP overhead): %lld bps", layer.totalBitrate);
        NSLog(@"  Codec: %@", layer.codec ?: @"unknown");
        NSLog(@"  Scalability mode: %@", layer.scalabilityMode ?: @"none");
        NSLog(@"  Quality limitation: %@", @(layer.qualityLimitationReason));
    }

    if (stats.transport) {
        NSLog(@"Estimated uplink bandwidth: %lld bps", stats.transport.connectionEstimatedBandwidth);
    }
}

- (void)publisher:(OTPublisherKit *)publisher
audioNetworkStatsUpdated:(NSArray<OTPublisherKitAudioNetworkStats *> *)statsArray {

    OTPublisherKitAudioNetworkStats *stats = statsArray.firstObject;
    if (!stats) return;

    // For routed sessions, the first element is sufficient.
    // For relayed sessions, iterate all elements if you want per-subscriber stats.
    NSString *connectionId = stats.connectionId ?: @"<none>";
    NSString *subscriberId = stats.subscriberId ?: @"<none>";

    NSLog(@"Publisher Audio Stats for connectionId: %@, subscriberId: %@", connectionId, subscriberId);
    NSLog(@"Audio bytes sent: %lld", stats.audioBytesSent);
    NSLog(@"Audio packets sent: %lld", stats.audioPacketsSent);
    NSLog(@"Audio packets lost: %lld", stats.audioPacketsLost);
    NSLog(@"Stats timestamp: %f ms", stats.timestamp);
    
    if (stats.transport) {
        NSLog(@"Estimated uplink bandwidth: %lld bps", stats.transport.connectionEstimatedBandwidth);
    }
}

ルーティングされたセッション( ビデオ・メディア・ルーター), の統計情報を定義する1つのオブジェクトが含まれます。の統計情報を定義します。中継セッションの場合、stats 配列には公開ストリームの加入者ごとのオブジェクトが含まれます。オブジェクトが含まれます。

パブリッシャーでのビデオ品質イベントの受信

ビデオ画質のイベントにも興味がある場合は、このコールバックを実装してください：

- (void)publisher:(OTPublisherKit *)publisher
videoQualityChanged:(OTPublisherKitVideoNetworkStats *)stats
           reason:(OTPublisherVideoEventReason)reason {

    NSLog(@"Publisher video quality event: %ld", (long)reason);
}

購読者の統計を有効にする

を採用するクラスを付ける。 OTSubscriberKitNetworkStatsDelegate:

@interface MyViewController () <OTSubscriberKitDelegate, OTSubscriberKitNetworkStatsDelegate>
@end

OTSubscriber *subscriber = [[OTSubscriber alloc] initWithStream:stream
                                                       delegate:self];
subscriber.networkStatsDelegate = self;
[session subscribe:subscriber error:nil];

コールバックを実装する：

- (void)subscriber:(OTSubscriberKit *)subscriber
videoNetworkStatsUpdated:(OTSubscriberKitVideoNetworkStats *)stats {
    NSLog(@"Video bytes received: %llu", stats.videoBytesReceived);
}

- (void)subscriber:(OTSubscriberKit *)subscriber
audioNetworkStatsUpdated:(OTSubscriberKitAudioNetworkStats *)stats {
    NSLog(@"Audio packets received: %llu", stats.audioPacketsReceived);
}

加入者のビデオ品質イベントの受信

さらに、加入者のビデオ品質が変更されたイベントを処理する：

- (void)subscriber:(OTSubscriberKit *)subscriber
videoQualityChanged:(OTSubscriberKitVideoNetworkStats *)stats
            reason:(OTSubscriberVideoEventReason)reason {

    NSLog(@"Subscriber video quality event: %ld", (long)reason);
}

統計データ構造

このセクションでは、iOS オーディオ/ビデオ統計 API が提供する構造体とプロパティの概要を説明します。すべての Video SDK プラットフォームが同じ統計情報セットを公開していますが、各プラットフォームで個々のフィールドの構造や名前の付け方に若干の違いがある場合があります。これらの違いは、基本的なメトリクスの違いではなく、プラットフォーム固有の SDK の設計規約を反映しています。

`OTTransportStats`

共有トランスポートレベルの推定を表す。

connectionEstimatedBandwidth - 推定利用可能アップリンク接続帯域幅（bps）。

`OTPublisherKitVideoNetworkStats`

パブリッシャーのビデオトラックに関する統計を提供します。これには以下が含まれます：

connectionId - リレーセッションの場合、ストリームを購読しているクライアントのコネクションID。ルーティングされたセッションでは未定義。
subscriberId - リレーセッションの場合、ストリームを購読するクライアントの購読ID。ルーティングされたセッションでは未定義。
videoPacketsLost - 失われたビデオパケットの推定値。
videoPacketsSent - ビデオパケットの送信。
videoBytesSent - ビデオバイトが送信された。
timestamp - 統計情報が収集されたミリ秒単位のUnixタイムスタンプ。
startTime - Unixエポックからのミリ秒単位のタイムスタンプ。
videoLayers - ビデオレイヤーの統計情報の配列 ( OTPublisherKitVideoLayerStats).
transport - トランポート・レベルのネットワーク統計。

`OTPublisherKitAudioNetworkStats`

パブリッシャーのオーディオトラックに関する統計を提供します。以下を含みます：

connectionId - リレーセッションの場合、ストリームを購読しているクライアントのコネクションID。ルーティングされたセッションでは未定義。
subscriberId - リレーセッションの場合、ストリームを購読するクライアントの購読ID。ルーティングされたセッションでは未定義。
audioPacketsLost - 失われたパケットの推定値。
audioPacketsSent - オーディオパケットを送信。
audioBytesSent - 送信されたオーディオ・バイト。
timestamp - ミリ秒単位のUnixタイムスタンプ。
startTime - Unixエポックからのミリ秒単位のタイムスタンプ。
transport - トランポート・レベルのネットワーク統計。

`OTPublisherKitVideoLayerStats`

1つのサイマルキャスト・レイヤーまたはSVCレイヤーを表す。

width - エンコードされたフレーム幅。
height - エンコードされたフレームの高さ。
encodedFrameRate - エンコードされた1秒あたりのフレーム数。
bitrate - レイヤーのビットレート（bps）。
totalBitrate - RTPオーバーヘッドを含むレイヤービットレート（bps）。
scalabilityMode - SVC/スケーラビリティ記述子（例えば "L3T3"）。
qualityLimitationReason - 品質制限の理由（帯域幅、CPU、コーデック、解像度、レイヤーの変更）。
codec - このビデオレイヤーが使用するコーデック。

`OTSenderStats`

送信側の推定メトリクス（オーディオとビデオの両方に反映される）。

connectionMaxAllocatedBitrate - 送信側接続で推定される最大ビットレート。
connectionEstimatedBandwidth - 現在の推定帯域幅（bps）。

`OTSubscriberKitVideoNetworkStats`

加入者のビデオトラックに関する統計情報を提供します。これには以下が含まれます：

videoPacketsLost - 失われたビデオパケットの推定値。
videoPacketsReceived - ビデオパケットを受信。
videoBytesReceived - 受信したビデオバイト。
timestamp - 統計情報が収集されたミリ秒単位のUnixタイムスタンプ。
senderStats - 送信側のメトリクス（オプション）。
width - デコードされたフレーム幅（ピクセル）。
height - デコードされたフレームの高さ（ピクセル）。
decodedFrameRate - デコードされたフレーム/秒。
bitrate - ビデオ・ビットレート（bps）。
totalBitrate - RTPオーバーヘッドを含むビットレート（bps）。
pauseCount - ポーズ（最後のフレームから5秒以上）の数。意図的な無効化とオーディオフォールバックの場合を含む。
totalPausesDuration - 全休止時間（ms）。
freezeCount - フリーズカウント（WebRTC定義のフリーズイベント）。
totalFreezesDuration - 合計フリーズ時間（ms）。
codec - 現在のデコーダーコーデック。

`OTSubscriberKitAudioNetworkStats`

加入者のオーディオトラックに関する統計情報を提供します。これには以下が含まれます：

audioPacketsLost - 失われたパケットの推定値。
audioPacketsReceived - パケットを受信した。
audioBytesReceived - 受信したバイト数。
timestamp - ミリ秒単位のUnixタイムスタンプ。
senderStats - 送信側のメトリクス（オプション）。

送信側統計

参照送信側統計の概要.

送信側統計の有効化

送信者側の統計情報は、購読者が受け取る。送信者側の統計を受け取るには、ストリームのパブリッシャーで senderStatsTrack プロパティ true のために OTPublisherKitSettings オブジェクトはパブリッシャーの作成に使われました。

OTPublisherKitSettings *settings = [[OTPublisherKitSettings alloc] init];
settings.senderStatsTrack = YES;

OTPublisher *publisher = [[OTPublisher alloc] initWithDelegate:self
                                                      settings:settings];

もし senderStatsTrack が有効でない場合、このパブリッシャーに対して送信者統計チャンネルは発行されません。デフォルト値は NO.

送信側統計の購読

ストリームのパブリッシャーが送信者側の統計を有効にしている場合、リスナーがビデオまたはオーディオの統計に登録されると、上記のように、購読者は自動的に統計を受信し始めます。

ビデオ統計用のデリゲート・メソッドを実装する：

- (void)subscriber:(OTSubscriberKit *)subscriber
videoNetworkStatsUpdated:(OTSubscriberKitVideoNetworkStats *)stats
{
    // The property may be nil if no sender statistics have been received yet.
    if (stats.senderStats) {
        OTSenderStats *sender = stats.senderStats;
        NSLog(@"Connection max allocated bitrate: %lld bps", (long long)sender.connectionMaxAllocatedBitrate);
        NSLog(@"Connection current estimated bandwidth: %lld bps", (long long)sender.connectionEstimatedBandwidth);
    } else {
        NSLog(@"Sender-side stats not available yet.");
    }
}

同様に -subscriber:audioNetworkStatsUpdated: を含む。 senderStats 財産である。

統計イベントの受信

送信側の統計は OTSubscriberKitNetworkStatsDelegate 上に示したように、ビデオとオーディオのコールバック。その OTSenderStatsとして含まれている。 senderStats 両方のメンバー OTSubscriberKitVideoNetworkStats そして OTSubscriberKitAudioNetworkStatsの2つのプロパティを提供する：

connectionMaxAllocatedBitrate - 接続時に推定可能な最大ビットレート
connectionEstimatedBandwidth - 接続の現在の推定帯域幅

これらの2つのメトリクスは、オーディオ・ビデオ・バンドルごとに計算されるため、ビデオとオーディオの両方の統計に同じ値が表示されます。個々のトラックではなくトランスポートを反映するため、メトリクスはオーディオとビデオの両方で共有されます。

RTC統計レポート

パブリッシャーの低レベルのピア接続統計を取得するには [OTPublisherKit getRtcStatsReport:] メソッドを使用します。これはメディアストリームのRTC統計レポートを提供する。

これは非同期操作である。を設定する。 >[OTPublisherKit rtcStatsReportDelegate]> プロパティを実装し >[OTPublisherKitRtcStatsReportDelegate publisher:rtcStatsReport:]> メソッドを呼び出す前に [OTPublisherKit getRtcStatsReport:].

統計が利用可能な場合、実装の >[OTPublisherKitRtcStatsReportDelegate publisher:rtcStatsReport:]> メッセージが送信される。メッセージには OTPublisherRtcStats オブジェクトが含まれる。 jsonArrayOfReports 財産である。

これはRTC統計レポートのJSON配列で、ウェブブラウザで実装されているRtcStatsReportオブジェクトのフォーマットに似ている( Mozillaのドキュメント).

加入者の低レベルのピア接続統計を取得するには [OTSubscriberKit getRtcStatsReport:] メソッドを使用します。これはメディアストリームのRTC統計レポートを提供する。

これは非同期操作である。を設定する。 [OTSubscriberKit rtcStatsReportDelegate]> プロパティを実装し >[OTSubscriberKitRtcStatsReportDelegate subscriber:rtcStatsReport:]> メソッドを呼び出す前に [OTSubscriberKit getRtcStatsReport:].

統計が利用可能な場合、実装の >[OTSubscriberKitRtcStatsReportDelegate subscriber:rtcStatsReport:]> メッセージが送信される。メッセージには jsonArrayOfReports パラメータが必要だ。

これはRTC統計レポートのJSON配列で、ウェブブラウザで実装されているRtcStatsReportオブジェクトのフォーマットに似ている( Mozillaのドキュメント).

こちらも参照このW3Cドキュメント.

サンプル

について Vonage Video iOS SDK Client Observability サンプルアプリは、iOS Client SDKでビルドされたモバイルアプリで、クライアントの観測可能な機能を実証しています。

ナビゲーション

クライアントの観測可能性：iOS

音声・ビデオ統計API

パブリッシャー向け統計の有効化

パブリッシャーでのビデオ品質イベントの受信

購読者の統計を有効にする

加入者のビデオ品質イベントの受信

統計データ構造

OTTransportStats

OTPublisherKitVideoNetworkStats

OTPublisherKitAudioNetworkStats

OTPublisherKitVideoLayerStats

OTSenderStats

OTSubscriberKitVideoNetworkStats

OTSubscriberKitAudioNetworkStats