Support Kontakt Support | Systemstatus Systemstatus
Seiteninhalt

    CMS API Videofeldreferenz

    Dies ist ein Verweis auf die von der CMS API.

    Videofelder

    Videofelder
    Feld Typ Beschreibung
    account_id Schnur Das Video Cloud Konto-ID
    ad_keys Schnur Zeichenfolge, die die dem Video zugewiesenen Anzeigenschlüssel- / Wertpaare darstellt. Schlüssel / Wert-Paare sind als Schlüssel = Wert formatiert und durch Und-Zeichen getrennt. Beispielsweise: "adKeys": "category=sports&live=true"
    clip_source_video_id Schnur Die ID des Quellvideos, das zum Erstellen dieses Videos abgeschnitten wurde null wenn dieses Video kein Clip eines anderen Videos ist.
    complete Boolean Ob die Verarbeitung abgeschlossen ist - Hinweis: Wenn Sie ein neues Video erstellen, wird die vollständige Eigenschaft automatisch auf festgelegt false. Sobald eine Wiedergabe für das Video vorhanden ist, wird die vollständige Eigenschaft automatisch auf eingestellt true
    created_at Anzahl, Millisekunden von der Epoche Wenn das Video in der erstellt wurde Video Cloud System
    created_by Objekt Informationen darüber, wer das Video erstellt hat, sofern verfügbar
    cue_points Array von Karten Array von Cue-Point-Karten
    custom_fields Karte von Feld-Wert-Paaren (Strings) Benutzerdefinierte Feldwerte für das Video - beachten Sie, dass das benutzerdefinierte Feld dies tut nicht einen Wert für dieses Video haben, sind in dieser Map nicht enthalten; Benutzerdefinierte Feldwerte haben eine maximale Länge von 1024-Einzelbytezeichen
    dash_manifest_id Schnur System-ID für ein DASH-Manifest
    delivery_type Schnur Lieferart für das Video:
    • dynamic_origin - dynamische Lieferung
    • live_origin - Live-Stream von Brightcove Live
    • remote - Vermögenswert
    • static_origin - altes Aufnahmesystem
    • unknown - konnte nicht ermittelt werden (kann bedeuten, dass das Video keine abspielbaren Wiedergaben hat)
    description Schnur; tritt an die Stelle der alten shortDescription Kurzbeschreibung des Videos (maximale Länge: 248 Single-Byte-Zeichen)
    digital_master_id Schnur Die System-ID für den digitalen Master
    drm_disabled Boolean Wenn Sie dies für DRM-fähige Konten auf true setzen, wird verhindert, dass das Video DRM-gepackt wird. Dieses Feld wird nicht angezeigt, wenn das Konto nicht DRM-fähig ist.
    duration Anzahl, Millisekunden Dauer des Videos in Millisekunden
    economics String, muss einer der gültigen Enum-Werte sein entweder "AD_SUPPORTED" (Standard) oder "FREE"
    folder_id Schnur ID des Ordners, zu dem das Video gehört
    geo [1-3] Karte von Eigenschaft-Wert-Paaren Geo-Einschränkungseigenschaften für das Video
    has_digital_master Boolean Gibt es ein Video, das einen archivierten Master enthält, der für die erneute Übertragung verwendet werden kann? Wenn Sie dieses Feld verwenden, um zu testen, ob ein Video erneut übertragen werden kann, ist es für freigegebene Videos nicht zuverlässig. Wenn Videos für das Konto freigegeben werden, müssen Sie beide testen has_digital_master = true und sharing.by_external_acct = false
    id Schnur Die Video-ID
    images Karte von Eigenschaft-Wert-Paaren Karte mit Informationen zu den Poster- und Thumbnail-Bildern
    link Karte von Eigenschaft-Wert-Paaren Karte der verwandten Linkeigenschaften
    long_description Schnur Lange Beschreibung (bis zu 5000-Zeichen)
    name Schnur Der Name des Videos (maximale Länge: 248 Single-Byte-Zeichen)
    offline_enabled Boolean Gibt an, ob das Video für die Offline-Wiedergabe aktiviert ist
    original_filename Schnur Der Name der Videodatei, die aufgenommen wurde - ist für entfernte Asset-Videos ungültig
    projection Schnur Die Mapping-Projektion für 360 ° -Videos, zB "equirectangular"
    published_at Schnur ISO-8601 Datum-Uhrzeit-String, der angibt, wann das Video veröffentlicht wurde - beachten Sie, dass dieses Feld beschreibbar ist; Standardmäßig ist es auf das Datum eingestellt, an dem das Video zum ersten Mal aktiviert wurde.
    reference_id Schnur Eine benutzerdefinierte ID, die identifiziert das Video eindeutig, beschränkt auf 150-Zeichen. Eine Referenz-ID kann als Fremdschlüssel verwendet werden, um dieses Video in einem anderen System zu identifizieren. Die Referenz-ID darf keine Leerzeichen, Kommas oder Sonderzeichen enthalten.
    schedule [1-1] Karte von Eigenschaft-Wert-Paaren Karte der Anfangs- und Enddatumszeiten für die Videoverfügbarkeit
    sharing Karte von Eigenschaft-Wert-Paaren Karte der Freigabeeigenschaften für das Video
    smooth_client_manifest_id Schnur System-ID für ein Smooth-Manifest
    smooth_server_manifest_id Schnur System-ID für den Smooth-Manifest-Server
    state [1-4] Schnur AKTIV, INAKTIV, ANSTEHEND, GELÖSCHT
    tags [1-5] Array von Tags (Strings) Array von Tags, die dem Video zugewiesen sind
    text_tracks Array von HTML5-artigen Textspuren Array von Textspuren (WebVTT-Dateien), die dem Video zugewiesen sind
    updated_at Datum-Uhrzeit-Zeichenfolge Datum und Uhrzeit der letzten Änderung des Videos [1-2]
    updated_by Objekt Informationen dazu, wer das Video zuletzt aktualisiert hat, sofern verfügbar

    Einschränkungen

    • [1-1] Beachten Sie, dass ein geplantes Video ist nicht inaktiv außerhalb des Zeitraums der geplanten Verfügbarkeit
    • [1-2] Die Änderung kann von einem Benutzer oder dem Benutzer vorgenommen worden sein Video Cloud System
    • [1-3] Geo-Restriktion ist eine kostenpflichtige Ergänzung zu Video Cloud; Wenn Sie Geofilter-Funktionen erwerben möchten, wenden Sie sich an Ihren Account Manager
    • [1-4] state kann eingestellt werden ACTIVE or INACTIVE, Aber nicht zu PENDING or DELETED.
    • [1-5] Beachten Sie die folgenden Einschränkungen für Tags:
      • Tags können bis zu 128-Zeichen enthalten. Wenn Tags mehr als 128-Zeichen enthalten, wird beim Versuch, Änderungen zu speichern, ein Fehler angezeigt
      • Tags dürfen keine Kommas enthalten. zum Beispiel ein Tag von roof, attic + front yard wird nicht unterstützt,
      • Ein Video darf nicht mehr als insgesamt 1200-Tags enthalten
      • Ein Tag, der sich nur in Groß- und Kleinbuchstaben unterscheidet, wird als identisches Tag behandelt und das Case wird automatisch mit dem des ursprünglichen Tags übereinstimmen - Probleme mit Groß- / Kleinschreibung müssen extern behandelt werden Video CloudVerwenden Sie beispielsweise JavaScript-Methoden zum Ändern der Zeichenfolgen

    Videoquellenfelder

    Die folgenden Tabellen zeigen Felder für die Quellen (Darstellungen).

    Dynamische Lieferquellen

    Feld Typ Beschreibung
    src Schnur URL für die Quelle
    type Schnur Normalerweise segmentierter Videotyp application/x-mpegURL (für HLS) oder application/dash+xml (für DASH)
    ext_x_version Schnur HLS-Version - nur für HLS-Quellen
    profiles Schnur Profile - nur für DASH-Quellen
    codec Schnur Video-Codec - nur für MP4-Quellen
    container Schnur Video-Container - nur für MP4-Quellen
    duration ganze Zahl Dauer in Millisekunden - nur für MP4-Quellen
    encoding_rate ganze Zahl Kodierungsrate in BPS - nur für MP4-Quellen
    height ganze Zahl Rahmenhöhe in Pixeln - nur für MP4-Quellen
    size ganze Zahl Dateigröße in Bytes - nur für MP4-Quellen
    uploaded_at Schnur Datum, an dem das Video im ISO-8601-Datumsformat hochgeladen wurde
    width ganze Zahl Rahmenbreite in Pixel - nur für MP4-Quellen

    Legacy Ingest Quellen (Renditions)

    Feld Typ
    src Zeichenfolge URL, nur für PD-Web-Assets und HLS-Assets
    app_name Schnur, nur zum Streaming von Web-Assets
    stream_name Schnur, nur zum Streaming von Web-Assets
    codec Schnur
    container Schnur
    duration Lange?
    encoding_rate Lange?
    height ganze Zahl
    id Schnur
    size Lang
    uploaded_at Zeichenfolge im ISO-8601-Datumsformat
    width ganze Zahl

    Legacy-Aufnahme HLS-Manifest

    Feld Typ
    src Zeichenfolge-URL
    type Zeichenfolge (application / x-mpegURL)
    codec Schnur
    container Schnur

    Vermächtnis HDS-Manifest einnehmen

    Feld Typ
    asset_id Schnur
    src Zeichenfolge-URL
    type String (Anwendung / f4m)

    Legacy-Insert Dash-Manifest

    Feld Typ
    asset_id Schnur
    src Zeichenfolge-URL
    type Zeichenfolge (application / dash + xml)

    Legacy-Ingest Glatte Manifeste (Server und Client)

    Feld Typ
    asset_id Schnur
    src Zeichenfolge-URL
    type Zeichenfolge (application / vnd.ms-sstr + xml)

    Cuepoint-Felder

    Die folgende Tabelle zeigt Felder für Cuepoints.

    Stichwortpunkte
    Feld Typ Beschreibung
    id Schnur System-ID für den Cue-Point
    force_stop Boolean Gibt an, ob das Video am Cue-Point angehalten werden soll
    metadata Schnur; Codepunkt nur Eine Metadaten-Zeichenfolge, die dem Cue-Point zugeordnet ist
    name Schnur Der Name des Cue-Points
    time Schwimmer Die Zeit des Cue-Points in Sekunden, gemessen vom Start des Videos
    type Schnur Der Cue-Point-Typ ( AD or DATA)

    Geo-Felder

    Die folgende Tabelle zeigt die Geo-Objektfelder.

    Geo-Filter-Felder
    Feld Typ Beschreibung
    countries Array der Ländercodes Strings Reihe von ISO 3166-Listen mit 2-Buchstabencodes (https://www.iso.org/obp/ui/) für Länder, in denen das Video abgespielt werden darf oder nicht
    exclude_countries Boolean Wenn dies der Fall ist, wird das Länderarray als Liste der Länder behandelt, die von der Anzeige ausgeschlossen sind
    restricted Boolean Ob Geo-Filter für dieses Video aktiviert ist

    Bildfelder

    Die folgende Tabelle zeigt Bildobjektfelder

    Posterfelder

    Feld Typ Beschreibung
    images.thumbnail Karte Ordnen Sie die Eigenschaften des Miniaturbilds zu
    poster Objekt Eigenschaften für das Videoposter (alias Video still)
    poster.asset_id Schnur System-ID für das Standard-Poster
    poster.src Zeichenfolge-URL URL für das Standard-Poster
    poster.sources Array von Karten Array von Karten für Poster
    poster.sources.asset_id Schnur System-ID für das Poster
    poster.sources.src Zeichenfolge-URL URL für das Poster
    poster.sources.height Nummer Posterhöhe in Pixeln
    poster.sources.width Nummer Posterbreite in Pixel

    Miniaturansichtsfelder

    Feld Typ Beschreibung
    thumbnail Objekt Eigenschaften für die Video-Miniaturansicht
    thumbnail.asset_id Schnur System-ID für das Standard-Miniaturbild
    thumbnail.src Zeichenfolge-URL Quell-URL für die Standardminiaturansicht
    thumbnail.sources Array von Karten Array von Karten für Miniaturansichten
    thumbnail.sources.asset_id Schnur System-ID für das Miniaturbild
    thumbnail.sources.src Zeichenfolge-URL URL für das Vorschaubild
    thumbnail.sources.height Nummer Bildhöhe in Pixeln
    thumbnail.sources.width Nummer Bildbreite in Pixel

    Die folgende Tabelle zeigt die Felder des Verknüpfungsobjekts.

    Verknüpfungsfelder
    Feld Typ Beschreibung
    url Schnur Zugehörige Link-URL
    text Schnur Zugehöriger Linktext

    Felder einplanen

    Die folgende Tabelle zeigt die Felder für das Planungsobjekt

    Felder einplanen
    Feld Typ Beschreibung
    ends_at Zeichenfolge im ISO-8601-Datumsformat Datum und Uhrzeit, zu der das Video nicht mehr angezeigt werden kann
    starts_at Zeichenfolge im ISO-8601-Datumsformat Datum und Uhrzeit, zu der das Video angezeigt werden kann

    Felder teilen

    Die folgende Tabelle zeigt die Felder für die Freigabe von Objekten

    Felder teilen
    Feld Typ Beschreibung
    by_external_acct Boolean True, wenn dieses Video von einem anderen Konto freigegeben wurde.
    by_id Schnur Konto-ID, die die Freigabe ausgelöst hat
    source_id Schnur Video ID des Originalvideos (Sharer's Copy)
    to_external_acct Boolean True, wenn dieses Video für ein anderes Konto freigegeben ist
    by_reference Boolean Wahr ist, dass dieses Video als Referenz verwendet wird (wird immer sein true für Videos, die über die CMS API)

    Text Track Felder

    Die folgende Tabelle zeigt die Textspurfelder.

    Feld Typ Beschreibung
    id Schnur System-ID für den Text verfolgt das Element
    src Schnur Adresse der Track-Datei (URL)
    srclang Schnur Sprache der Strecke, zB "en"
    label Schnur Ein benutzerlesbarer Titel für die Textspur
    kind Schnur Wie der Titel verwendet werden soll: "Untertitel", "Untertitel", "Beschreibungen", "Kapitel", "Metadaten"
    mime_type Schnur Mime-Typ der Textspuren, zB "text / vtt"
    asset_id Schnur System-ID für die Track-Datei; null, wenn das Asset remote ist
    in_band_metadata_track_dispatch_type Schnur System-ID für die Track-Datei; null, wenn das Asset remote ist
    sources Feld read-only
    src Schnur Adresse der Track-Datei (URL)
    default Boolean Gibt an, dass die Spur standardmäßig aktiviert sein soll. Sollte nur auf einer Spur wahr sein.

    Erstellt von Feldern

    Die folgende Tabelle zeigt die created_by Objektfelder.

    Erstellt von Fields
    Feld Typ Beschreibung
    type Schnur Der Typ des Aktualisierungsprogramms - entweder:
    • user - ein Benutzer in Studio
    • api-key - ein Benutzer über eine API
    id Schnur Die Benutzer-ID in der Video Cloud System
    email Schnur Die E-Mail-Adresse des Benutzers in der Video Cloud System

    Durch Felder aktualisiert

    Die folgende Tabelle zeigt die updated_by Objektfelder.

    Durch Felder aktualisiert
    Feld Typ Beschreibung
    type Schnur Der Typ des Aktualisierungsprogramms - entweder:
    • user - ein Benutzer in Studio
    • api-key - ein Benutzer über eine API
    id Schnur Die Benutzer-ID in der Video Cloud System
    email Schnur Die E-Mail-Adresse des Benutzers in der Video Cloud System
    Seite zuletzt aktualisiert am 12. Juni 2020