Contacter le support
L'état du systèmeIntroduction
Le système d'implants dentaires Playback API est une API à faible latence destinée à être utilisée côté client pour récupérer des données de vidéos ou de listes de lecture à partir de pages Web ou d'applications mobiles. Il est n'est pas une API générale de gestion des médias à utiliser pour l'intégration Video Cloud avec votre CMS ou d’autres systèmes - pour cela, vous devez utiliser le CMS API.
Le système d'implants dentaires Playback API les résultats sont filtrés pour ne renvoyer que les vidéos lisibles (état = ACTIF, indicateur d'ingestion terminée = vrai, et dans des données / heure correctes si prévu). Cela signifie que le player pourra lire la vidéo dès qu'un rendu existe, même si d'autres sont en cours de traitement. Si vous devez récupérer des vidéos qui ne sont pas actuellement lisibles, vous devez à nouveau utiliser le CMS API au lieu.
Sachez également que pour optimiser les performances, les données vidéo accessibles par le Playback API est mis en cache pendant une courte période. La durée de mise en cache d'un ID de jeu de données particulier peut varier, mais peut aller jusqu'à 20 minutes.
Voir aussi le Référence de l'API.
Les cas d'utilisation
Le système d'implants dentaires Brightcove Player et la SDK Brightcove players inclure des méthodes de catalogue identiques aux méthodes de la Playback APIet, pour la plupart, vous pouvez simplement les utiliser si vous ne faites que récupérer des vidéos ou des listes de lecture au moment de l’exécution.
Cependant, vous souhaiterez peut-être fournir une vue de la vidéo ou des listes de lecture dans un écran d'application mobile où aucun player est présent.
En outre, il peut arriver que vous souhaitiez récupérer des vidéos ou des listes de lecture pour afficher des informations à leur sujet, sans avoir player sur l'écran, comme la page de destination d'un portail vidéo, par exemple.
Le système d'implants dentaires Playback API est utile dans ces cas.
Informations générales
URL de base
L'URL de base pour le Playback API est:
https://edge.api.brightcove.com/playback/v1
Chemin du compte
Dans tous les cas, des demandes seront faites pour un Video Cloud Compte. Ainsi, vous ajouterez toujours le terme accounts suivi de votre identifiant de compte à l'URL de base:
https://edge.api.brightcove.com/playback/v1/accounts/{account_id}
Authentification
Les demandes sont authentifiées par une clé de stratégie, qui peut être transmise de l'une des trois manières suivantes:
- Dans un argument à un
Accepten-tête:Accept: application/json;pk={policy_key}C'est la méthode recommandée pour un client basé sur un navigateur, car elle permet à la demande d'aller de l'avant sans demande supplémentaire d'abord dans le cadre de la vérification "pré-vol" CORS du navigateur. Cela permet d'économiser la latence lors de la première demande de navigateur.
- Dans une
Authorizationen-tête utilisant le mot clé realmBCOV-Policy:Authorization: BCOV-Policy {policy_key} - Dans un
BCOV-Policyen-tête:BCOV-Policy: {policy_key}
Obtention d'une clé de stratégie
Vous pouvez obtenir une clé de stratégie de trois façons:
- Chaque Brightcove player est automatiquement attribué un. Vous pouvez trouver des instructions pour obtenir un playerclé de politique de ce document. Étant donné que les clés de stratégie sont valables pour l'ensemble du compte, vous pouvez les utiliser indépendamment du fait player est intégré à la page.
- Vous pouvez générer une clé de stratégie de base à l'aide du Clés de stratégie Démarrage rapide
- Vous pouvez faire une demande à Policy API
Authentification de jeton
L'authentification par jeton pour le contenu HLS et DASH est prise en charge. Si vous avez besoin d'une authentification par jeton, contactez votre responsable de compte pour qu'il soit activé pour votre compte.
Éviter les URL codées en dur
Les URL des vignettes, des affiches, des fichiers vidéo et des autres médias ne doivent jamais être codées en dur dans vos pages ou applications. le Playback API retournera la dernière version en cache des URL pour les fichiers multimédias, mais les URL elles-mêmes sont sujettes à modification. Vous devriez utiliser le CMS API ( ou Playback API ) demande à récupérer ces URL chaque fois que la page se charge, ou les cache pour pas plus de six heures.
Mise en cache des URL de vidéos et d'images
Vous pouvez mettre en cache des URL pour des vidéos et des images afin d'améliorer les performances de la page, mais le cache doit être actualisé régulièrement. Si vous mettez en cache les URL que vous récupérez pour améliorer les performances de vos pages, veillez à actualiser le cache en répétant les appels d'API au moins une fois toutes les six heures.
Méthodes
L'API prend en charge les requêtes GET suivantes uniquement, des types suivants:
Requêtes vidéo
Un seul objet vidéo peut être récupéré en utilisant l'identifiant vidéo ou l'identifiant de référence.
Obtenir la vidéo par identifiant
Endpoint
https://edge.api.brightcove.com/playback/v1/accounts/{account_id}/videos/{video_id}
Exemple
https://edge.api.brightcove.com/playback/v1/accounts/57838016001/videos/38467382999
Exemple de réponse
{
"account_id": "107767373999",
"ad_keys": null,
"created_at": "2010-07-12T22:37:34.760Z",
"description": "Avatar_MakingAScene_Featurette",
"duration": 595560,
"id": "38467382999",
"long_description": null,
"name": "Avatar_MakingAScene_Featurette",
"published_at": "2010-07-12T22:37:34.760Z",
"reference_id": "AvatarMakingShort",
"text_tracks": [],
"updated_at": "2010-07-12T22:54:29.666Z",
"cue_points": [
{
"id": "111637107001",
"name": "Pre-roll",
"type": "AD",
"time": 0,
"metadata": null,
"force_stop": false
}
],
"custom_fields": {
"moretext": "this is the first video uploaded",
"mylist": "abc"
},
"link": {
"text": "Full Dvd at Amazon",
"url": "http://www.amazon.com/Avatar-Sam-Worthington/dp/B002VPE1AW"
},
"tags": [
"copied"
],
"poster_sources": [
{
"src": "http://brightcove04.o.brightcove.com/107767373999/107767373999_111728861001_vs-111727994001.jpg?pubId=107767373999&videoId=38467382999"
}
],
"thumbnail_sources": [
{
"src": "http://brightcove04.o.brightcove.com/107767373999/107767373999_111728862001_th-111727994001.jpg?pubId=107767373999&videoId=38467382999"
}
],
"poster": "http://brightcove04.o.brightcove.com/107767373999/107767373999_111728861001_vs-111727994001.jpg?pubId=107767373999&videoId=38467382999",
"thumbnail": "http://brightcove04.o.brightcove.com/107767373999/107767373999_111728862001_th-111727994001.jpg?pubId=107767373999&videoId=38467382999",
"sources": [
{
"avg_bitrate": 379000,
"width": 320,
"duration": 595560,
"size": 28196307,
"stream_name": "mp4:107767373999/107767373999_111728840001_Avatar-MakingAScene-Featurette.mp4?__nn__=1497926354001&slist=107767373999/&auth=daEciavcicRbhbtdSaBdBdVbXd0aUdTcMaX-bvRrSa-hca-slyCzrux_zJAq_HFCB_EvE&aifp=bcosuds",
"codec": "H264",
"asset_id": "111728840001",
"container": "MP4",
"height": 180,
"app_name": "rtmp://cp150446.edgefcs.net/ondemand"
},
{
"avg_bitrate": 379000,
"width": 320,
"src": "http://uds.ak.o.brightcove.com/107767373999/107767373999_111728840001_Avatar-MakingAScene-Featurette.mp4?pubId=107767373999&videoId=38467382999",
"size": 28196307,
"height": 180,
"duration": 595560,
"container": "MP4",
"codec": "H264",
"asset_id": "111728840001"
}, ... 6 more sources ...
]
}
Obtenir la vidéo par référence
Endpoint
https://edge.api.brightcove.com/playback/v1/accounts/{account_id}/videos/ref:{reference_id}
Exemple
https://edge.api.brightcove.com/playback/v1/accounts/57838016001/videos/ref:nature_2010-07-12
Exemple de réponse
{
"account_id": "107767373999",
"ad_keys": null,
"created_at": "2010-07-12T22:37:34.760Z",
"description": "Avatar_MakingAScene_Featurette",
"duration": 595560,
"id": "38467382999",
"long_description": null,
"name": "Avatar_MakingAScene_Featurette",
"published_at": "2010-07-12T22:37:34.760Z",
"reference_id": "nature_2010-07-12",
"text_tracks": [],
"updated_at": "2010-07-12T22:54:29.666Z",
"cue_points": [
{
"id": "111637107001",
"name": "Pre-roll",
"type": "AD",
"time": 0,
"metadata": null,
"force_stop": false
}
],
"custom_fields": {
"moretext": "this is the first video uploaded",
"mylist": "abc"
},
"link": {
"text": "Full Dvd at Amazon",
"url": "http://www.amazon.com/Avatar-Sam-Worthington/dp/B002VPE1AW"
},
"tags": [
"copied"
],
"poster_sources": [
{
"src": "http://brightcove04.o.brightcove.com/107767373999/107767373999_111728861001_vs-111727994001.jpg?pubId=107767373999&videoId=38467382999"
}
],
"thumbnail_sources": [
{
"src": "http://brightcove04.o.brightcove.com/107767373999/107767373999_111728862001_th-111727994001.jpg?pubId=107767373999&videoId=38467382999"
}
],
"poster": "http://brightcove04.o.brightcove.com/107767373999/107767373999_111728861001_vs-111727994001.jpg?pubId=107767373999&videoId=38467382999",
"thumbnail": "http://brightcove04.o.brightcove.com/107767373999/107767373999_111728862001_th-111727994001.jpg?pubId=107767373999&videoId=38467382999",
"sources": [
{
"avg_bitrate": 379000,
"width": 320,
"duration": 595560,
"size": 28196307,
"stream_name": "mp4:107767373999/107767373999_111728840001_Avatar-MakingAScene-Featurette.mp4?__nn__=1497926354001&slist=107767373999/&auth=daEciavcicRbhbtdSaBdBdVbXd0aUdTcMaX-bvRrSa-hca-slyCzrux_zJAq_HFCB_EvE&aifp=bcosuds",
"codec": "H264",
"asset_id": "111728840001",
"container": "MP4",
"height": 180,
"app_name": "rtmp://cp150446.edgefcs.net/ondemand"
},
{
"avg_bitrate": 379000,
"width": 320,
"src": "http://uds.ak.o.brightcove.com/107767373999/107767373999_111728840001_Avatar-MakingAScene-Featurette.mp4?pubId=107767373999&videoId=38467382999",
"size": 28196307,
"height": 180,
"duration": 595560,
"container": "MP4",
"codec": "H264",
"asset_id": "111728840001"
}, ... 6 more sources ...
]
}
Rechercher des vidéos
Vous devez utiliser un clé de stratégie activée par la recherche, lors de la recherche de vidéos à l'aide du Playback API. Pour plus de détails, voir le Playback API Référence document.
Paramètres
Notez que tous les paramètres sont optionnel. Ils s'appliquent à GET Videos demandes seulement.
| Paramètre | Description |
|---|---|
q |
Chaîne de requête pour les recherches - pour plus de détails, voir la guide de recherche |
limit |
Nombre de vidéos à renvoyer - doit être un nombre entier entre 1 et 100. Par défaut: 20 |
offset |
Nombre de vidéos à ignorer (pour les résultats de recherche de personnes). Doit être un entier positif. Par défaut: 0 |
sort |
Une chaîne qui spécifie le champ à trier. Commencer avec - trier par ordre décroissantSi une valeur pour q est fourni, le tri par défaut est par "score" (pertinence des résultats de recherche à la requête d'origine).Si aucune valeur pour q est fourni, le tri par défaut est par updated_at descendant.Les champs suivants sont valides pour le tri: name, reference_id, created_at, published_at, updated_at, schedule_starts_at, schedule_ends_at, state, plays_total plays_trailing_weekPour plus de détails, voir le Obtenez des vidéos l'article de l' Playback API référence |
Utiliser les paramètres de recherche
Brightcove's Playback API fournit un moyen programmatique pour rechercher des vidéos dans votre Video Cloud bibliothèque.
Pour effectuer des recherches simples et complexes sur vos données vidéo, vous utiliserez q paramètre:
https://edge.api.brightcove.com/playback/v1/accounts/1752604051111/videos?q={search terms}
Pour plus de détails sur la recherche de vidéos, voir Vidéos de la recherche document.
Résultats de pagination
Utilisez le limit paramètre pour spécifier le nombre d'éléments que vous souhaitez renvoyer dans une requête - jusqu'à 100. Vous pouvez ensuite utiliser le offset paramètre pour parcourir les ensembles de résultats qui sont plus grands que le limit. le offset est le nombre d'éléments à ignorer.
Par exemple, la recherche suivante renvoie les vidéos 51-75 du jeu de résultats total, en supposant que le jeu de résultats total comporte au moins des vidéos 75:
/videos?q=updated_at:2014-01-01..2014-06-30&limit=25&offset=50
Le système d'implants dentaires limit et offset les paramètres ne peuvent être utilisés que pour les vidéos.
Meilleures pratiques de pagination
Lorsque vous parcourez votre jeu de résultats à partir du Playback API, il est recommandé de suivre ces étapes:
- Utilisez le
limitetoffsetparamètres pour renvoyer des groupes de données de votre jeu de résultats./accounts/578380111111/videos?q=tags:nature&limit=20&offset=50 - Avec chaque réponse, vous verrez que le
countfield affiche toujours le nombre maximum de vidéos dans votre jeu de résultats.{"count": 171, "videos": [ ... ] } - Le total
countdes vidéos de votre première demande peut être utilisé pour déterminer combien de pages supplémentaires vous aurez besoin de demander.
Alternativement, vous pouvez interroger lecountvaleur avec chaque réponse et continuer jusqu'à lacountest inférieur ou égal à la taille de la page fois lelimit.count <= page-number * limit
Tri des résultats vidéo
Utilisez le paramètre sort=field_name pour spécifier comment les résultats doivent être triés. Vous pouvez trier les champs vidéo suivants:[1-1]
- prénom
- Pièce d'identité
- créé à
- published_at
- updated_at
- schedule_starts_at (note: ceci est le sort champ - le champ de recherche est
schedule.starts_at) - schedule_ends_at (note: ceci est le sort champ - le champ de recherche est
schedule.ends_at) - Etat
- plays_total[1-2]
- plays_trailing_week[1-2]
Remarques
- [1-1] Si vous ne fournissez pas de valeur de tri pour un appel de recherche de vidéo, les résultats seront triés par pertinence. Si vous ne fournissez pas de valeur de tri pour un
GETappel vidéo, les résultats seront triés parupdated_atdescendant. - [1-2] Vous pouvez trier sur
plays_totalorplays_trailing_week, mais ces champs ne sont pas inclus dans les résultats
Toutes les vidéos et les grands ensembles de données
Si vous récupérez toutes les vidéos de votre compte ou un grand nombre de vidéos, vous devez connaître certaines choses:
- Vous pourriez être tenté d'utiliser le plus grand autorisé
limit(100), mais il est préférable de récupérer des vidéos dans des lots de 25 ou moins pour minimiser la possibilité que les demandes d'API arrivent à expiration - Lorsque vous parcourez de grands ensembles de données, il est possible que les données vidéo soient mises à jour pendant l'opération, ce qui peut entraîner le décalage des éléments dans les réponses:
- Vous pourriez voir un article répété sur des pages successives
- Un élément peut être manqué, car il est passé à un ensemble de réponses précédent
Pour prendre en compte la première possibilité, votre application doit redéfinir la liste complète des éléments une fois que vous avez terminé de récupérer les vidéos. Pour gérer la seconde possibilité, vous devez comparer le nombre total d'éléments récupérés (après dédoublonnage) au nombre attendu, puis réexécuter les requêtes, en triant les résultats par last_modified_date (en descendant). Vous ne devriez pas avoir besoin de récupérer plus d'un lot pour ramasser les articles manqués.
- Vous pouvez réduire la probabilité des scénarios de l'élément précédent en triant les résultats renvoyés de manière appropriée. Le tri par défaut par pertinence pour les recherches est basé sur un algorithme complexe qui recherche des combinaisons de mots-clés, de balises et de valeurs de champs personnalisées. Si vous recherchez des vidéos basées sur plusieurs mots-clés, tags et / ou champs personnalisés, trier par pertinence est exactement ce que vous voulez. Cependant, si vous essayez simplement de récupérer tout ou une grande partie de vos vidéos,
sortparamètre explicitement vous donnera plus de contrôle sur l'ordre des éléments retournés.
Obtenez des vidéos
Endpoint
https://edge.api.brightcove.com/playback/v1/accounts/{account_id}/videos
Exemple
https://edge.api.brightcove.com/playback/v1/accounts/57838016001/videos?q=tags:nature,name:nature
Exemple de réponse
{
"count": 123,
"videos":
[
{<video1 fields>},
{<video2 fields>},
...
]
}
Réponse d'erreur
Si vous essayez d'utiliser le point de terminaison Get Videos avec une clé de stratégie qui n'est PAS activée pour la recherche, vous recevrez le message d'erreur suivant du Playback API:
[
{
"api_call": "search",
"error_subcode": "API",
"error_code": "ACCESS_DENIED",
"message": "Access to this resource is forbidden by access policy."
}
]
Trouver des vidéos similaires
Le système d'implants dentaires Playback API vous permet de rechercher dans votre compte des vidéos liées à la vidéo spécifiée. Basé sur name et short description de la vidéo spécifiée, l'API recherche les correspondances partielles dans les champs suivants:
nameshort descriptionlong descriptiontags
Si la restriction géographique est en vigueur, il se peut que vous ne receviez pas une page complète de résultats.
Paramètres
Les paramètres d'URL suivants peuvent être utilisés pour les demandes de vidéos associées à GET:
| Paramètre | Description |
|---|---|
limit |
Le nombre de vidéos à renvoyer (par défaut = 20; maximum = 100) |
ad_config_id |
Ajoutez votre ad_config_id pour renvoyer vidéos avec SSAI |
Par défaut, la réponse contiendra jusqu'à des vidéos 20. Vous pouvez utiliser le limit paramètre pour retourner jusqu'à un maximum de vidéos 100, avec un coût de latence accrue.
Notez qu'il n'y a pas offset paramètre lors de la recherche de vidéos connexes, de sorte que vous ne serez pas en mesure de parcourir les résultats de vos vidéos.
Obtenir des vidéos similaires à l'aide de l'identifiant vidéo
Endpoint
https://edge.api.brightcove.com/playback/v1/accounts/{account_id}/videos/{video_id}/related
Exemple
https://edge.api.brightcove.com/playback/v1/accounts/1752604059001/videos/5565662146001/related
Obtenir des vidéos similaires à l'aide de l'ID de référence
Endpoint
https://edge.api.brightcove.com/playback/v1/accounts/{account_id}/videos/ref:{reference_id}/related
Exemple
https://edge.api.brightcove.com/playback/v1/accounts/1752604059001/videos/ref:nature/related
Exemple de réponse
Dans la réponse ci-dessous, notez qu'il n'y a pas count champ, contrairement à rechercher des vidéos réponse.
{
"videos":
[
{<video1 fields>},
{<video2 fields>},
...
]
}
Réponse d'erreur
Si vous essayez d'utiliser le point de terminaison lié à la recherche avec une clé de stratégie qui n'est PAS activée pour la recherche, vous recevrez le message d'erreur suivant de la Playback API:
[
{
"api_call": "search",
"error_subcode": "API",
"error_code": "ACCESS_DENIED",
"message": "Access to this resource is forbidden by access policy."
}
]
Demande de vidéo avec SSAI
Même si vous n'utilisez PAS de site Web Brightcove player ou les SDK natifs Brightcove de votre application, vous pouvez toujours utiliser l'insertion d'annonces côté serveur (SSAI) avec votre propre player.
Obtenez une vidéo avec SSAI
Pour renvoyer une vidéo avec SSAI, ajoutez votre identifiant de configuration d’annonce sous forme de paramètre URL à votre annonce. Playback API demande. Avec cette demande, vous pouvez utiliser un identifiant vidéo ou un identifiant de référence vidéo.
Endpoint avec paramètre URL
Ajoutez votre ad_config_id à la fin de la Playback API demande:
https://edge.api.brightcove.com/playback/v1/accounts/{account_id}/videos/{video_id}?ad_config_id={ad_config_id}
Exemple
https://edge.api.brightcove.com/playback/v1/accounts/1752604059001/videos/5565662146001?ad_config_id=1234abcd
Dans l'exemple de réponse ci-dessous, vous remarquerez ce qui suit:
- La réponse est similaire à celle si vous n'avez pas inclus d'ID de configuration d'annonce.
- Les éléments de la
sourcesarray contiendra une nouvelle propriété appeléevmap. - Si vous voulez savoir où se trouvent les annonces dans le contenu, vous pouvez lire le fichier VMAP lié dans le
vmappropriété. - Le système d'implants dentaires
srcpropriété dans lesourcesarray contiendra l'URL de la source HLS ou DASH. C'est la même chose que la réponse quand aucun Id de configuration d'annonce n'est utilisé, maissrcaura des annonces cousues avec le contenu principal.
Exemple de réponse
{
"description": "The story of a giant rabbit with a heart bigger than himself. ",
"poster_sources": [
{
"src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/3723496277001/dd5bd69c-e962-4a43-9dbd-94faaaba1785/main/1280x720/5m17s130ms/match/image.jpg"
}
],
"tags": [],
"cue_points": [],
"custom_fields": {},
"account_id": "3723496277001",
"sources": [
{
"ext_x_version": "4",
"vmap": "http://ssaiplayback.prod.boltdns.net/playback/once/v1/vmap/hls/v4/clear/3723496277001/7a3316d9-1b06-4d62-bec8-3919b43fffbb/dd5bd69c-e962-4a43-9dbd-94faaaba1785/content.vmap?bc_token=NTllMTMxYjNfMTdkOTY2YThhNjU5MDk5ZTQ3NDBkNmUxOTYyOGRkNzM0ZjBiM2RjMGEwOThjOGFkYjk1MWQxMzFmNGYzMjA5YQ%3D%3D",
"type": "application/x-mpegURL",
"src": "http://ssaiplayback.prod.boltdns.net/playback/once/v1/hls/v4/clear/3723496277001/7a3316d9-1b06-4d62-bec8-3919b43fffbb/dd5bd69c-e962-4a43-9dbd-94faaaba1785/master.m3u8?bc_token=NTllMTMxYjNfZGM5ZDg0NGM2ZGJjZDcxZTFjOGYyODBlMzM2NmNmMmJkMWNhZDczNWViNzRiMjIwNjg5MjkzZGM0ZmJlMTc1Yw%3D%3D"
},
...
],
"created_at": "2017-05-15T17:09:11.171Z"
}
Exiger ad_config_id
En utilisant le Policy API, vous pouvez créer une clé de stratégie qui vous oblige à inclure le ad_config_id Paramètre d'URL lors de requêtes au Playback API. Pour plus de détails sur la configuration de cette fonctionnalité, voir la Policy API Référence document.
Lorsque la clé de stratégie est définie pour exiger un ad_config_id, et vous ne l'ajoutez pas à un Playback API demande, vous obtiendrez l'erreur suivante:
[
{
"error_subcode": "AD_CONFIG",
"error_code": "ACCESS_DENIED",
"message": "Missing required ad_config_id parameter"
}
]
Requêtes de playlist
Un objet vidéo de playlist peut être récupéré en utilisant soit l'identifiant de la playlist, soit son identifiant de référence.
Paramètres
Les paramètres d'URL suivants peuvent être utilisés pour les demandes de playlist
| Paramètre | Description |
|---|---|
| limite | Le nombre de vidéos à renvoyer (par défaut = 20; maximum = 100) |
| compenser | nombre de vidéos à ignorer (depuis le début de la playlist, par défaut = 0) |
Par exemple, ces paramètres ajoutés à votre demande -? Limite = 40 & offset = 20 - retourneront les vidéos 21-60 dans la playlist (en supposant qu'il y en ait autant).
Obtenir la playlist par identifiant
Endpoint
https://edge.api.brightcove.com/playback/v1/accounts/{account_id}/playlists/{playlist_id}
Exemple
https://edge.api.brightcove.com/playback/v1/accounts/57838016001/playlists/38467382999
Exemple de réponse
Obtenir la playlist par identifiant de référence
Endpoint
https://edge.api.brightcove.com/playback/v1/accounts/{account_id}/playlists/ref:{reference_id}
Exemple
https://edge.api.brightcove.com/playback/v1/accounts/57838016001/playlists/ref:nature_2010-07-12
Exemple de réponse
Légendes
Les sous-titres codés fournissent des informations supplémentaires sur votre vidéo aux personnes qui souhaitent y accéder. Les légendes sont nécessaires pour les personnes sourdes et malentendantes pour accéder à la partie audio de vos vidéos. Si vous êtes nouveau pour les légendes, voir le Vue d'ensemble: Ajout de légendes à une vidéo document.
WebVTT externe
Les légendes WebVTT externes sont des fichiers texte distincts de la vidéo. Vous pouvez associer des fichiers de sous-titres à une vidéo comme suit:
Exemple de réponse
Vous trouverez ci-dessous un exemple de réponse du Playback API où un fichier de légendes WebVTT a été ajouté à une vidéo à l'aide du module Médias. Notez que la piste de texte src les propriétés pointent vers un fichier de légendes externes.
{
"text_tracks": [
{
"mime_type": null,
"account_id": "20318290001",
"default": true,
"sources": [
{
"src": "https://static.3playmedia.com/p/files/2240988/threeplay_transcripts/6418302.vtt?project_id=10127&format_id=51&refresh=1515241856"
}
],
"src": "https://static.3playmedia.com/p/files/2240988/threeplay_transcripts/6418302.vtt?project_id=10127&format_id=51&refresh=1515241856",
"asset_id": null,
"label": "English",
"id": "13d66def-d004-4e75-b160-4ac693eff7d7",
"kind": "captions",
"srclang": "en"
}
],
}
In-manifest WebVTT
Les sous-titres WebVTT In-manifest sont intégrés à vos vidéos. Cela peut être fait lors de la première ingestion de votre vidéo ou après que votre vidéo a été ingérée. Vous pouvez créer des légendes in-manifestes comme suit:
Exemple de réponse
Vous trouverez ci-dessous un exemple de réponse du Playback API où un fichier de légendes WebVTT a été ajouté à une vidéo en utilisant le Dynamic Ingest API. Notez que la piste de texte src Les propriétés pointent vers des fichiers Brightcove internes.
{
"text_tracks": [
{
"mime_type": "text/webvtt",
"account_id": "1752604059001",
"default": false,
"sources": [
{
"src": "http://bcboltbde696aa-a.akamaihd.net/media/v1/text/vtt/clear/1752604059001/3585c49a-5a95-4783-8625-e3af727d094a/92cb36a7-c836-4506-a87f-f649316c0cdf/text.vtt?akamai_token=exp=1518032480~acl=/media/v1/text/vtt/clear/1752604059001/3585c49a-5a95-4783-8625-e3af727d094a/92cb36a7-c836-4506-a87f-f649316c0cdf/text.vtt*~hmac=5aa9f206a8e970efb4cab95278e2e9b16a29b3ccf82951a91245352d9149b173"
},
{
"src": "https://bcboltbde696aa-a.akamaihd.net/media/v1/text/vtt/clear/1752604059001/3585c49a-5a95-4783-8625-e3af727d094a/92cb36a7-c836-4506-a87f-f649316c0cdf/text.vtt?akamai_token=exp=1518032480~acl=/media/v1/text/vtt/clear/1752604059001/3585c49a-5a95-4783-8625-e3af727d094a/92cb36a7-c836-4506-a87f-f649316c0cdf/text.vtt*~hmac=5aa9f206a8e970efb4cab95278e2e9b16a29b3ccf82951a91245352d9149b173"
}
],
"src": "http://bcboltbde696aa-a.akamaihd.net/media/v1/text/vtt/clear/1752604059001/3585c49a-5a95-4783-8625-e3af727d094a/92cb36a7-c836-4506-a87f-f649316c0cdf/text.vtt?akamai_token=exp=1518032480~acl=/media/v1/text/vtt/clear/1752604059001/3585c49a-5a95-4783-8625-e3af727d094a/92cb36a7-c836-4506-a87f-f649316c0cdf/text.vtt*~hmac=5aa9f206a8e970efb4cab95278e2e9b16a29b3ccf82951a91245352d9149b173",
"asset_id": null,
"label": "EN",
"id": "92cb36a7-c836-4506-a87f-f649316c0cdf",
"kind": "captions",
"in_band_metadata_track_dispatch_type": "",
"srclang": "en"
}
],
}
Manifeste
Le manifeste des fichiers vidéo HLS ou DASH contient également les informations nécessaires pour inclure les légendes WebVTT.
HLS
#EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio-0",NAME="en (Main)",DEFAULT=YES,AUTOSELECT=YES,LANGUAGE="en",URI="https://manifest.prod.boltdns.net/manifest/v1/hls/v4/clear/1752604059001/3585c49a-5a95-4783-8625-e3af727d094a/8b12c808-c5ea-47f3-abfa-c23b023db297/10s/rendition.m3u8?fastly_token=NWE3YjU3ZThfNzAwNTczOWM4MWQ4Mzk2NjFkYjVjYmFhYjQwNzY2MWUzM2MyNDM5ZDA5ZGExYTFkMzRmYzA0MDdhOTlmZWJhMw%3D%3D"
#EXT-X-MEDIA:TYPE=SUBTITLES,GROUP-ID="subtitles-0",NAME="EN",DEFAULT=YES,AUTOSELECT=YES,LANGUAGE="en",URI="https://manifest.prod.boltdns.net/manifest/v1/hls/v4/clear/1752604059001/3585c49a-5a95-4783-8625-e3af727d094a/92cb36a7-c836-4506-a87f-f649316c0cdf/rendition.m3u8?fastly_token=NWE3YjU3ZThfNDYzOThkZGJiZTU1NTlhOTdkYzA5OTA3M2UzZGRlYTgzMmRkZmUxMGIxYTJkY2Y5ZDQ1ODFiNTEyMmNiZDVhMw%3D%3D"
#EXT-X-STREAM-INF:PROGRAM-ID=0,BANDWIDTH=519200,CODECS="mp4a.40.2,avc1.420015",RESOLUTION=480x270,AUDIO="audio-0",CLOSED-CAPTIONS=NONE,SUBTITLES="subtitles-0"
https://manifest.prod.boltdns.net/manifest/v1/hls/v4/clear/1752604059001/3585c49a-5a95-4783-8625-e3af727d094a/5f7850d9-9a65-4eee-8810-86a1e18e05fb/10s/rendition.m3u8?fastly_token=NWE3YjU3ZThfY2Q5YmE2ODc2OWFiNTgyZjUxMjc1MzRhNmQxMzA0ZmJmY2RlMGU4ZjBiNDExZGRmNjc3YjQ0OGQ5N2RiOTVmMA%3D%3D
TABLEAU DE BORD
<AdaptationSet mimeType="text/vtt" lang="en">
<Representation bandwidth="256" id="92cb36a7-c836-4506-a87f-f649316c0cdf">
<BaseURL>http://bcboltbde696aa-a.akamaihd.net/media/v1/dash/live/clear/1752604059001/3585c49a-5a95-4783-8625-e3af727d094a/92cb36a7-c836-4506-a87f-f649316c0cdf.vtt?akamai_token=exp=1518032494~acl=/media/v1/dash/live/clear/1752604059001/3585c49a-5a95-4783-8625-e3af727d094a*~hmac=3e2edc412c273f1255f2c18bbbcee7afc6a2edb74573f9295b0f05feda69f0e2</BaseURL>
</Representation>
</AdaptationSet>