Oublier

AbonnementPas d'authentification

Arrêtez un flux en temps réel par son ID. Inchangé dans la nouvelle API.

Aucun changement incompatible

L'appel forget fonctionne de la même manière sur l'API Legacy et la nouvelle API, vous n'avez donc pas besoin de modifier votre code.

Comparaison rapide

Aspect	Legacy API	New API	Action
Point de terminaison	forget	forget	Aucun
Authentification requise	Non	Non	Aucun
Modèle d'ID de flux	`^[\w-]{32,128}$`	`^[\w-]{32,128}$`	Aucun
Champ de réponse `forget`	Facultatif	Facultatif	Aucun

Champs de requête et de réponse

Requête

forget (requis) : l'ID du flux, correspondant à ^[\w-]{32,128}$. Utilisez le subscription.id du flux que vous souhaitez arrêter.
passthrough (optionnel) : données renvoyées dans echo_req.
req_id (optionnel) : un ID qui associe la réponse à votre requête.

Réponse

echo_req et msg_type (forget) : toujours retournés.
forget (optionnel) : 1 signifie que le flux s'est arrêté. 0 signifie que le flux n'existait pas.
req_id : retourné lorsque vous en envoyez un.

Structure de la demande

Legacy APIexemple de demande

{
  "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
}

New APIexemple de demande

{
  "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
}

Structure de réponse

Legacy APIexemple de réponse

{
  "echo_req": {
    "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
  },
  "forget": 1,
  "msg_type": "forget"
}

New APIexemple de réponse

{
  "echo_req": {
    "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
  },
  "forget": 1,
  "msg_type": "forget"
}

Exemples de code

function stopStream(streamId) {
  ws.send(JSON.stringify({ forget: streamId }));
}

ws.onmessage = (event) => {
  const response = JSON.parse(event.data);
  if (response.error) {
    console.error(response.error.message);
    return;
  }
  if (response.msg_type !== 'forget') return;

  if (response.forget === 1) {
    console.log('Stream stopped');
  } else if (response.forget === 0) {
    console.log('Stream did not exist');
  } else {
    console.log('No forget result returned');
  }
};

Points de terminaison d'abonnement Tout oublier

D'autres questions ? Nous contacter