assistance Contacter le support | Étatétat du système du système
Contenu de la page

    Référence des champs vidéo 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 ID du compte Video Cloud
    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 en tant que clé = valeur et sont séparées par des esperluettes. Par exemple : "adKeys": "category=sports&live=true"
    clip_source_video_id Chaîne 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 clip d'une autre vidéo.
    complete Booléen Indique si le traitement est terminé — Remarque : lorsque vous créez une nouvelle vidéo, la propriété complète est automatiquement définie sur false. Dès qu'un format associé existe pour la vidéo, la propriété complète sera automatiquement définie sur true
    created_at Nombre, millisecondes de l'époque Lorsque la vidéo a été créée dans le système Video Cloud
    created_by Objet Informations sur les personnes qui ont créé la vidéo, le cas échéant
    cue_points Tableau de cartes tableau de cartes de points de repère
    custom_fields Carte des paires champ/valeur (chaînes) Valeurs de champ personnalisées définies pour la vidéo - notez que les champs personnalisés qui n'ont pas de valeur pour cette vidéo ne sont pas inclus dans cette carte ; les valeurs de champ personnalisées ont une longueur maximale de 1024 caractères sur un octet
    dash_manifest_id Chaîne ID système d'un manifeste DASH
    delivery_type Chaîne Type de livraison pour la vidéo :
    • dynamic_origin - livraison dynamique
    • live_origin - streaming en direct de Brightcove Live
    • remote - actif
    • static_origin - système d'ingest hérité
    • unknown - n'a pas pu être déterminé (peut signifier que la vidéo n'a pas de rendus jouables)
    description Chaîne ; prend la place de l'ancienne ShortDescription Brève description de la vidéo (longueur maximale : 248 caractères sur un octet)
    digital_master_id Chaîne ID système du maître numérique
    drm_disabled Booléen Pour les comptes compatibles DRM, la définition de cette valeur sur true empêchera la vidéo d'être empaqueté DRM. Ce champ n'apparaît pas si le compte n'est pas compatible DRM.
    duration Nombre, millisecondes Durée de la vidéo en millisecondes
    economics String, doit être l'une des valeurs enum valides soit « AD_SUPPORTED » (par défaut) ou « FREE »
    folder_id Chaîne ID du dossier auquel appartient la vidéo
    géo [1-3] Carte des paires propriété-valeur Propriétés de restriction géographique pour la vidéo
    has_digital_master Booléen Indique si la vidéo possède un maître 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, elle n'est pas fiable pour les vidéos partagées. Si des vidéos sont partagées sur le compte, vous devez tester has_digital_master = true les sharing.by_external_acct = false
    id Chaîne L'ID de la vidéo
    images Carte des paires propriété-valeur Carte des informations sur l'affiche et les images miniatures
    lien Carte des paires propriété-valeur Carte des propriétés de lien associées
    long_description Chaîne Description longue (jusqu'à 5000 caractères)
    name Chaîne Le nom de la vidéo (longueur maximale : 248 caractères sur un octet)
    offline_enabled Booléen Indique 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 de ressources distantes
    projection Chaîne La projection cartographique pour les vidéos à 360°, par exemple « équirectangulaire »
    published_at Chaîne Chaîne de 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 ID spécifié par l'utilisateur qui identifie la vidéo de manière unique, limitée à 150 caractères. L’option referenceId peut être utilisée comme « foreign-key » pour identifier la vidéo sur un autre système. L'identifiant de référence ne doit pas contenir d'espaces, de virgules ou de caractères spéciaux.
    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 lisse
    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 (Chaînes) Tableau de balises assignées à la vidéo
    text_pistes Tableau de pistes de texte de style HTML5 Tableau de pistes de texte (fichiers WebVTT) assignées à la vidéo
    updated_at Chaîne date-heure Date et heure de la dernière modification de la vidéo [1-2]
    updated_by Objet Information sur la dernière mise à jour de la vidéo, si disponible

    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 restriction géographique est un complément payant de Video Cloud ; si vous souhaitez acheter une fonction de filtrage géo-filtrant, contactez votre gestionnaire de compte
    • [1-4] state peut être réglé sur ACTIVE ou INACTIVE , mais ne pas à PENDING ou DELETED.
    • [ 1-5] Notez les limitations suivantes pour les balises :
      • Les balises peuvent contenir jusqu'à 128 caractères. Si des balises contiennent plus de 128 caractères, une erreur s'affiche lorsque vous tentez d'enregistrer les modifications
      • Les balises ne peuvent pas contenir de virgules ; par exemple, une balise de n' roof, attic + front yard est pas prise en charge
      • Une vidéo ne peut pas avoir plus de 1200 tags
      • Une balise ne diffère que dans la casse (minuscules, majuscules) est traitée comme une balise identique et la casse correspondra automatiquement à celles 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 chaînes

    Champs de source vidéo

    Les tableaux ci-dessous présentent les champs des sources (formats associés).

    Sources de livraison 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 sources MP4 uniquement
    duration Entier Durée en millisecondes - pour les sources MP4 uniquement
    encoding_rate Entier Taux de codage 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 (formats associés)

    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 Long ?
    encoding_rate Long ?
    height Entier
    id Chaîne
    size Long
    uploaded_at Chaîne au format de date ISO-8601
    width Entier

    Manifeste HLS d'ingest hérité

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

    Manifeste HDS d'ingest hérité

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

    Legacy ingest manifeste Dash

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

    Legacy ingest manifeste lisse (serveur et client)

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

    Champs de cuepoint

    Le tableau ci-dessous présente les champs des points de cueillard.

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

    Champs géo

    Le tableau ci-dessous montre les champs d'objet géo.

    Champs de géo-filtrage
    Champ Type Description
    countries Tableau de chaînes de code 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 autorisée à jouer
    exclude_countries Booléen Si la valeur est true, le tableau de pays est traité comme une liste de pays exclus de l'affichage
    restricted Booléen Indique si le filtrage géo-filtrage est activé pour cette vidéo

    Champs d'image

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

    Champs d'affiche

    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 encore)
       poster.asset_id Chaîne ID 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 ID système de l'affiche
         poster.sources.src URL de chaîne URL de l'affiche
         poster.sources.height Nombre Hauteur de l'affiche en pixels
         poster.sources.width Nombre Largeur de l'affiche en pixels

    Champs miniatures

    Champ Type Description
    thumbnail Objet Propriétés de la miniature de la vidéo
       thumbnail.asset_id Chaîne ID système de 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 ID système de la miniature
         thumbnail.sources.src URL de chaîne URL de la vignette
         thumbnail.sources.height Nombre Hauteur de l'image en pixels
         thumbnail.sources.width Nombre Largeur de l'image en pixels

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

    Lier les champs
    Champ Type Description
    url Chaîne URL du lien connexe
    text Chaîne Texte du lien connexe

    Champs de planification

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

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

    Partage des champs

    Le tableau ci-dessous montre les champs d'objet de partage

    Partage des champs
    Champ Type Description
    by_external_acct Booléen True si cette vidéo a été partagée à partir d'un autre compte.
    by_id Chaîne ID de compte à l'origine du partage
    source_id Chaîne ID vidéo de la vidéo originale (copie du sharer)
    to_external_acct Booléen True si cette vidéo est partagée sur un autre compte
    by_reference Booléen True est 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 suivi de texte

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

    Champ Type Description
    id Chaîne ID système de l'élément de suivi 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 le jeu de pistes de texte
    kind Chaîne Comment la piste doit être utilisée : « sous-titres », « légendes », « descriptions », « chapitres », « métadonnées »
    mime_type Chaîne type mime des pistes de texte, par exemple « text/vtt »
    asset_id Chaîne ID système du fichier de piste ; null si asset est distant
    in_band_metadata_track_dispatch_type Chaîne ID système du fichier de piste ; null si asset est distant
    sources Tableau lecture seule
       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 seule piste.

    Créé par des champs

    Le tableau ci-dessous présente les champs created_by d'objet.

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

    Mis à jour par champs

    Le tableau ci-dessous présente les champs updated_by d'objet.

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