メディア品質の統計情報

進行中の通話のメディア品質に関する統計情報

メディア品質の統計情報は、コア Call API の拡張機能です。 まず、mediaStatsFeature API オブジェクトを取得する必要があります。

const mediaStatsFeature = call.feature(Features.MediaStats);

メディア統計データを受信するため、sampleReported イベントまたは summaryReported イベントをサブスクライブできます。

sampleReported イベントは 1 秒おきにトリガーされます。 これは UI 表示または独自のデータ パイプラインのデータ ソースとして最適です。

summaryReported イベントには、全期間のデータの集計値が含まれています。これは、概要だけが必要な場合に便利です。

summaryReported イベントの間隔を制御する場合は、型 MediaStatsCollectorOptions の mediaStatsCollectorOptions を定義する必要があります。 それ以外の場合、SDK は既定値を使用します。

const mediaStatsCollectorOptions: SDK.MediaStatsCollectorOptions = {
    aggregationInterval: 10,
    dataPointsPerAggregation: 6
};

const mediaStatsCollector = mediaStatsFeature.createCollector(mediaStatsSubscriptionOptions);

mediaStatsCollector.on('sampleReported', (sample) => {
    console.log('media stats sample', sample);
});

mediaStatsCollector.on('summaryReported', (summary) => {
    console.log('media stats summary', summary);
});

メディア統計コレクターを使用する必要がない場合は、mediaStatsCollector の dispose メソッドを呼び出すことができます。

mediaStatsCollector.dispose();

コレクターは通話の終了時に内部で再利用されるため、通話が終了するたびに mediaStatsCollector の dispose メソッドを呼び出す必要はありません。

MediaStatsCollectorOptions

MediaStatsCollectorOptions は省略可能で、MediaStatsCollectorOptions には 2 つの省略可能なフィールドがあります。

• aggregationInterval は、統計が集計される間隔 (秒単位) です。 既定値は 10 です。
• dataPointsPerAggregation は、各集計イベントのデータ ポイント数を定義します。 既定値は 6 です。

これら 2 つの値によって、SDK が summaryReported イベントを生成する頻度と、レポートに含まれる集計データ ポイントの数が決まります。

summaryReported イベントは aggregationInterval * dataPointsPerAggregation 秒ごとに発生します。

たとえば、次の値を設定したとします。

• aggregationInterval = 1
• dataPointsPerAggregation = 60

summaryReported イベントは 60 秒ごとに発生し、記録された各統計には 60 個の独立ユニットが含まれます。

次の値を設定したとします。:

• aggregatinInterval = 60
• dataPointsPerAggregation = 1

summaryReported イベントは 60 秒ごとに発生し、記録された各統計には 1 個の独立ユニットが含まれます。

ベスト プラクティス

オフラインで調査するためにデータを収集する場合は、データを収集し、通話の終了後にパイプライン インジェストに送ることをお勧めします。 通話中にこのデータを送信する場合は、Azure Communication Services 通話を続行するために必要なインターネット帯域幅を使用できます (特に利用可能な帯域幅が少ない場合)。

sampleReported イベントまたは summaryReported イベントでは、メディア統計データは単純なキーと値のマッピングだけではありません。

sampleReported イベントによって報告されるイベント データの型宣言を以下に示します。

export interface MediaStatsReportSample {
    audio: {
        send: OutgoingAudioMediaStats<number, string>[];
        receive: IncomingAudioMediaStats<number, string>[];
    };
    video: {
        send: OutgoingVideoMediaStats<number, string>[];
        receive: IncomingVideoMediaStats<number, string>[];
    };
    screenShare: {
        send: OutgoingScreenShareMediaStats<number, string>[];
        receive: IncomingScreenShareMediaStats<number, string>[];
    };
    transports: TransportMediaStats<number>[];
}

イベント データは、送信方向と受信方向の両方を含む、通話内の各メディア ストリームの統計データを提供します。

各自の使用シナリオに従ってデータを表示したり処理する適切な方法を見つけるために、console.log を使用してイベントを出力し、レイアウトと値の変化を観察することが推奨されます。

オーディオ送信のメトリック

オーディオ受信のメトリック

1.20.1 より前のバージョンの SDK では、jitterBufferDelayInMs は jitterBufferInMs として存在していました。

ビデオ送信のメトリック

SDK バージョン 1.20.1 以降では、ビデオ送信メトリックに altLayouts メトリック フィールドが含まれています。これにより、サイマルキャスト ストリーム統計をより適切に表現できます。

ビデオ受信のメトリック

1.20.1 より前のバージョンの SDK では、jitterBufferDelayInMs は jitterBufferInMs として存在していました。

画面共有送信のメトリック

現在、統計フィールドはビデオ送信メトリックと同じです。

画面共有受信のメトリック

現在、統計フィールドはビデオ受信メトリックと同じです。

