LegbaEgressError

expérimentaldepuis 0.1.0@legba-core/realtime

LegbaEgressError

Ce que ça fait

Erreur levée par les méthodes d’EgressService (startRoomCompositeEgress, stopEgress, getEgressStatus, listEgress).

Signature

class LegbaEgressError extends LegbaError {
  constructor(code: EgressErrorCode, message: string);
}

Paramètres

NomTypeRequisDéfautDescription
codeEgressErrorCodeouiUn des codes de EGRESS_ERROR_CODES
messagestringouiMessage actionnable

Retour

Une instance de LegbaEgressError, avec name === "LegbaEgressError".

Erreurs

N/A — c’est la classe d’erreur elle-même.

Exemple minimal

import { LegbaEgressError, EGRESS_ERROR_CODES } from "@legba-core/realtime";

try {
  await egress.getEgressStatus(egressId);
} catch (error) {
  if (error instanceof LegbaEgressError && error.code === EGRESS_ERROR_CODES.EGRESS_FAILED) {
    console.error("l'enregistrement a échoué :", error.message);
  }
}

Exemple complet

Voir createEgressService.

Pièges

  • EGRESS_FAILED est levé par getEgressStatus/stopEgress aussi bien pour un échec réel (ex. stockage inaccessible) que pour un enregistrement abandonné (ex. arrêté avant que le pipeline ait fini de s’initialiser) — toujours lire error.message pour la cause précise, pas seulement le code.

Voir aussi