Paper Contacter le support | état du système L'état du système
Contenu de la page

    CMS API Référence des champs vidéo

    Ceci est une référence aux champs vidéo retournés par le CMS API.

    Champs vidéo

    Champs vidéo
    Champ Type Description
    account_id Chaîne Le système Video Cloud identifiant de compte
    ad_keys Chaîne Chaîne représentant les paires clé / valeur d'annonce affecté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 L'ID de la vidéo source qui a été découpée pour produire cette vidéo ou null si cette vidéo n'est pas un clip d'une autre vidéo.
    complete Boolean 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 rendu existe pour la vidéo, la propriété complète sera automatiquement définie sur true
    created_at Nombre, millisecondes d'une époque Quand la vidéo a été créée dans le Video Cloud système iSun
    created_by objet Informations sur l'auteur de la vidéo, si disponible
    cue_points Tableau de cartes tableau de cartes de points de repère
    custom_fields Carte des paires valeur-champ (chaînes) Valeurs de champ personnalisées définies pour la vidéo - notez que ce champ personnalisé fait n'est pas avoir une valeur pour cette vidéo ne sont pas inclus dans cette carte; les valeurs de champ personnalisées ont une longueur maximale de caractères 1024 à un octet
    dash_manifest_id Chaîne Identifiant du 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 - atout
    • static_origin - ancien système d'ingestion
    • unknown - n'a pas pu être déterminé (peut signifier que la vidéo n'a pas de rendu lisible)
    description Chaîne; prend la place de l'ancien shortDescription Brève description de la vidéo (longueur maximale: caractères 248 à un octet)
    digital_master_id Chaîne L'identifiant du système pour le maître numérique
    drm_disabled Boolean Pour les comptes compatibles DRM, la définition de ce paramètre sur true empêchera la vidéo d'être mise en package 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 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
    geo [1-3] Carte des paires propriété-valeur Propriétés de géo-restriction pour la vidéo
    has_digital_master Boolean Indique si la vidéo contient un maître archivé pouvant être utilisé pour le retranscodage. Notez que si vous utilisez ce champ pour vérifier 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'information sur l'affiche et les vignettes
    link Carte des paires propriété-valeur Carte des propriétés de liens connexes
    long_description Chaîne Description longue (jusqu'à 5000 caractères)
    name Chaîne Le nom de la vidéo (longueur maximale: caractères 248 à un octet)
    offline_enabled Boolean Indique si la vidéo est activée pour la lecture hors connexion
    original_filename Chaîne Nom du fichier vidéo qui a été ingéré - sera null pour les vidéos d'éléments distants
    projection Chaîne La projection cartographique pour les vidéos 360 °, p.ex. "é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 identifie de manière unique la vidéo, limité aux caractères 150. Un ID de référence peut être utilisé comme clé étrangère pour identifier cette vidéo dans un autre système. L'ID de référence ne doit pas contenir d'espaces, de virgules ou de caractères spéciaux.
    schedule [1-1] Carte des paires propriété-valeur Carte des dates et heures 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 pour la vidéo
    smooth_client_manifest_id Chaîne Identifiant du système pour un manifeste lisse
    smooth_server_manifest_id Chaîne Identifiant système pour le serveur de manifeste Smooth
    state [1-4] Chaîne ACTIF, INACTIF, EN ATTENTE, SUPPRIMÉ
    tags [1-5] Tableau de tags (Strings) Tableau des tags attribués à la vidéo
    text_tracks Tableau de pistes de texte de style HTML5 Tableau de pistes de texte (fichiers WebVTT) affectés à 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 Informations sur le dernier auteur de la vidéo, si disponible

    Remarques

    • [1-1] Notez qu'une vidéo programmée est n'est pas inactif 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 Video Cloud système iSun
    • [1-3] La géo-restriction est un complément payé à Video Cloud; si vous souhaitez acheter une fonction de filtrage géographique, contactez votre responsable de compte.
    • [1-4] state peut être réglé sur ACTIVE or INACTIVE, mais n'est pas à PENDING or DELETED.
    • [1-5] Notez les limitations suivantes pour les tags:
      • Les tags peuvent contenir jusqu'à 128. Si des balises ont plus de caractères 128, une erreur s'affichera lorsque vous tenterez d'enregistrer les modifications
      • Les balises ne peuvent pas contenir de virgules; par exemple, une étiquette de roof, attic + front yard est pas supporté
      • Une vidéo ne peut pas contenir plus d'un total de tags 1200
      • Une balise ne différant que par les cas (minuscules, majuscules) est traitée comme une balise identique et la casse correspond 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 chaînes

    Champs de source vidéo

    Les tableaux ci-dessous montrent les champs pour les sources (rendus).

    Sources de livraison dynamiques

    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 d'image 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 de trame en pixels - pour les sources MP4 uniquement

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

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

    Saisie de manifeste HLS hérité

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

    Legacy ingère le manifeste HDS

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

    Manifeste d'héritage

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

    Legacy ingest Smooth manifestests (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 cuepoints.

    Cuepoint Fields
    Champ Type Description
    id Chaîne Identifiant du système pour le point de repère
    force_stop Boolean Si la vidéo doit être arrêtée au point de repère
    metadata Chaîne; point de code seulement Une 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 de repère ( AD or DATA)

    Champs de géo

    Le tableau ci-dessous montre les champs de l'objet géographique.

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

    Champs d'image

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

    Champs de l'affiche

    Champ Type Description
    images.thumbnail Voir sur la Carte Mapper les propriétés de l'image miniature
    poster objet Propriétés pour l'affiche vidéo (alias vidéo encore)
    poster.asset_id Chaîne Identifiant du système pour l'affiche par défaut
    poster.src URL de chaîne URL pour l'affiche par défaut
    poster.sources Tableau de cartes Tableau de cartes pour affiches
    poster.sources.asset_id Chaîne Identifiant du système pour l'affiche
    poster.sources.src URL de chaîne URL pour 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 Identifiant système pour l'image miniature par défaut
    thumbnail.src URL de chaîne URL de la source pour la vignette par défaut
    thumbnail.sources Tableau de cartes Tableau de cartes pour les images miniatures
    thumbnail.sources.asset_id Chaîne Identifiant du système pour la vignette
    thumbnail.sources.src URL de chaîne URL pour la vignette
    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 montre les champs d'objet de lien.

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

    Champs de planification

    Le tableau ci-dessous montre 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 auxquelles 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

    Partage des champs

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

    Partage de champs
    Champ Type Description
    by_external_acct Boolean 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 originale (copie du partageur)
    to_external_acct Boolean Vrai si cette vidéo est partagée avec un autre compte
    by_reference Boolean True est cette vidéo est partagée par référence (sera toujours true pour les vidéos partagées via le CMS API)

    Champs de suivi de texte

    Le tableau ci-dessous montre les champs de suivi de texte.

    Champ Type Description
    id Chaîne ID système pour 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 est destinée à ê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 pour le fichier de piste; null si l'actif est distant
    in_band_metadata_track_dispatch_type Chaîne ID système pour le fichier de piste; null si l'actif est distant
    sources tableau en lecture seule
    src Chaîne Adresse du fichier de piste (URL)
    default Boolean 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 montre le 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 Video Cloud système iSun
    email Chaîne L'adresse email de l'utilisateur dans le Video Cloud système iSun

    Mis à jour par les champs

    Le tableau ci-dessous montre le 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 Video Cloud système iSun
    email Chaîne L'adresse email de l'utilisateur dans le Video Cloud système iSun

    Dernière mise à jour de la page le 12 juin 2020