オーディオのフォールバック — iOS (Swift)

OpenTokのオーディオフォールバックAPIを使用して、ネットワーク品質に応じてオーディオの優先順位を動的に調整します。

概念的な情報については オーディオ・フォールバックの概要.

注釈

  • について audioFallbackEnabled のプロパティ OTPublisherKit は非推奨となります。代わりに、 subscriberAudioFallbackEnabled のプロパティ OTPublisherKitSettings その代わりだ。

このトピックには以下のセクションが含まれます:

音声のみのフォールバックの有効化と無効化

パブリッシャーオーディオのフォールバックを有効にするには OTPublisherKitSettings.publisherAudioFallbackEnabled プロパティを使用します。


// Enable publisher audio fallback
let publisherSettings = OTPublisherSettings()
publisherSettings.publisherAudioFallbackEnabled = YES

// Enable publisher audio fallback and disable subscriber audio fallback
let publisherSettings = OTPublisherSettings()
publisherSettings.publisherAudioFallbackEnabled = YES
publisherSettings.subscriberAudioFallbackEnabled = NO

// Enable subscriber audio fallback and disable publisher audio fallback
let publisherSettings = OTPublisherSettings()
publisherSettings.publisherAudioFallbackEnabled = NO
publisherSettings.subscriberAudioFallbackEnabled = YES

ストリームの全サブスクライバに対して)サブスクライバ音声フォールバックを有効/無効にするには、次のように設定します。 OTPublisherKitSettings.subscriberAudioFallbackEnabled プロパティを使用します。サブスクライバーの音声フォールバックはルーティングされたセッションでのみ サポートされています( ビデオ・メディア・ルーター).加入者音声フォールバックは、カメラのビデオソースを持つストリームでデフォルトで有効です(ルーティングされたセッションで)。

オーディオのフォールバックイベント

パブリッシャー・オーディオ・フォールバックが有効な場合 PublisherKitDelegate オブジェクトはパブリッシャーオーディオのフォールバック関連のイベントに関して以下のメッセージを送信します:

  • OTPublisherKitDelegate publisherVideoDisableWarning(_:) - ストリームの品質が低下したとパブリッシャーが判断したときに呼び出され、品質がさらに低下した場合は動画が無効になります。
  • OTPublisherKitDelegate publisherVideoDisableWarningLifted(_:) - パブリッシャーが、ストリームの品質が改善され、無効になっている動画が直ちに危険にさらされることはないと判断した場合に呼び出されます。
  • OTPublisherKitDelegate publisherVideoDisabled(_:reason:) - ストリームの品質が低下し、送信ビデオ・トランスポートが無効になったとパブリッシャが判断した場合に呼び出されます。注: 動画が無効になっても、パブリッシャはパブリッシング・クライアントの UI にパブリッシャの動画(カメラ画像など)を表示します。
  • OTPublisherKitDelegate publisherVideoEnabled(_:reason:) — 配信品質が向上したと配信事業者が判断し、動画の送信が再開された場合、これらは「高品質」と適切に呼ばれる。

例えば、以下のコードは関連イベントを処理します(独自のユーザーインターフェース通知を提供できるようにします):


func publisherVideoDisableWarning(_ publisher: OTPublisherKit) {
  // Custom action — for example, add custom UI notification
}

func publisherVideoDisableWarningLifted(_ publisher: OTPublisherKit) {
  // Custom action — for example, remove custom UI notification
}

func publisherVideoDisabled(_ publisher: OTPublisherKit, reason: OTPublisherVideoEventReason) {
  // Custom action — for example, add custom UI notification
}

func publisherVideoEnabled(_ publisher: OTPublisherKit, reason: OTPublisherVideoEventReason) {
  // Custom action — for example, remove custom UI notification
}

サブスクライバーの観点からは、以下のイベントが発生したことで、オーディオのフォールバックが発生したことがわかります。これらのイベントはサブスクライバーに関連するものですが、サブスクライバー側のオーディオフォールバックによる場合もあれば、パブリッシャー側のオーディオフォールバックの結果として発生する場合もあります。 つまり、パブリッシャー側のオーディオフォールバックとサブスクライバー側のオーディオフォールバックの違いは、パブリッシャー側のケースでは、パブリッシングクライアントが自身のストリームの品質低下に基づいてオーディオフォールバックをトリガーする可能性がある点にあり、そのため、パブリッシャー側で追加のイベントがディスパッチされるのです。 サブスクライバー側のオーディオフォールバックの場合、Vonage Video Media Router は、サブスクライバーに影響を与えるネットワークの品質低下を評価します。いずれの場合も、パブリッシャー側またはサブスクライバー側のオーディオフォールバックが発生すると、受信側でオーディオフォールバックが発生したことを示すサブスクライバー側のイベントが常にディスパッチされます。

音声フォールバックが発生すると SubscriberKitDelegate オブジェクトは、サブスクライバーのオーディオフォールバック関連イベントに関する以下のメッセージを送信する:

  • OTSubscriberKitDelegate subscriberVideoDisableWarning(_:) - ストリームの画質が劣化したと判断されたときに呼び出され、画質がさらに劣化した場合は動画が無効化される。
  • OTSubscriberKitDelegate subscriberVideoDisableWarningLifted(_:) - ストリームの品質が、無効化されている動画が直ちに危険でない程度まで改善されたと判断された場合に呼び出される。
  • OTSubscriberKitDelegate subscriberVideoDisabled(_:reason:) - ストリームの品質が低下し、送信ビデオ・トランスポートが無効になったと判断された場合に呼び出されます。注:ビデオが無効になっている間も、サブスクライバはパブリッシング・クライアントの UI にサブスクライバのビデオ(カメラ画像など)を表示します。
  • OTSubscriberKitDelegate subscriberVideoEnabled(_:reason:) - ストリームの品質が向上し、送信ビデオトランスポートが再度有効になったと判断されたとき、理由「quality」で呼び出される。

例えば、以下のコードは関連イベントを処理します(独自のユーザーインターフェース通知を提供できるようにします):


func subscriberVideoDisableWarning(_ subscriber: OTSubscriberKit) {
  // Custom action — for example, add custom UI notification
}

func subscriberVideoDisableWarningLifted(_ subscriber: OTSubscriberKit) {
  // Custom action — for example, remove custom UI notification
}

func subscriberVideoDisabled(_ subscriber: OTSubscriberKit, reason: OTSubscriberVideoEventReason) {
  // Custom action — for example, add custom UI notification
}

func subscriberVideoEnabled(_ subscriber: OTSubscriberKit, reason: OTSubscriberVideoEventReason) {
  // Custom action — for example, remove custom UI notification
}