Publisher Max Bitrate

Cette rubrique contient des informations détaillées sur la configuration du débit binaire vidéo maximal à l'aide du Client SDK du client Web Vonage Video. Veuillez noter que l'API est prise en charge par les versions récentes de tous les navigateurs pris en charge. Si vous rencontrez des erreurs, assurez-vous que le client utilise une version à jour du navigateur.

Pour obtenir une vue d'ensemble de l'API de débit binaire maximal de l'éditeur, consultez ce sujet.

Définition et récupération d'un préréglage

L'objet Publisher comprend setVideoBitratePreset() et getVideoBitratePreset() des méthodes. Les setVideoBitratePreset() La méthode accepte des valeurs de type chaîne - "DEFAULT", "BW_SAVER" ou "EXTRA_BW_SAVER" (ou leurs équivalents en minuscules) - et des valeurs de type chaîne. minuscules) - et la méthode getVideoBitratePreset() renvoie ces valeurs (ou "CUSTOM"). Voir aussi Préréglages du débit binaire vidéo pour pour plus de détails sur ces préréglages.

Veuillez noter que les getVideoBitratePreset() la méthode renvoie undefined si aucun préréglage ou débit n'a été défini auparavant.

Les setVideoBitratePreset() a un seul paramètre : preset, la présélection souhaitée.

Exemple :

console.log(publisher.getVideoBitratePreset());  // undefined

await publisher.setVideoBitratePreset('BW_SAVER');  // or 'DEFAULT' or 'EXTRA_BW_SAVER'

console.log(publisher.getVideoBitratePreset());  // 'BW_SAVER'

Les setVideoBitratePreset() peut générer une erreur avec la méthode name de l'objet d'erreur avec la valeur suivante :

  • OT_INVALID_PARAMETER - Présélection non valide. Il doit s'agir de "DEFAULT", "BW_SAVER" ou "EXTRA_BW_SAVER".

  • OT_UNEXPECTED_ERROR_CODE - Une erreur inattendue a été rencontrée et la présélection n'a pas été mise à jour.

Envelopper l'appel à la fonction setVideoBitratePreset() dans un bloc try/catch, même si le nom du preset est correct :

const invalidPreset = 'VERY_FAST';

try {
    await publisher.setVideoBitratePreset(invalidPreset);
} catch (err) {
    console.error(err.name);
    // 'OT_INVALID_PARAMETER'
}

Définition et récupération d'une valeur de débit binaire brute

Si les préréglages prédéfinis ne conviennent pas, vous pouvez définir manuellement une valeur de débit binaire brut personnalisée.

Pour obtenir le débit vidéo maximal actuellement défini pour un éditeur, appelez la fonction getMaxVideoBitrate() d'un objet Publisher. Elle renvoie le débit maximal actuellement défini (en bits par seconde). Si aucune valeur personnalisée n'est définie, la fonction renvoie undefined.

Exemple :

console.log(publisher.getMaxVideoBitrate());

Pour définir une valeur de débit maximale personnalisée (au lieu d'une valeur prédéfinie), utilisez la fonction setMaxVideoBitrate() d'un objet Publisher. Cette fonction n'a qu'un seul paramètre : bitrateBpsle débit maximal souhaité (en bits par seconde), compris entre 5 000 et 10 000 000.

Exemple :

const new_bitrate = 300000; // 300 kbps
await publisher.setMaxVideoBitrate(new_bitrate);

Les setMaxVideoBitrate() peut générer une erreur avec la méthode name de l'objet d'erreur avec la valeur suivante :

  • OT_INVALID_PARAMETER - Débit binaire non valide. La valeur doit être 0 ou un nombre compris entre 5000 et 10000000.
  • OT_UNEXPECTED_ERROR_CODE - Une erreur inattendue a été rencontrée et le débit binaire n'a pas été mis à jour.

Envelopper l'appel à la fonction setVideoBitratePreset() dans un bloc try/catch, même si le nombre transmis est valide.

Voir Définition des valeurs de débit binaire brut pour plus de détails.

Cas particuliers

Le fait de fixer la valeur du débit binaire maximal à 0 supprime toute limitation de débit binaire précédemment définie et rétablit le comportement par défaut.

const zero_bitrate = 0;  // no limitations
const int new_bitrate = 300000; // 300 kbps
publisher.setMaxVideoBitrate(new_bitrate);
// publisher.getMaxVideoBitrate() === 300000

publisher.setMaxVideoBitrate(zero_bitrate);
// publisher.getMaxVideoBitrate() === 0

Appeler le getVideoBitratePreset() après avoir défini un débit binaire personnalisé différent de 0 renvoie CUSTOM.

const zero_bitrate = 0;  // no limitations
const new_bitrate = 1000000; // 1 mbps
publisher.setMaxVideoBitrate(new_bitrate);
// publisher.getVideoBitratePreset() === 'CUSTOM'

publisher.setMaxVideoBitrate(zero_bitrate);
// publisher.getVideoBitratePreset() === 'DEFAULT'

Le récupérateur de débit binaire brut renvoie 0 lorsque l'éditeur utilise un préréglage.

let bitrateBps = publisher.getMaxVideoBitrate();
// bitrateBps === 0

publisher.setVideoBitratePreset('bw_saver);
bitrateBps = publisher.getMaxVideoBitrate();
// bitrateBps === 0

publisher.setVideoBitratePreset('extra_bw_saver');
bitrateBps = publisher.getMaxVideoBitrate();
// bitrateBps === 0

publisher.setMaxVideoBitrate(200000);
bitrateBps = publisher.getMaxVideoBitrate();
// bitrateBps === 200000

publisher.setVideoBitratePreset('default');
bitrateBps = publisher.getMaxVideoBitrate();
// bitrateBps === 0