Référence des champs vidéo de l'API CMS

Ceci est une référence aux champs vidéo renvoyés par l'API CMS.

Champs vidéo

Champs vidéo
Champ Type Description
account_id Chaîne Les Nuage vidéo identifiant de compte
ad_keys Chaîne Chaîne représentant les paires clé/valeur d'annonce attribuées à la vidéo. Les paires clé/valeur sont formatées comme clé=valeur et sont séparées par des esperluettes. Par exemple: "adKeys": "category=sports&live=true"
clip_source_video_id Chaîne L'ID de la vidéo source qui a été coupée pour produire cette vidéo ou null si cette vidéo n'est pas un extrait d'une autre vidéo.
complete Booléen Si le traitement est terminé — Remarque : lorsque vous créez une nouvelle vidéo, la propriété complete est automatiquement définie sur false. Dès qu'un rendu existe pour la vidéo, la propriété complète sera automatiquement définie sur true
created_at Nombre, millisecondes à partir de l'époque Quand la vidéo a été créée dans le système Video Cloud
créé par Objet Informations sur la personne qui a créé la vidéo, si disponible
points de repère Tableau de cartes tableau de cartes de points de repère
custom_fields Carte des paires champ-valeur (Strings) Valeurs de champ personnalisé définies pour la vidéo - notez que le champ personnalisé qui ne ne pas ont une valeur pour cette vidéo ne sont pas inclus dans cette carte ; les valeurs des champs personnalisés ont une longueur maximale de 1024 caractères à un octet
dash_manifest_id Chaîne ID système pour un manifeste DASH
delivery_type Chaîne Type de livraison pour la vidéo :
  • dynamic_origin- livraison dynamique
  • live_origin- diffusion en direct de Brightcove Live
  • remote- actif
  • static_origin- système d'ingestion hérité
  • unknown- n'a pas pu être déterminé (peut signifier que la vidéo n'a pas de rendus lisibles)
