Disponibilité partage d'écran

Cette page explique comment obtenir une mise à jour des informations d'un appareil à chaque modification.

SSE GET /devices/{id}/stream-status

Cet endpoint utilise le mécanisme SSE (Server-Sent Events), une technologie de communication unidirectionnelle en temps réel. Il permet de recevoir instantanément toutes les mises à jour concernant les informations de status du partage d'écran d'un appareil dans l'API.

Headers

NameValue
Content-Typeapplication/json
AuthorizationBearer <token>

Exemples d'implementation

JavaScript possède une implémentation native d'EventSource. Cependant, il est recommandé d'utiliser un polyfill d'EventSource (tel que "event-source-polyfill" dans cet exemple) pour accéder à des fonctionnalités avancées comme la personnalisation des en-têtes, ce qui est essentiel pour l'inclusion du token Bearer.

// Importer le polyfill
const { EventSourcePolyfill } = require('event-source-polyfill');
// Ton Bearer Token
const token = 'votre token';

// Utiliser EventSourcePolyfill pour envoyer le token dans l'en-tête Authorization
const eventSource = new EventSourcePolyfill('https://mdm.pulse-xr.com/devices/:id/stream-status', {
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

eventSource.onopen = function (data) {
  console.log('connection opened ');
};

eventSource.onmessage = function (event) {
  const updatedDevice = JSON.parse(event.data);
  console.log('Mise à jour du device:', updatedDevice);
  if (newMessage.streaming === true) {
    console.log('✅ Stream prêt');
    eventSource.close();
  }
};

eventSource.onerror = function (err) {
  console.error('Erreur dans la connexion SSE:' + err);
};

Il faut fermer l’EventSource dès que streaming: true est reçu, car le serveur met fin à la connexion juste après. Cela évite une erreur côté client liée à la fermeture volontaire du flux SSE.

Response

{
	"streaming": boolean
}

Sur cette page