WebRTC - API RTCDataChannel

WebRTC n'est pas seulement efficace pour transférer des flux audio et vidéo, mais aussi toutes les données arbitraires que nous pourrions avoir. C'est là que l'objet RTCDataChannel entre en jeu.

API RTCDataChannel

Propriétés

  • RTCDataChannel.label (read only) - Renvoie une chaîne contenant le nom du canal de données.

  • RTCDataChannel.ordered (read only) - Renvoie vrai si l'ordre de livraison des messages est garanti ou faux s'il n'est pas garanti.

  • RTCDataChannel.protocol (read only) - Renvoie une chaîne contenant le nom du sous-protocole utilisé pour ce canal.

  • RTCDataChannel.id (read only) - Renvoie un identifiant unique pour le canal qui est défini à la création de l'objet RTCDataChannel.

  • RTCDataChannel.readyState (read only)- Renvoie l'énumération RTCDataChannelState représentant l'état de la connexion. Les valeurs possibles -

    • connecting- Indique que la connexion n'est pas encore active. C'est l'état initial.

    • open - Indique que la connexion est en cours d'exécution.

    • closing- Indique que la connexion est en cours d'arrêt. Les messages mis en cache sont en cours d'envoi ou de réception, mais aucune tâche nouvellement créée n'accepte.

    • closed - Indique que la connexion n'a pas pu être établie ou a été arrêtée.

  • RTCDataChannel.bufferedAmount (read only)- Renvoie le nombre d'octets mis en file d'attente pour l'envoi. Il s'agit de la quantité de données qui n'a pas encore été envoyée via RTCDataChannel.send ().

  • RTCDataChannel.bufferedAmountLowThreshold- Renvoie le nombre d'octets auquel le RTCDataChannel.bufferedAmount est pris comme bas. Lorsque RTCDataChannel.bufferedAmount diminue en dessous de ce seuil, l'événement bufferedamountlow est déclenché.

  • RTCDataChannel.binaryType- Renvoie le type des données binaires transmises par la connexion. Peut être «blob» ou «arraybuffer».

  • RTCDataChannel.maxPacketLifeType (read only) - Renvoie un court non signé qui indique la durée en millisecondes de la fenêtre lorsque la messagerie passe en mode non fiable.

  • RTCDataChannel.maxRetransmits (read only) - Renvoie un short non signé qui indique le nombre maximum de fois qu'un canal retransmettra des données s'il n'est pas livré.

  • RTCDataChannel.negotiated (read only) - Renvoie un booléen qui indique si le canal a été négocié par l'agent utilisateur ou par l'application.

  • RTCDataChannel.reliable (read only) - Renvoie un booléen qui indique que la connexion peut envoyer des messages en mode non fiable.

  • RTCDataChannel.stream (read only) - Synonyme de RTCDataChannel.id

Gestionnaires d'événements

  • RTCDataChannel.onopen- Ce gestionnaire d'événements est appelé lorsque l'événement open est déclenché. Cet événement est envoyé lorsque la connexion de données a été établie.

  • RTCDataChannel.onmessage- Ce gestionnaire d'événements est appelé lorsque l'événement de message est déclenché. L'événement est envoyé lorsqu'un message est disponible sur le canal de données.

  • RTCDataChannel.onbufferedamountlow- Ce gestionnaire d'événements est appelé lorsque l'événement bufferedamoutlow est déclenché. Cet événement est envoyé lorsque RTCDataChannel.bufferedAmount diminue en dessous de la propriété RTCDataChannel.bufferedAmountLowThreshold.

  • RTCDataChannel.onclose- Ce gestionnaire d'événements est appelé lorsque l'événement close est déclenché. Cet événement est envoyé lorsque la connexion de données a été fermée.

  • RTCDataChannel.onerror- Ce gestionnaire d'événements est appelé lorsque l'événement d'erreur est déclenché. Cet événement est envoyé lorsqu'une erreur a été rencontrée.

Méthodes

  • RTCDataChannel.close() - Ferme le canal de données.

  • RTCDataChannel.send()- Envoie les données du paramètre sur le canal. Les données peuvent être un objet blob, une chaîne, un ArrayBuffer ou un ArrayBufferView.