La première étape pour utiliser la Video API Vonage consiste à appeler la OT.initSession() méthode. D'autres méthodes de l'objet OT vérifient la configuration système requise et configurent la journalisation des erreurs.

Méthodes

(statique) addEventListener(type, listener)

Cette méthode est obsolète. Utilisez on() ou une fois() au lieu de cela.

Enregistre une méthode en tant qu'écouteur d'événement pour un événement spécifique.

L'objet OT génère un seul type d'événement : un exception événement. Le code suivant ajoute un écouteur d'événement pour le exception événement :

OT.addEventListener("exception", exceptionHandler);

function exceptionHandler(event) {
   alert("exception event. \n  code == " + event.code + "\n  message == " + event.message);
}

Si aucun gestionnaire n'est enregistré pour un événement, celui-ci est ignoré localement. Si la fonction d'écoute de l'événement n'existe pas, l'événement est ignoré localement.

Lance une exception si le listener Le nom n'est pas valide.

Paramètres :

Voir : : - on() - une fois()

(statique) checkScreenSharingCapability(callback) → {Promise.<ScreenSharingCapabilityResponse>}

Vérifie si la publication de flux de partage d'écran est prise en charge par le navigateur client. L'objet renvoyé par la promesse indique si le partage d'écran est pris en charge, ainsi que les sources de partage d'écran (application, écran ou fenêtre) qui sont prises en charge. Il indique également si une extension est requise, installée et enregistrée (le cas échéant).

const response = await OT.checkScreenSharingCapability();
if (!response.supported || response.extensionRegistered === false) {
// This browser does not support screen sharing
} else if (response.extensionInstalled === false) {
  // Prompt to install the extension
} else {
  // Screen sharing is available.
}

Cet objet possède les propriétés suivantes, qui indiquent que le client prend en charge la publication de flux de partage d'écran :