転送メトリック

転送関連のメトリックは、ACS Web SDK 1.20.1 以降分離されました。

以前のバージョンでは、rttInMs はオーディオ、ビデオ、画面共有において pairRttInMs として存在していました。

availableIncomingBitrate は、オーディオ、ビデオ、画面共有の受信統計の availableBitrate でした。

availableOutgoingBitrate は、オーディオ、ビデオ、画面共有の送信統計の availableBitrate でした。

SDK バージョン 1.20.1 (GA) で変更された内容

1.20.1 (GA) では MediaStats feature API がサポートされるようになりました。

以前のベータ版と比較して、この GA バージョンの API インターフェイスには、いくつかの小さな変更も加えられています。

以前のベータ版では、pairRttInMs と availableBitrate はオーディオ、ビデオ、画面共有の統計に含まれていました。 これらのメトリックは転送メトリックへと分割されました。

オーディオ、ビデオ、画面共有統計に packets および packetsLost メトリック フィールドが導入されました。 これらのメトリックは、2 つの異なる時刻の間に送信または受信されたパケットの合計数を計算するのに役立ちます。

ビデオおよび画面共有統計から frameRateOutput が削除されています。 代わりに frameRateDecoded を使用できます。

メトリック フィールド jitterBufferInMs は、パケットがジッター バッファーの中に留まる時間を示すため、わかりやすさのために名前が jitterBufferDelayInMs に変更されました。

進行中の通話のメディア品質に関する統計情報

メディア品質の統計情報は、コア Call API の拡張機能です。 まず、MediaStatisticsCallFeature API オブジェクトを取得する必要があります。

MediaStatisticsCallFeature mediaStatisticsCallFeature = call.feature(Features.MEDIA_STATISTICS);

MediaStatisticsCallFeature オブジェクトには、次の API 構造があります。

• OnReportReceivedListener イベントは、メディア統計の定期的なレポートをリッスンします。
• getReportIntervalInSeconds は、メディア統計レポートの生成間隔を秒単位で取得します。 SDK は既定で 10 秒を使用します。
• updateReportIntervalInSeconds() は、メディア統計レポートの生成間隔を秒単位で更新します。 SDK は既定で 10 秒を使用します。
• MediaStatisticsReport には、オーディオ、ビデオ、画面共有に分類された送受信メディア統計の定義が含まれます。
  • getOutgoingStatistics(): 送信メディアのメディア統計情報の一覧。
    • getAudioStatistics(): 送信オーディオのメディア統計情報の一覧。
    • getVideoStatistics(): 送信ビデオのメディア統計情報の一覧。
    • getScreenShareStatistics(): 送信画面共有のメディア統計情報の一覧。
    • getDataChannelStatistics(): データ チャネルのメディア統計の一覧。
  • getIncomingStatistics(): 受信メディアのメディア統計情報の一覧。
    • getAudioStatistics(): 受信オーディオのメディア統計情報の一覧。
    • getVideoStatistics(): 受信ビデオのメディア統計情報の一覧。
    • getScreenShareStatistics(): 受信画面共有のメディア統計情報の一覧。
    • getDataChannelStatistics(): データ チャネルのメディア統計の一覧。
  • getLastUpdatedAt(): レポートが生成された日付。

次に、addOnReportReceivedListener イベントにサブスクライブして、現在のメディア品質統計に関する定期的な更新値を取得します。

mediaStatisticsCallFeature.addOnReportReceivedListener(handleReportReceivedListener);
// Optionally, set the interval for media statistics report generation
mediaStatisticsCallFeature.updateReportIntervalInSeconds(15);

private void handleReportReceivedListener(MediaStatisticsReportEvent args) {
    // Obtain the media statistics report instance
    MediaStatisticsReport report = args.getReport();

    // Obtain the outgoing media statistics for audio
    List<OutgoingAudioStatistics> outgoingAudioStatistics = report.getOutgoingStatistics().getAudioStatistics();

    // Obtain the outgoing media statistics for video
    List<OutgoingVideoStatistics> outgoingVideoStatistics = report.getOutgoingStatistics().getVideoStatistics();

    // Obtain the outgoing media statistics for screen share
    List<OutgoingScreenShareStatistics> outgoingScreenShareStatistics = report.getOutgoingStatistics().getScreenShareStatistics();

    // Obtain the outgoing media statistics for data channel
    List<OutgoingDataChannelStatistics> outgoingDataChannelStatistics = report.getOutgoingStatistics().getDataChannelStatistics();

    // Obtain the incoming media statistics for audio
    List<IncomingAudioStatistics> incomingAudioStatistics = report.getIncomingStatistics().getAudioStatistics();

    // Obtain the incoming media statistics for video
    List<IncomingVideoStatistics> incomingVideoStatistics = report.getIncomingStatistics().getVideoStatistics();

    // Obtain the incoming media statistics for screen share
    List<IncomingScreenShareStatistics> incomingScreenShareStatistics = report.getIncomingStatistics().getScreenShareStatistics();

    // Obtain the incoming media statistics for data channel
    List<IncomingDataChannelStatistics> incomingDataChannelStatistics = report.getIncomingStatistics().getDataChannelStatistics();
}

