Solution de secours audio — iOS (Swift)

Utilisez l'API de repli audio d'OpenTok pour hiérarchiser dynamiquement l'audio en fonction de la qualité du réseau.

Pour des informations conceptuelles, voir le aperçu du repli audio.

Notes :

  • Les audioFallbackEnabled propriété de OTPublisherKit sera obsolète. Veuillez utiliser le subscriberAudioFallbackEnabled propriété de OTPublisherKitSettings au lieu de cela.

Cette rubrique comprend les sections suivantes :

Activation et désactivation du mode de secours « audio uniquement »

Pour activer le repli audio de l'éditeur, définissez le paramètre OTPublisherKitSettings.publisherAudioFallbackEnabled lors de la création de l'éditeur.


// 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

Pour activer et désactiver le repli audio de l'abonné (pour tous les abonnés au flux), définissez le paramètre OTPublisherKitSettings.subscriberAudioFallbackEnabled lors de la création de l'éditeur. Le repli audio de l'abonné n'est pris en charge que dans les sessions acheminées (sessions qui utilisent la propriété Routeur vidéo multimédia de Vonage). Le repli audio de l'abonné est activé par défaut (dans les sessions acheminées) pour les flux dont la source est une caméra vidéo.

Événements de repli audio

Lorsque le repli audio de l'éditeur est activé, le PublisherKitDelegate enverra les messages suivants concernant les événements liés au repli audio de l'éditeur :

  • OTPublisherKitDelegate publisherVideoDisableWarning(_:) - Appelé lorsque l'éditeur détermine que la qualité du flux s'est dégradée et que la vidéo sera désactivée si la qualité se dégrade davantage.
  • OTPublisherKitDelegate publisherVideoDisableWarningLifted(_:) - Appelé lorsque l'éditeur détermine que la qualité du flux s'est améliorée au point que la vidéo désactivée ne représente plus un risque immédiat.
  • OTPublisherKitDelegate publisherVideoDisabled(_:reason:) - Appelé lorsque l'éditeur détermine que la qualité du flux s'est dégradée et que le transport vidéo sortant a été désactivé. Remarque : lorsque la vidéo est désactivée, l'éditeur continue d'afficher la vidéo de l'éditeur (telle que l'image de la caméra) dans l'interface utilisateur du client de publication.
  • OTPublisherKitDelegate publisherVideoEnabled(_:reason:) — Qualifié à juste titre de « qualité » lorsque l'éditeur constate que la qualité du flux s'est améliorée et que le transport vidéo sortant a été réactivé.

Par exemple, le code suivant gère les événements connexes (afin que vous puissiez fournir vos propres notifications à l'interface utilisateur) :


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
}

Du point de vue de l'abonné, les événements suivants indiquent qu'un basculement audio s'est produit. Bien que ces événements soient liés à l'abonné, ils peuvent survenir aussi bien en raison d'un basculement audio côté abonné qu'à la suite d'un basculement audio côté éditeur. En d’autres termes, la différence entre le basculement audio côté éditeur et celui côté abonné réside dans le fait que, dans le cas de l’éditeur, le client éditeur peut déclencher le basculement audio en raison de la dégradation de son propre flux, ce qui explique pourquoi des événements supplémentaires côté éditeur sont envoyés. Dans le cas du basculement audio côté abonné, le Vonage Video Media Router évalue la dégradation du réseau affectant l’abonné. Dans les deux cas, lors d’un basculement audio côté éditeur ou côté abonné, des événements côté abonné sont toujours envoyés pour indiquer qu’un basculement audio s’est produit pour le destinataire.

Lorsque le repli audio se produit, le SubscriberKitDelegate enverra les messages suivants concernant les événements liés au repli audio de l'abonné :

  • OTSubscriberKitDelegate subscriberVideoDisableWarning(_:) - Appelé lorsqu'il est déterminé que la qualité du flux s'est dégradée et que la vidéo sera désactivée si la qualité se dégrade davantage.
  • OTSubscriberKitDelegate subscriberVideoDisableWarningLifted(_:) - Appelé lorsqu'il est déterminé que la qualité du flux s'est améliorée au point que la vidéo désactivée ne constitue pas un risque immédiat.
  • OTSubscriberKitDelegate subscriberVideoDisabled(_:reason:) - Appelé lorsqu'il est déterminé que la qualité du flux s'est dégradée et que le transport vidéo sortant a été désactivé. Remarque : lorsque la vidéo est désactivée, l'abonné continue d'afficher la vidéo de l'abonné (telle que l'image de la caméra) dans l'interface utilisateur du client de publication.
  • OTSubscriberKitDelegate subscriberVideoEnabled(_:reason:) - Appelé avec le motif "quality" lorsqu'il est déterminé que la qualité du flux s'est améliorée et que le transport vidéo sortant a été réactivé.

Par exemple, le code suivant gère les événements connexes (afin que vous puissiez fournir vos propres notifications à l'interface utilisateur) :


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
}