https://gateway.streamfizz.live/apiLance la transcription automatique d'un média et crée la piste de sous-titres correspondante. Le traitement est asynchrone : la piste retournée est en statut Pending. Consomme le quota de durée de transcription.
L'encodage du média doit être terminé : la transcription part de sa piste
audio. Appelée trop tôt, la mutation est refusée avec le code
MEDIA_NOT_ENCODED — attendre que encoding.phase vaille Ready ou
Degraded. Un média dont l'analyse ne trouve aucune piste audio est refusé
avec le code MEDIA_HAS_NO_AUDIO, sans créer de piste ni consommer de
quota.
| Nom | Type | Description |
|---|---|---|
mediaId* | ID! | Identifiant du média à transcrire. |
languages | [Language!] | Langues parlées dans le média. Une seule langue fige la source, plusieurs activent la bascule automatique entre ces langues. Omettre pour laisser la détection automatique décider. Chaque langue doit porter l'opération Transcribe — voir getLanguages. |
Media| Nom | Type | Description |
|---|---|---|
id | ID! | Identifiant unique du média. |
title | String | Titre du média. |
type | MediaType | Type de média. |
sourceKey | String | Clé S3 du fichier source original. |
fileName | String! | Nom du fichier source. Pour un média créé par l'API depuis une URL, c'est
le dernier segment de l'URL normalisé : minuscules, espaces et caractères
spéciaux remplacés par des tirets ( |
cote | String | Cote ou référence métier interne. |
note | String | Note interne sur le média. |
myCapability | AuthzCapability! | Ce que l'appelant a le droit de faire sur ce contenu, compte tenu de ses
groupes et de ses accès directs : |
encodingVersion | String | Version actuelle d'encodage (ex: "v0", "v2.1"). |
isEncoding | Boolean! | Un encodage de la version courante est en cours. Faux pour un média sans encodage lancé (créé sans fichier) ou en version v0. |
duration | Float | Durée du média en secondes. Vaut 0 tant que l'encodage ne l'a pas mesurée. |
ratio | Float | Ratio d'aspect (largeur / hauteur). |
playlistKey | String | Clé S3 de la playlist HLS. |
playlistCdnUrl | String | URL CDN de la playlist HLS. |
thumbKeys | [String] | Clés S3 des miniatures générées. |
thumbCdnUrls | [String] | URLs CDN des miniatures générées. |
selectedThumbKey | String | Clé S3 de la miniature sélectionnée. |
selectedThumbCdnUrl | String | URL CDN de la miniature sélectionnée. |
thumbnailVttCdnUrl | String | URL CDN du fichier VTT des vignettes de prévisualisation. |
deltaChapter | Int | Décalage en secondes appliqué aux points de chapitre à la lecture, pour rattraper la latence d'encodage et de diffusion. |
publicUrl | String | URL de la page de lecture publique. |
publicEmbedUrl | String | URL d'intégration (embed) publique. |
publisher | User! | Utilisateur ayant publié le média. |
account | Account | Compte propriétaire du média. |
accessGroups | [Group!]! | - |
directUsers | [PublicUser!]! | - |
createdAt | DateTime! | Date de création du média. |
updatedAt | DateTime! | Date de dernière modification du média. |
encoding | Encoding! | État d'encodage de la version servie. |
pendingEncoding | Encoding | Ré-encodage en cours, s'il y en a un : il remplacera la version servie une fois terminé. Null sinon. |
mediaInfos | Json | Infos techniques d'encodage (ffprobe-like pour v1+, array typé pour v0 legacy). |
subtitles | [Subtitle!] | Sous-titres associés au média. |
files | [File!] | Fichiers joints au média. |
chapters | [Chapter] | Chapitres associés au média. |
clips | [Clip!] | Clips dérivés du média. |
live | Live | Live associé si ce média est un replay. |
discussion | Discussion | Discussion (chat) associée au média. |
moderatorContents | [ModeratorContent] | Modérateurs désignés pour ce média. |
relatedTags | [Tag] | Tags rattachés. |
relatedCategories | [Category] | Catégories rattachées. |
pageSetting | BrandSetting | Paramètres de personnalisation de la page de lecture. |
embedSetting | BrandSetting | Paramètres de personnalisation de l'embed. |
preRoll | RollPreset | Annonce intro associée. |
postRoll | RollPreset | Annonce outro associée. |
seo | SEO | Paramètres SEO de la page de lecture. |
confidentiality | Confidentiality | Niveau de confidentialité (nouveau modèle). |
privacy | Privacy | Inscription des spectateurs. |
playlists | PlaylistConnection | Playlists contenant ce média. |
webTVs | WebTVConnection | WebTVs contenant ce média. |
metadata | MediaMetadata | Métadonnées descriptives (production, auteur, contenu). |
originalPublisher | DeletedUser | - |
Le traitement se fait en arrière-plan et rien ne vous rappellera : la piste revient en statut Pending, puis passe à Processing et enfin Ready. Relisez-la sur le média pour suivre son avancement — quelques secondes suffisent entre deux appels, une transcription se compte en minutes.
{
getMedia(id: "MEDIA_ID") {
subtitles {
id
label
languages
source
status
cdnUrl
}
}
}cdnUrl reste null tant que le statut n'est pas Ready. Un statut Error est définitif : la piste ne se reprendra pas toute seule.| Code | Message | Description |
|---|---|---|
UNAUTHENTICATED | Invalid or expired API key | Clé API manquante ( |
API_ADDON_REQUIRED | This account does not have the API addon | La clé est valide mais le compte n'a pas l'option API. La réponse porte un code HTTP 403 ; la requête n'est pas exécutée. |
INPUT_VALIDATION_ERROR | Validation failed: {field}: {message} | Un ou plusieurs champs sont invalides (format, longueur, protocole…). Le détail est dans extensions.fieldErrors[]. Tout argument texte qui n'est pas de l'Unicode valide — caractère NUL ( |
GRAPHQL_VALIDATION_FAILED | Query depth limit of 10 exceeded, found {depth}. | Le document ne respecte pas le schéma : champ ou argument inconnu, valeur écrite en dur dans la requête qui n'a pas le type attendu (valeur d'enum inexistante…), ou limite par requête dépassée (profondeur, coût, alias, directives — voir Rate Limiting). La réponse porte un code HTTP 400 ; rien n'est exécuté. |
BAD_USER_INPUT | Variable "$name" got invalid value {value}; {reason} | Une variable ( |
INTERNAL_SERVER_ERROR | Internal server error | Erreur interne du serveur. Le message est volontairement générique : le détail est journalisé côté Streamfizz, jamais renvoyé. |
| Code | Message | Description |
|---|---|---|
LANGUAGE_NOT_TRANSCRIBABLE | Language '{language}' does not support Transcribe | Une des langues demandées ne peut pas être transcrite. Les variantes régionales (pt_br, en_us…) n'existent que pour la traduction. |
QUOTA_EXCEEDED | The quota for TRANSCRIPT_DURATION has been exceeded | Le quota de durée de transcription du compte est atteint. |
TRANSCRIPT_LIMITATION | You cannot transcript a file longer than 4 hours | Le média dépasse la durée maximale transcriptible (4 heures) |
MEDIA_NOT_ENCODED | The media encoding is not finished yet: transcription requires the audio track | L'encodage du média n'est pas terminé : la piste audio dont part la transcription n'existe pas encore. Attendre que |
MEDIA_HAS_NO_AUDIO | The media has no audio track: there is nothing to transcribe | L'analyse du média ne trouve aucune piste audio : il n'y a rien à transcrire. Aucune piste n'est créée et le quota n'est pas consommé. |
NOT_FOUND | Media '{id}' not found | Le média n'existe pas ou n'appartient pas au compte |
60 requêtes par minute par clé API
En cas de dépassement, une erreur 429 Too Many Requests est retournée.