ベスト プラクティス

オフラインで調査するためにデータを収集する場合は、データを収集し、通話の終了後にパイプライン インジェストに送ることをお勧めします。 通話中にこのデータを送信する場合は、Azure Communication Services 通話を続行するために必要なインターネット帯域幅を使用できます (特に利用可能な帯域幅が少ない場合)。

送信オーディオのメトリック

受信オーディオのメトリック

送信ビデオのメトリック

受信ビデオのメトリック

送信画面共有メトリック

現状、統計フィールドは "送信ビデオ メトリック" と同じです。

受信画面共有メトリック

現状、統計フィールドは "受信ビデオ メトリック" と同じです。

送信データ チャネル メトリック

受信データ チャネル メトリック

進行中の通話のメディア品質に関する統計情報

メディア品質の統計情報は、コア Call API の拡張機能です。 まず、mediaStatisticsCallFeature API オブジェクトを取得する必要があります。

var mediaStatisticsCallFeature = self.call.feature(Features.mediaStatistics)

mediaStatisticsCallFeature オブジェクトには、次の API 構造があります。

• didReceiveReport デリゲート メソッドは、メディア統計の定期的なレポートをリッスンします。
• reportIntervalInSeconds は、メディア統計レポートの生成間隔を秒単位で取得します。 SDK は既定で 10 秒を使用します。
• updateReportInterval(inSeconds) は、メディア統計レポートの生成間隔を秒単位で更新します。 SDK は既定で 10 秒を使用します。
• MediaStatisticsReport オブジェクトには、音声、ビデオ、画面共有に分類された送信メディアと受信メディアの統計情報の定義が含まれます。
  • outgoingMediaStatistics: 送信メディアのメディア統計情報の一覧。
    • audio: 送信オーディオのメディア統計情報の一覧。
    • video: 送信ビデオのメディア統計情報の一覧。
    • screenShare: 送信画面共有のメディア統計情報の一覧。
    • dataChannel: 送信データ チャネルのメディア統計の一覧。
  • incomingMediaStatistics: 受信メディアのメディア統計情報の一覧。
    • audio: 受信オーディオのメディア統計情報の一覧。
    • video: 受信ビデオのメディア統計情報の一覧。
    • screenShare: 受信画面共有のメディア統計情報の一覧。
    • dataChannel: 受信データ チャネルのメディア統計の一覧。
  • lastUpdated: レポートが生成された日付。

次に、現在のメディア品質統計に関する定期的な更新情報を取得するために didReceiveReport デリゲートを実装します。

// Optionally, set the interval for media statistics report generation
mediaStatisticsCallFeature.updateReportInterval(inSeconds: 15)
mediaStatisticsCallFeature.delegate = MediaStatisticsDelegate()


public class MediaStatisticsDelegate : MediaStatisticsCallFeatureDelegate
{
    public func mediaStatisticsCallFeature(_ mediaStatisticsCallFeature: MediaStatisticsCallFeature,
                                      didReceiveReport args: MediaStatisticsReportReceivedEventArgs) {
        let report = args.report

        // Obtain the outgoing media statistics for audio
        let outgoingAudioStatistics = report.outgoingStatistics.audio
    
        // Obtain the outgoing media statistics for video
        let outgoingVideoStatistics = report.outgoingStatistics.video
    
        // Obtain the outgoing media statistics for screen share
        let outgoingScreenShareStatistics = report.outgoingStatistics.screenShare

        // Obtain the outgoing media statistics for data channel
        let outgoingDataChannelStatistics = report.outgoingStatistics.dataChannel
    
        // Obtain the incoming media statistics for audio
        let incomingAudioStatistics = report.incomingStatistics.audio
    
        // Obtain the incoming media statistics for video
        let incomingVideoStatistics = report.incomingStatistics.video
    
        // Obtain the incoming media statistics for screen share
        let incomingScreenShareStatistics = report.incomingStatistics.screenShare

        // Obtain the incoming media statistics for data channel
        let incomingDataChannelStatistics = report.incomingStatistics.dataChannel
    }
}

ベスト プラクティス

オフラインで調査するためにデータを収集する場合は、データを収集し、通話の終了後にパイプライン インジェストに送ることをお勧めします。 通話中にこのデータを送信する場合は、Azure Communication Services 通話を続行するために必要なインターネット帯域幅を使用できます (特に利用可能な帯域幅が少ない場合)。

送信オーディオのメトリック

受信オーディオのメトリック