description Chaîne de caractères; remplace l'ancien shortDescription Brève description de la vidéo (longueur maximale : 248 caractères à un octet)
digital_master_id Chaîne L'identifiant système du maître numérique
drm_disabled Booléen Pour les comptes compatibles DRM, définir ce paramètre sur true empêchera la vidéo d'être emballée par DRM. Ce champ n'apparaîtra pas si le compte n'est pas compatible DRM.
duration Nombre, millisecondes Durée de la vidéo en millisecondes
economics Chaîne, doit être l'une des valeurs d'énumération valides soit "AD_SUPPORTED" (par défaut) soit "GRATUIT"
folder_id Chaîne ID du dossier auquel appartient la vidéo
forensic_watermarking Chaîne ACTIVE indique que la vidéo a un filigrane médico-légal. UNAVAILBLE signifie que le filigrane médico-légal n'a pas été ajouté. null indique que le compte n'est pas activé pour le filigrane judiciaire.
géo [1-3] Carte des paires propriété-valeur Propriétés de géo-restriction pour la vidéo
has_digital_master Booléen Si la vidéo a un master archivé qui peut être utilisé pour le retranscodage. Notez que si vous utilisez ce champ pour tester si une vidéo peut être retranscodée, il n'est pas fiable pour les vidéos partagées. Si des vidéos sont partagées sur le compte, vous devez tester les deux has_digital_master = true et sharing.by_external_acct = false
id Chaîne L'identifiant de la vidéo
images Carte des paires propriété-valeur Carte d'informations sur l'affiche et les images miniatures
relier Carte des paires propriété-valeur Carte des propriétés des liens associés
long_description Chaîne Description longue (jusqu'à 5000 caractères)
name Chaîne Le nom de la vidéo (longueur maximale : 248 caractères à un octet)
offline_enabled Booléen Si la vidéo est activée pour la lecture hors ligne
original_filename Chaîne Nom du fichier vidéo qui a été ingéré - sera nul pour les vidéos d'éléments distants
playback_rights_id Chaîne L'identifiant unique pour les restrictions de lecture définies dans l' API des droits de lecture.
projection Chaîne La projection cartographique pour les vidéos 360°, par exemple "équirectangulaire"
published_at Chaîne Chaîne date-heure ISO-8601 indiquant quand la vidéo a été publiée - notez que ce champ est accessible en écriture ; par défaut, il est défini sur la date à laquelle la vidéo a été activée pour la première fois.
reference_id Chaîne Un identifiant spécifié par l'utilisateur qui identifie de manière unique la vidéo , limité à 150 caractères. Un referenceId peut être utilisé comme clé étrangère pour identifier cette vidéo dans un autre système.
annexe [1-1] Carte des paires propriété-valeur Carte des dates de début et de fin pour la disponibilité de la vidéo
sharing Carte des paires propriété-valeur Carte des propriétés de partage de la vidéo
smooth_client_manifest_id Chaîne ID système pour un manifeste Smooth
smooth_server_manifest_id Chaîne ID système pour le serveur de manifeste Smooth
state [ 1-4] Chaîne ACTIF, INACTIF, EN ATTENTE, SUPPRIMÉ
tags [ 1-5] Tableau de balises (Strings) Tableau de balises assignées à la vidéo
text_tracks Tableau de pistes de texte de style HTML5 Tableau de pistes de texte (fichiers WebVTT) assignées à la vidéo
transcriptions Tableau de transcriptions en texte brut Tableau des transcriptions (fichiers de texte brut) associées à la vidéo
updated_at Chaîne date-heure Date et heure de la dernière modification de la vidéo [1-2]
Mis à jour par Objet Informations sur la personne qui a mis à jour la vidéo pour la dernière fois, si disponible
variantes Tableau de variant objets de métadonnées Variantes de métadonnées pour différentes langues
ingestion_profile_id Chaîne L'identifiant du profil d'ingestion utilisé pour transcoder cette vidéo. Lire seulement.

Remarques

  • [ 1-1] Notez qu'une vidéo programmée n'est pas inactive en dehors de la période de disponibilité planifiée
  • [ 1-2] La modification peut avoir été effectuée par un utilisateur ou par le système Video Cloud
  • [1-3] La géo-restriction est un module complémentaire payant de Video Cloud ; si vous souhaitez acheter une fonction de géofiltrage, contactez votre Customer Success Manager
  • [1-4] state peut être réglé sur ACTIVE ou INACTIVE , mais ne pas à PENDING ou DELETED.

    La moyenne des états est la suivante :

    • ACTIVE- la vidéo est jouable
    • INACTIVE- la vidéo a été désactivée ou ne contient pas les champs de métadonnées requis et n'est donc pas lisible
    • PENDING- cela est lié au partage de contenu multimédia ; la vidéo a été partagée depuis un autre compte, mais n'a pas encore été acceptée par ce compte
    • DELETED- la vidéo a été supprimée
  • [ 1-5] Notez les limitations suivantes pour les balises :
    • Les balises peuvent contenir jusqu'à 128 caractères. Si des balises ont plus de 128 caractères, une erreur s'affichera lorsque vous tenterez d'enregistrer les modifications
    • Les balises ne peuvent pas contenir de virgules ; par exemple, une balise de roof, attic + front yard n'est pas pris en charge
    • Une vidéo ne peut pas avoir plus de 1200 tags au total
    • Une balise ne différant que par la casse (minuscules, majuscules) est traitée comme une balise identique et la casse correspondra automatiquement à celle de la balise d'origine - les problèmes de sensibilité à la casse doivent être traités en externe à Video Cloud, par exemple, en utilisant des méthodes JavaScript pour modifier Les cordes

Champs de source vidéo

Les tableaux ci-dessous présentent les champs pour les sources (rendus).

Sources de diffusion dynamique

Champ Type Description
src Chaîne URL de la source
type Chaîne Type de vidéo segmentée, généralement application/x-mpegURL (pour HLS) ou application/dash+xml (pour DASH)
ext_x_version Chaîne Version HLS - pour les sources HLS uniquement
profiles Chaîne Profils - pour les sources DASH uniquement
codec Chaîne Codec vidéo - pour les sources MP4 uniquement
container Chaîne Conteneur vidéo - pour les sources MP4 uniquement
duration Entier Durée en millisecondes - pour les sources MP4 uniquement
encoding_rate Entier Taux d'encodage en BPS - pour les sources MP4 uniquement
height Entier Hauteur du cadre en pixels - pour les sources MP4 uniquement
size entier Taille du fichier en octets - pour les sources MP4 uniquement
uploaded_at Chaîne Date à laquelle la vidéo a été téléchargée au format de date ISO-8601
width Entier Largeur du cadre en pixels - pour les sources MP4 uniquement

Sources d'ingestion héritées (rendus)

Champ Type
src URL de chaîne, pour les ressources Web et les ressources HLS uniquement
app_name Chaîne, pour les ressources web en streaming uniquement
stream_name Chaîne, pour les ressources web en streaming uniquement
codec Chaîne
container Chaîne
duration Longue?
encoding_rate Longue?
height Entier
id Chaîne
size Longue
uploaded_at Chaîne au format de date ISO-8601
width Entier

L'ancien manifeste HLS d'ingestion

Champ Type
src URL de chaîne
type Chaîne (application/x-mpegURL)
codec Chaîne
container Chaîne

L'ancien manifeste HDS d'ingestion

Champ Type
asset_id Chaîne
src URL de chaîne
type Chaîne (application/f4m)

Manifeste Dash d'ingestion héritée

Champ Type
asset_id Chaîne
src URL de chaîne
type Chaîne (application/tiret+xml)

Legacy ingérer des manifestes lisses (serveur et client)

Champ Type
asset_id Chaîne
src URL de chaîne
type Chaîne (application/vnd.ms-sstr+xml)

Champs de point de repère

Le tableau ci-dessous montre les champs pour les points de repère.

Champs de point de repère
Champ Type Description
id Chaîne Identifiant système du point de repère
force_stop Booléen Si la vidéo doit être arrêtée au point de repère
metadata Chaîne ; point de code uniquement Une chaîne de métadonnées associée au point de repère
name String Le nom du point de repère
time Flotteur Temps du point de repère en secondes mesuré depuis le début de la vidéo
type String Le type de point de repère ( AD ou DATA)

Champs géographiques

Le tableau ci-dessous montre les champs d'objets géographiques.

Champs de géofiltrage
Champ Type Description
countries Tableau des chaînes de codes de pays Tableau de la liste ISO 3166 de codes à 2 lettres (https://www.iso.org/obp/ui/) pour les pays dans lesquels la vidéo est autorisée ou non à jouer
exclude_countries Booléen Si vrai, le tableau des pays est traité comme une liste de pays exclus de l'affichage
restricted Booléen Si le filtrage géographique est activé pour cette vidéo

Champs d'images

Le tableau ci-dessous montre les champs d'objet image

Champs d'affiches

Champ Type Description
   images.thumbnail Carte Mapper les propriétés de l'image miniature
poster Objet Propriétés de l'affiche vidéo (alias vidéo fixe)
   poster.asset_id Chaîne Identifiant système de l'affiche par défaut
   poster.src URL de chaîne URL de l'affiche par défaut
   poster.sources Tableau de cartes Tableau de cartes pour affiches
     poster.sources.asset_id Chaîne Identifiant système de l'affiche
     poster.sources.src URL de chaîne URL de l'affiche
     poster.sources.height Numéro Hauteur de l'affiche en pixels
     poster.sources.width Numéro Largeur de l'affiche en pixels

Champs de vignettes

Champ Type Description
thumbnail Objet Propriétés de la miniature de la vidéo
   thumbnail.asset_id Chaîne ID système pour l'image miniature par défaut
   thumbnail.src URL de chaîne URL source de la miniature par défaut
   thumbnail.sources Tableau de cartes Tableau de cartes pour les images miniatures
     thumbnail.sources.asset_id Chaîne Identifiant système pour la vignette
     thumbnail.sources.src URL de chaîne URL de la miniature
     thumbnail.sources.height Numéro Hauteur de l'image en pixels
     thumbnail.sources.width Numéro Largeur de l'image en pixels

Le tableau ci-dessous présente les champs de l'objet de lien.

Champs de lien
Champ Type Description
url Chaîne URL du lien associé
text Chaîne Texte du lien connexe

Champs de planification

Le tableau ci-dessous présente les champs de l'objet de planification

Champs de planification
Champ Type Description
ends_at Chaîne au format de date ISO-8601 Date et heure à laquelle la vidéo n'est plus disponible pour la visualisation
starts_at Chaîne au format de date ISO-8601 Date-heure à laquelle la vidéo devient disponible pour la visualisation

Champs de partage

Le tableau ci-dessous présente les champs de l'objet de partage

Champs de partage
Champ Type Description
by_external_acct Booléen Vrai si cette vidéo a été partagée à partir d'un autre compte.
by_id Chaîne Identifiant du compte à l'origine du partage
source_id Chaîne ID vidéo de la vidéo d'origine (copie du partageur)
to_external_acct Booléen Vrai si cette vidéo est partagée avec un autre compte
by_reference Booléen Il est vrai que cette vidéo est partagée par référence (sera toujours true pour les vidéos partagées via l'API CMS)

Champs de piste de texte

Le tableau ci-dessous montre les champs de la piste de texte.

Champ Type Description
id Chaîne Identifiant système pour l'élément de pistes de texte
src Chaîne Adresse du fichier de piste (URL)
srclang Chaîne Langue de la piste, par exemple "en"
label Chaîne Un titre lisible par l'utilisateur pour l'ensemble de pistes de texte
kind Chaîne Comment la piste est censée être utilisée : subtitles captions, descriptions, chapters, metadata
mime_type Chaîne type mime des pistes de texte, par exemple "text/vtt"
asset_id Chaîne Identifiant système du fichier de piste ; null si l'actif est distant
in_band_metadata_track_dispatch_type Chaîne Identifiant système du fichier de piste ; null si l'actif est distant
status Chaîne État des pistes : published draft, ou null
sources baie lecture seulement
   src Chaîne Adresse du fichier de piste (URL)
default Booléen Indique que la piste doit être activée par défaut. Ne devrait être vrai que sur une piste.

Champs de transcription

Le tableau ci-dessous présente les champs de transcription.

Champ Type Description
id Chaîne Identifiant système pour l'élément de pistes de texte
account_id Chaîne L'identifiant du compte système
src Chaîne Adresse du fichier de piste (URL)
srclang Chaîne Langue de la piste, par exemple "en" ou "ex-MX" - ce champ peut être mis à jour
label Chaîne Un titre lisible par l'utilisateur pour l'ensemble de textes - ce champ peut être mis à jour
status Chaîne Le statut de la transcription, published soit draft: ce champ peut être mis à jour
sources baie lecture seule : tableau d'URL où la transcription peut être récupérée par un client ; il y aura une https URL http et pour chaque transcription
default Booléen Indique que la piste doit être activée par défaut. Ne devrait être vrai que sur une piste.

Créé par champs

Le tableau ci-dessous montre les created_by champs d'objet.

Créé par les champs
Champ Type Description
type Chaîne Le type du programme de mise à jour - soit :
  • user- un utilisateur dans Studio
  • api-key- un utilisateur via une API
id Chaîne L'identifiant de l'utilisateur dans le système Video Cloud
email Chaîne L'adresse e-mail de l'utilisateur dans le système Video Cloud

Mise à jour par champs

Le tableau ci-dessous montre les updated_by champs d'objet.

Mis à jour par les champs
Champ Type Description
type Chaîne Le type du programme de mise à jour - soit :
  • user- un utilisateur dans Studio
  • api-key- un utilisateur via une API
id Chaîne L'identifiant de l'utilisateur dans le système Video Cloud
email Chaîne L'adresse e-mail de l'utilisateur dans le système Video Cloud

Champs de variante

Le tableau ci-dessous montre les variant champs d'objet.

Mis à jour par les champs
Champ Type Description
language Chaîne La langue de cette variante au format du code langue-pays (exemples : en-US, es-ES). Noter que language n'est inclus que lorsque vous créez une variante - vous ne devez PAS l'inclure lors de la mise à jour de la variante
name Chaîne Le titre de la vidéo dans cette langue
description Chaîne Le titre de la vidéo dans cette langue
long_description Chaîne Le titre de la vidéo dans cette langue
custom_fields Objet carte de fieldname: value paires, où les valeurs sont pour cette langue ; les valeurs ont une longueur maximale de 1024 caractères à un octet. Remarque : veillez à utiliser le interne nom pour le champ, pas le nom d'affichage/td>