• extensionInstalled (Booléen) — Dans les anciennes versions de Chrome et d'Opera, cette valeur est définie sur true si l'extension est installée et enregistrée. Dans Chrome 72 et versions ultérieures, Firefox 52 et versions ultérieures, Safari 13 et versions ultérieures, Opera 59 et versions ultérieures, Edge 79 et versions ultérieures, ainsi que dans Internet Explorer, cette propriété n'est pas définie.
• supported (booléen) — Définir sur true si le partage d'écran est pris en charge par le navigateur. Vérifiez la extensionRequired propriété pour vérifier si le navigateur nécessite une extension pour le partage d'écran.
• supportedSources (Objet) — Obsolète. Dans les anciennes versions de navigateur, il était possible de sélectionner un type de source de partage d'écran (tel que "application", "browser", "screen", ou "window" en réglant le videoSource propriété des options transmises à la fonction OT.initPublisher() méthode. Cependant, dans les navigateurs actuels prenant en charge le partage d'écran, le fait de passer l'une ou l'autre de ces valeurs entraîne le même comportement : le navigateur affiche une boîte de dialogue dans laquelle l'utilisateur final sélectionne la source du partage d'écran (qui peut être l'écran entier ou une fenêtre spécifique). Dans Electron, le partage d’écran capture l’intégralité de l’écran, sans demander d’autorisation à l’utilisateur.

Le paramètre « options » comprend également les propriétés suivantes, qui s'appliquent à la prise en charge du partage d'écran dans les anciennes versions de Chrome et d'Opera (dans tous les autres navigateurs, ces propriétés sont non définies) :

• extensionRequired (Chaîne) — Définir sur "chrome" dans les anciennes versions de Chrome et d'Opera, qui nécessitent l'installation d'une extension de partage d'écran. Cette propriété n'est pas définie dans les autres navigateurs.
• extensionRegistered (Booléen) — Dans les anciennes versions de Chrome et d'Opera, cette propriété est définie sur true si une extension de partage d'écran est enregistrée ; sinon, elle est définie sur false. Dans les autres navigateurs (qui ne nécessitent pas d'extension), cette propriété n'est pas définie. Utilisez la OT.registerScreenSharingExtension() méthode permettant d'enregistrer une extension de partage d'écran dans les anciennes versions de Chrome ou d'Opera.

Chrome 72 et versions ultérieures, Firefox 52 et versions ultérieures, Safari 13 et versions ultérieures, Edge 79 et versions ultérieures, ainsi qu’Opera 59 et versions ultérieures intègrent la prise en charge du partage d’écran, sans nécessiter d’extension. (Notez que la prise en charge du plugin Vonage Video API pour Internet Explorer a été supprimée dans la version 2.17 de l'API Vonage Video.) Le partage d'écran est pas pris en charge par les navigateurs mobiles. Dans Electron, le partage d'écran est pris en charge si le webPreferences.contextIsolation L'option de la fenêtre de navigation Electron est définie sur false ou si l'application utilise un script de préchargement pour accéder à l'outil de capture d'écran. (La valeur par défaut de webPreferences.contextIsolation est l'option true dans Electron 12 et false (dans les versions précédentes). Pour publier une vidéo de partage d'écran dans les anciennes versions de Chrome ou d'Opera, le client installe une extension qui permet de publier un flux vidéo de partage d'écran sur votre domaine. La Video API Vonage extensions de partage d'écran Cet exemple contient du code permettant de créer une extension pour prendre en charge le partage d'écran dans les anciennes versions de Chrome et d'Opera.

Pour plus d'informations, voir le Partage d'écran via la Video API Vonage guide du développeur.

Paramètres :

Voir : : - OT.initPublisher() - OT.registerScreenSharingExtension()

Retours :

Une promesse qui tient ses promesses

(statique) checkSystemRequirements() → {Number}

Vérifie si le système prend en charge la Video API de Vonage pour WebRTC. Notez que cette méthode est appelée automatiquement lorsque vous appelez OT.initPublisher() ou OT.initSession(), et si le système ne prend pas en charge la Video API de Vonage, la bibliothèque OpenTok.js affiche un message destiné à l'utilisateur. Appelez la fonction OT.checkSystemRequirements() méthode avant l'appel OT.initPublisher() ou OT.initSession() si vous ne souhaitez pas que la bibliothèque affiche ce message.

Voir : : - OT.upgradeSystemRequirements()

Retours :

Si le système prend en charge la Video API de Vonage pour WebRTC (1) ou non (0).

(statique) getActiveAudioOutputDevice()

Renvoie une Promise qui identifie le périphérique de sortie audio actuel.

La méthode renvoie une Promise qui, une fois résolue, fournit un objet comportant deux propriétés : deviceId et label, qui sont toutes des chaînes de caractères.

Les deviceId La propriété correspond à un identifiant unique de l'appareil. Vous pouvez transmettre le deviceId en tant que paramètre de la OT.setAudioOutputDevice() méthode. La méthode deviceId Cette propriété est définie sur « undefined » si l'utilisateur n'a pas préalablement autorisé l'accès à une caméra et à un microphone.

Les label Cette propriété identifie l'appareil. La label Cette propriété prend la valeur d'une chaîne vide si l'utilisateur n'a pas encore autorisé l'accès à une caméra et à un microphone.

Note: La prise en charge actuelle par les navigateurs concerne les versions de bureau de Chrome 49 et versions ultérieures, Edge 17 et versions ultérieures, Opera 36 et versions ultérieures, ainsi que les versions récentes de Samsung Internet, WebView sur Android et WebView sur iOS.

Voir : : - OT.getAudioOutputDevices() - OT.setAudioOutputDevice()

(statique) getAudioOutputDevices()

Répertorie les périphériques de sortie audio (tels que les haut-parleurs) disponibles pour le navigateur.

La méthode renvoie une Promise qui se résout en un tableau d'objets correspondant aux périphériques de sortie audio disponibles. Chaque objet possède deux propriétés : deviceId et label, qui sont toutes des chaînes de caractères.

Les deviceId La propriété correspond à un identifiant unique de l'appareil. Vous pouvez transmettre le deviceId en tant que paramètre de la OT.setAudioOutputDevice() méthode. La méthode deviceId La propriété est définie sur « undefined » si l'utilisateur n'a pas préalablement autorisé l'accès à une caméra et à un microphone. S'il n'y a aucun périphérique de sortie audio disponible, la propriété est définie sur null.

Les label Cette propriété identifie l'appareil. La label Cette propriété prend la valeur d'une chaîne vide si l'utilisateur n'a pas encore autorisé l'accès à une caméra et à un microphone.

Notes ::

• La prise en charge actuelle des navigateurs concerne les versions de bureau de Chrome 49 et versions ultérieures, Edge 17 et versions ultérieures, Opera 36 et versions ultérieures, ainsi que les versions récentes de Samsung Internet, WebView sur Android et WebView sur iOS.
• Le navigateur peut limiter à un le nombre de périphériques de sortie audio avant que l'utilisateur n'ait autorisé l'accès à une caméra ou à un microphone.

Voir : : - OT.setAudioOutputDevice() - OT.getActiveAudioOutputDevice()

(statique) getDevices(callback) → {Promise.<Array.<Device>>}

Répertorie les périphériques d'entrée audio (tels que les microphones) et les périphériques d'entrée vidéo (caméras) disponibles pour le navigateur. Cette méthode renvoie une « promise » contenant le tableau des périphériques. Chaque objet possède trois propriétés : kind, deviceIdet label, qui sont toutes des chaînes de caractères.

Les kind est fixée à "audioInput" pour les périphériques d'entrée audio ou "videoInput" pour les périphériques d'entrée vidéo.

Les deviceId La propriété correspond à un identifiant unique de l'appareil. Vous pouvez transmettre le deviceId en tant que audioSource ou videoSource propriété de la options du paramètre OT.initPublisher() méthode.

Les label Cette propriété identifie l'appareil. La label Cette propriété prend la valeur d'une chaîne vide si l'utilisateur n'a pas encore autorisé l'accès à une caméra et à un microphone.

Paramètres :

Voir : : - OT.initPublisher()

Retours :

Une promesse contenant la liste des appareils

(statique) getSupportedCodecs() → {Promise}

Récupère la liste des codecs pris en charge pour l'encodage et le décodage des flux vidéo.

L'exemple suivant permet d'obtenir la liste des codecs pris en charge pour l'encodage et le décodage des flux vidéo :

(async () => {
  try {
    const supportedCodecs = await OT.getSupportedCodecs();
    if (supportedCodecs.videoEncoders.indexOf('H264') < 0 &&
        supportedCodecs.videoDecoders.indexOf('H264') < 0) {
      // The client does not support encoding or decoding H264.
      // Let's recommend using a different browser.
    }
  } catch(err) {
    console.log(err);
  }
})();

Vous pouvez utiliser les listes de codecs vidéo pris en charge pour déterminer si le client prend en charge la vidéo, en fonction du codec vidéo préféré et du type de session utilisé. Vous pouvez définir le codec vidéo préféré sur la page « Projet » de votre Compte Video API de Vonage. Dans sessions acheminées (sessions utilisant le routeur multimédia de la Video API Vonage), le codec vidéo préféré est utilisé pour tous les clients de la session. Dans les sessions relayées, les clients envoient des flux directement les uns aux autres, et chaque paire émetteur-abonné tente de trouver un codec vidéo commun qu'ils peuvent tous deux utiliser. À cet égard, le codec vidéo utilisé par la paire dans une session relayée peut être différent du paramètre de codec vidéo préféré. Pour plus d’informations, consultez la documentation de la Video API vonage Codecs vidéo guide du développeur.

Retours :

Une promesse qui est résolue lorsque la liste des codecs pris en charge est prête. La promesse est résolue (en cas de réussite) avec un objet comportant deux propriétés : videoDecoders, une liste des codecs vidéo pris en charge pour le décodage, et videoEncoders, une liste des codecs vidéo pris en charge pour l'encodage, tels que :

{
   videoDecoders: ['H264', 'VP8', 'VP9'],
   videoEncoders: ['H264', 'VP8', 'VP9']
}

La promesse est rejetée s'il se produit une erreur lors de la récupération de la liste.

(statique) getUserMedia(options) → {Promise}

Récupère un objet MediaStream qui utilise un microphone et une caméra comme sources audio et vidéo. Cette méthode renvoie une promesse qui est résolue lorsque l'utilisateur a accordé l'autorisation d' utiliser la caméra ou le microphone (ou les deux) et que l'objet MediaStream est disponible. La promesse est rejetée s'il y a une erreur lors de l'obtention du flux multimédia ou si l'utilisateur final refuse l'accès à la caméra ou au microphone.

Vous pouvez utiliser cette méthode pour obtenir des objets `MediaStreamTrack` à transmettre à la méthode audioSource et videoSource options de la OT.initPublisher() méthode. Par exemple, appelez cette méthode pour obtenir un MediaStream utilisant le microphone et la caméra comme sources audio et vidéo. Vous pouvez ensuite appeler getVideoTracks()[0] sur l'objet MediaStream pour obtenir un objet MediaStreamTrack correspondant à la vidéo de la caméra. Vous pouvez ensuite ajouter cet objet MediaStreamTrack comme source d'un élément Video HTML, dessiner cet élément Video dans un élément Canvas HTML, puis appliquer des filtres ou des effets vidéo au Canvas. Vous pouvez ensuite appeler la méthode captureStream() méthode de l'objet HTMLCanvasElement permettant d'obtenir un objet MediaStream et d'appeler getVideoTracks()[0] sur l'objet MediaStream pour obtenir un objet MediaStreamTrack vidéo (avec les filtres ou effets vidéo appliqués). Enfin, vous pouvez utiliser l'objet MediaStreamTrack vidéo comme videoSource propriété des options que vous transmettez à OT.initPublisher(). L'éditeur de la Video API Vonage utilisera la piste vidéo (avec les filtres et effets appliqués) comme source vidéo.

Paramètres :

Voir : : - Les options (en particulier audioSource et videoSource) de la OT.initPublisher() méthode

Retours :

Une promesse qui est résolue lorsque l'utilisateur a accordé l'autorisation d' utiliser la caméra ou le microphone (ou les deux) et que l'objet `MediaStream` est disponible. La promesse est rejetée en cas d'erreur lors de la récupération du flux multimédia, si l'utilisateur final refuse l'accès à la caméra ou au microphone, ou si la méthode est appelée sous Internet Explorer.

(statique) hasEndToEndEncryptionSupport() → {Boolean}

Si le client prend en charge le chiffrement de bout en bout.

L'exemple suivant active le chiffrement de bout en bout, si cette fonctionnalité est prise en charge par le client :

// Publish in a session with end-to-end encryption, if supported
if (OT.hasEndToEndEncryptionSupport()) {
  session.publish(publisher, error) = {
    ...
  });
}

Voir : : - OT.initSession() - Session.publish()

Retours :

Que le client prenne en charge le chiffrement de bout en bout (true), ou non (false).

(statique) hasMediaProcessorSupport(mediaType) → {Boolean}

Si le client prend en charge les processeurs multimédias, tels que les filtres vidéo et audio.

L'exemple suivant active le filtre de flou d'arrière-plan, si celui-ci est pris en charge par le client :

// Add background blur, if supported
if (OT.hasMediaProcessorSupport('video')) {
  publisherOptions.videoFilter = {
    type: 'backgroundBlur',
  };
}
// Add advanced noise suppression, if supported
if (OT.hasMediaProcessorSupport('audio')) {
  publisherOptions.audioFilter = {
    type: 'advancedNoiseSuppression',
  };
}

const publisher = OT.initPublisher(publisherOptions);

Paramètres :

Voir : : - OT.initPublisher() - Publisher.applyVideoFilter() - Publisher.applyAudioFilter()

Retours :

Que le client prenne en charge ou non les processeurs multimédias (true), qu'il s'agisse de filtres vidéo et audio, ou non (false).

(statique) initPublisher(élémentCible, propriétés, gestionnaireDeFin) → {Éditeur}

Initialise et renvoie un objet Publisher. Vous pouvez ensuite transmettre cet objet Publisher à Session.publish() pour publier un flux vers une session.

Remarque : Si vous comptez réutiliser un objet Publisher pour publier successivement dans différentes sessions (ou dans la même session), ajoutez un écouteur d'événement pour le streamDestroyed événement déclenché par l'objet Publisher (lorsqu'il cesse de publier). Dans le gestionnaire d'événements, appelez la méthode preventDefault() méthode de l'objet « event » afin d'empêcher que la vidéo de l'éditeur ne soit supprimée de la page.

Paramètres :

Voir : : - Session.publish()

Retours :

L'objet Publisher.

(statique) initSession(apiKey, sessionId, options) → {Session}

Initialise et renvoie l'objet de session local correspondant à un identifiant de session spécifié.

Vous vous connectez à une session de la Video API Vonage à l'aide de la connect() méthode de l'objet Session renvoyé par le OT.initSession() méthode. Notez que l'appel de OT.initSession() n'initie pas de communication avec le cloud. Il se contente d'initialiser l'objet Session que vous pouvez utiliser pour vous connecter (et effectuer d'autres opérations une fois connecté).

Notez que vous ne pouvez initialiser qu’un seul objet Session par identifiant de session. L’appel de OT.initSession() Une deuxième utilisation avec le même identifiant de session renvoie l' objet Session créé précédemment. Cependant, vous pouvez initialiser plusieurs objets Session pour différentes sessions (avec des identifiants de session différents) afin de vous connecter à plusieurs sessions.

Lorsque le client se déconnecte de la session (et que celle-ci envoie un sessionDisconnected événement), vous pouvez réutiliser l'objet Session pour vous reconnecter à la session. Cependant, l'objet Session conservera tous les gestionnaires d'événements qui y sont associés. Vous pouvez supprimer tous les gestionnaires d'événements en appelant la méthode off() méthode de l'objet Session (sans passer de paramètres).

Pour un exemple, voir Session.connect().

Paramètres :

Retours :

L'objet de session par l'intermédiaire duquel toutes les interactions ultérieures avec la session auront lieu.

(statique) log(message)

Envoie une chaîne de caractères à la console du débogueur. Cependant, la fonction n'enregistre des informations dans la console que si vous avez défini le niveau de journalisation sur OT.LOG ou OT.DEBUG, en appelant OT.setLogLevel(OT.LOG) ou OT.setLogLevel(OT.DEBUG).

Paramètres :

Voir : : - OT.setLogLevel()

(statique) off(type, gestionnaire, contexte)

Supprime un gestionnaire d'événements.

En transmettant un nom d'événement et une méthode de gestion, la méthode de gestion est supprimée pour cet événement :

OT.off("exceptionEvent", exceptionEventHandler);

Si vous transmettez un nom d'événement et non méthode de gestionnaire : tous les gestionnaires sont supprimés pour cet événement :

OT.off("exceptionEvent");

La méthode prend également en charge une syntaxe alternative, dans laquelle le premier paramètre est un objet représentant une table de correspondance entre les noms d'événements et les fonctions de gestion, et le deuxième paramètre (facultatif) correspond au contexte de correspondance des gestionnaires :

OT.off(
  {
    exceptionEvent: exceptionEventHandler
  },
  this
);

Paramètres :

Voir : : - on() - une fois() - Evénements

(statique) on(type, gestionnaire, contexte)

Ajoute une fonction de gestion d'événements pour un ou plusieurs événements.

L'objet OT génère un seul type d'événement : un exception événement. Le code suivant ajoute un détecteur d'événement pour le exception événement :

OT.on("exception", function (event) {
  // This is the event handler.
});

Vous pouvez également passer un troisième context paramètre (facultatif) permettant de définir la valeur de this dans la méthode de gestionnaire :

OT.on("exception",
  function (event) {
    // This is the event handler.
  }),
  session
);

Si vous n'ajoutez pas de gestionnaire pour un événement, celui-ci est ignoré au niveau local.

Paramètres :

Voir : : - off() - une fois() - Evénements

(statique) once(type, handler, context)

Ajoute une fonction de gestion d'événement pour un événement donné. Une fois que la fonction de gestion est appelée, la méthode de gestion spécifiée est supprimée en tant que gestionnaire de cet événement. (Lorsque vous utilisez la OT.on() méthode permettant d'ajouter un gestionnaire d'événement ; ce gestionnaire est pas est supprimé lorsqu’il est appelé.) Le OT.once() Cette méthode équivaut à appeler la OT.on() méthode et appel OT.off() lors de la première invocation du gestionnaire.

Le code suivant ajoute un gestionnaire d'événement à exécuter une seule fois pour le exception événement :

OT.once("exception", function (event) {
  console.log(event);
}

Vous pouvez également passer un troisième context paramètre (facultatif) permettant de définir la valeur de this dans la méthode de gestionnaire :

OT.once("exception",
  function (event) {
    // This is the event handler.
  },
  session
);

La méthode prend également en charge une syntaxe alternative, dans laquelle le premier paramètre est un objet qui est un tableau associatif contenant les noms d'événements et les fonctions de gestion, et le deuxième paramètre (facultatif) correspond au contexte utilisé pour celui-ci dans chaque gestionnaire :

OT.once(
  {exeption: function (event) {
    // This is the event handler.
    }
  },
  session
);

Paramètres :

Voir : : - on() - une fois() - Evénements

(statique) registerScreenSharingExtension(type, identifiant, version)

Enregistrez une extension permettant de prendre en charge le partage d'écran dans une ancienne version de Chrome ou d'Opera.

Remarque : Une extension de partage d'écran n'est pas nécessaire dans Chrome 72 ou versions ultérieures, ni dans Opera 59 ou versions ultérieures. L'utilisateur final est invité à autoriser l'accès à son écran, comme il le ferait pour autoriser l'accès à sa caméra. Une extension de partage d'écran n'est nécessaire que pour les anciennes versions d'Opera et de Chrome.

Utiliser le OT.checkScreenSharingCapability() méthode permettant de vérifier si une extension est nécessaire, enregistrée et installée.

La Video API de Vonage extensions de partage d'écran Ce dépôt contient du code permettant de créer une extension pour la prise en charge du partage d'écran.

Paramètres :

Voir : : - OT.initPublisher() - OT.checkScreenSharingCapability()

(statique) removeEventListener(type, listener)

Cette méthode est obsolète. Utilisez off() au lieu de cela.

Supprime un écouteur d'événement pour un événement spécifique.

Lance une exception si le listener Le nom n'est pas valide.

Paramètres :

Voir : : - off()

(statique) reportIssue(completionHandler) → {Promise.<string>}

Signalez un problème rencontré avec votre application. Vous pouvez utiliser l'identifiant du problème avec Inspecteur ou lorsque vous discutez d'un problème avec l'équipe d'assistance de l'API Vonage.

Paramètres :

Retours :

Une promesse liée à l'identifiant du rapport

(statique) setAudioOutputDevice() → {Promise}

Définit le nouveau périphérique de sortie audio.

La méthode renvoie une Promise qui se résout lorsque l'opération s'achève avec succès. En cas d'erreur, la Promise est rejetée.

Note: La prise en charge actuelle des navigateurs concerne les versions de bureau de Chrome 49 et versions ultérieures, Firefox 116 et versions ultérieures, Edge 17 et versions ultérieures, Opera 36 et versions ultérieures, Safari 26 et versions ultérieures, ainsi que WebView sur iOS 26 et versions ultérieures.

Voir : : - OT.getAudioOutputDevices() - OT.getActiveAudioOutputDevice()

Retours :

Une promesse qui est résolue lorsque l'opération s'achève avec succès. En cas d'erreur, la promesse est rejetée.

(statique) setLogLevel(logLevel)

Définit le niveau de journalisation de l'API.

Appel OT.setLogLevel() définit le niveau de journalisation des messages de journalisation d'exécution générés par la bibliothèque Video API Vonage. La valeur par défaut du niveau de journalisation est OT.ERROR.

La bibliothèque JavaScript de la Video API Vonage affiche les messages de journalisation dans la console du débogueur (comme Firebug), le cas échéant.

L'exemple suivant affiche l'identifiant de session sur la console, en appelant OT.log(). Le code affiche également un message d'erreur lorsqu'il tente de publier un flux avant que vous ne vous soyez connecté à la session (en appelant Session.connect()).

OT.setLogLevel(OT.LOG);
session = OT.initSession(sessionId);
OT.log(sessionId);
publisher = OT.initPublisher("publishContainer");
session.publish(publisher);

Paramètres :

Voir : : - OT.log()

(statique) setProxyUrl()

Permet de définir l'URL du serveur proxy IP. Grâce à la fonctionnalité de proxy IP, le client achemine tout le trafic Internet (à l'exception des flux multimédias) via votre serveur proxy.

Vous devez appeler cette méthode avant d'appeler toute autre méthode de la Video API. Cela garantit que le serveur proxy est utilisé pour le trafic de la Video API. Sinon, l'appel échoue, et le OT l'objet déclenche un exception événement. L'événement OT L'objet déclenche également un exception même si vous appelez cette méthode après l'avoir déjà appelée auparavant.

Cette fonctionnalité est disponible en option. Pour plus d'informations, consultez la Guide du développeur de proxy IP.

(statique) unblockAudio()

Permet la lecture du contenu audio des abonnés dans les navigateurs où l'audio est bloqué. Vous devez appeler cette méthode en réponse à un élément HTML déclenchant un click événement.

Vous ne devez appeler cette méthode que si vous désactivez l'affichage de l'icône de lecture audio par défaut de l'abonné (en définissant la style.audioBlockedDisplayMode de la propriété options du paramètre Session.subscribe() (méthode). Vous pouvez appeler cette méthode lorsque l'utilisateur clique sur un élément HTML que vous affichez sur la page.

L'abonné envoie un audio bloqué événement si le son est bloqué. En réponse à cet événement, vous pouvez afficher un élément d'interface utilisateur pour inviter l'utilisateur final à réagir à la lecture de l'audio de l'abonné. Appelez la méthode OT.unblockAudio() méthode déclenchée lorsque l'utilisateur clique sur un élément DOM.

Remarque : Le son de l'abonné est également débloqué automatiquement si le client local accède à la caméra ou au microphone (par exemple, à la suite d'un appel abouti vers OT.initPublisher()).

Voir : : - Subscriber.isAudioBlocked() - Le audio bloqué et audioUnblocked Événements réservés aux abonnés

Retours :

Promesse : la promesse est résolue si la lecture audio aboutit sur tous les abonnés bloqués. La promesse est rejetée en cas d'échec de la lecture. Voir Erreur pour plus de détails.

(statique) upgradeSystemRequirements()

Affiche des informations sur la configuration système requise pour la Video API Vonage pour WebRTC. Ces informations s'affichent dans un élément iframe qui occupe toute la fenêtre du navigateur.

Remarque : Ces informations s'affichent automatiquement lorsque vous appelez le OT.initSession() ou le OT.initPublisher() méthode si le client ne prend pas en charge la Video API de Vonage pour WebRTC.

Remarque : Cette fonction sera obsolète à l'avenir.

Voir : : - OT.checkSystemRequirements()

Evénements

exception

Déclenché par la classe OT lorsque l'application rencontre une exception. Notez que vous devez configurer un gestionnaire d'événements pour le exception événement en appelant la fonction OT.on() méthode.

Voir : : - ExceptionEvent