送信ビデオのメトリック

受信ビデオのメトリック

送信画面共有メトリック

現状、統計フィールドは "送信ビデオ メトリック" と同じです。

受信画面共有メトリック

現状、統計フィールドは "受信ビデオ メトリック" と同じです。

送信データ チャネル メトリック

受信データ チャネル メトリック

進行中の通話のメディア品質に関する統計情報

メディア品質の統計情報は、コア CommunicationCall API の拡張機能です。 まず、MediaStatisticsCallFeature API オブジェクトを取得する必要があります。

MediaStatisticsCallFeature mediaStatisticsCallFeature = call.Features.MediaStatistics;

MediaStatisticsCallFeature 機能のオブジェクトには、次の API 構造があります。

• ReportReceived イベントは、メディア統計の定期的なレポートをリッスンします。
• ReportIntervalInSeconds は、メディア統計レポートの生成間隔を秒単位で取得します。 SDK は既定で 10 秒を使用します。
• UpdateReportIntervalInSeconds() は、メディア統計レポートの生成間隔を秒単位で更新します。 SDK は既定で 10 秒を使用します。
• MediaStatisticsReport オブジェクトには、音声、ビデオ、画面共有に分類された送信メディアと受信メディアの統計情報の定義が含まれます。
  • OutgoingMediaStatistics: 送信メディアのメディア統計情報の一覧。
    • Audio: 送信オーディオのメディア統計情報の一覧。
    • Video: 送信ビデオのメディア統計情報の一覧。
    • ScreenShare: 送信画面共有のメディア統計情報の一覧。
    • DataChannel: 送信データ チャネルのメディア統計の一覧。
  • IncomingMediaStatistics: 受信メディアのメディア統計情報の一覧。
    • Audio: 受信オーディオのメディア統計情報の一覧。
    • Video: 受信ビデオのメディア統計情報の一覧。
    • ScreenShare: 受信画面共有のメディア統計情報の一覧。
    • DataChannel: 受信データ チャネルのメディア統計の一覧。
  • LastUpdateAt: レポートが生成された日付。

次に、SampleReported イベントにサブスクライブして、現在のメディア品質統計に関する定期的な更新値を取得します。

mediaStatisticsCallFeature.ReportReceived += MediaStatisticsCallFeature_ReportReceived;
// Optionally, set the interval for media statistics report generation
mediaStatisticsCallFeature.UpdateReportIntervalInSeconds(15);

private void MediaStatisticsCallFeature_ReportReceived(object sender, MediaStatisticsReportReceivedEventArgs args)
    // Obtain the media statistics report instance
    MediaStatisticsReport report = args.Report;

    // Obtain the outgoing media statistics for audio
    IReadOnlyList<OutgoingAudioStatistics> outgoingAudioStatistics = report.OutgoingStatistics.Audio;

    // Obtain the outgoing media statistics for video
    IReadOnlyList<OutgoingVideoStatistics> outgoingVideoStatistics = report.OutgoingStatistics.Video;

    // Obtain the outgoing media statistics for screen share
    IReadOnlyList<OutgoingScreenShareStatistics> outgoingScreenShareStatistics = report.OutgoingStatistics.ScreenShare;

    // Obtain the outgoing media statistics for data channel
    IReadOnlyList<OutgoingDataChannelStatistics> outgoingDataChannelStatistics = report.OutgoingStatistics.DataChannel;

    // Obtain the incoming media statistics for audio
    IReadOnlyList<IncomingAudioStatistics> incomingAudioStatistics = report.IncomingStatistics.Audio;

    // Obtain the incoming media statistics for video
    IReadOnlyList<IncomingVideoStatistics> incomingVideoStatistics = report.IncomingStatistics.Video;

    // Obtain the incoming media statistics for screen share
    IReadOnlyList<IncomingScreenShareStatistics> incomingScreenShareStatistics = report.IncomingStatistics.ScreenShare;

    // Obtain the incoming media statistics for data channel
    IReadOnlyList<IncomingDataChannelStatistics> incomingDataChannelStatistics = report.IncomingStatistics.DataChannel;
}

ベスト プラクティス

オフラインで調査するためにデータを収集する場合は、データを収集し、通話の終了後にパイプライン インジェストに送ることをお勧めします。 通話中にこのデータを送信する場合は、Azure Communication Services 通話を続行するために必要なインターネット帯域幅を使用できます (特に利用可能な帯域幅が少ない場合)。

送信オーディオのメトリック

受信オーディオのメトリック

送信ビデオのメトリック

受信ビデオのメトリック

送信画面共有メトリック

現状、統計フィールドは "送信ビデオ メトリック" と同じです。

受信画面共有メトリック

現状、統計フィールドは "受信ビデオ メトリック" と同じです。

送信データ チャネル メトリック

受信データ チャネル メトリック