Support Kontaktieren Sie Support | Systemstatus Systemstatus
Inhalt der Seite

    CMS API Video Felder Referenz

    Dies ist ein Verweis auf Videofelder, die von der CMS-API zurückgegeben werden.

    Video-Felder

    Videofelder
    Feld Art Beschreibung
    account_id String Die Video Cloud-Konto-ID
    ad_keys String String, der die dem Video zugewiesenen Anzeigenschlüssel-/Wertepaare darstellt. Schlüssel/Wert-Paare sind als Schlüssel=Wert formatiert und durch Ampersands getrennt. Zum Beispiel: "adKeys": "category=sports&live=true"
    clip_source_video_id String Die ID des Quellvideos, das zur Erstellung dieses Videos abgeschnitten wurde oder null wenn dieses Video kein Clip eines anderen Videos ist.
    complete Boolesch Ob die Verarbeitung abgeschlossen ist — Hinweis: Wenn Sie ein neues Video erstellen, wird die Eigenschaft complete automatisch auf festgelegt false. Sobald eine Wiedergabeversion für das Video existiert, wird die vollständige Eigenschaft automatisch auf true
    created_at Zahl, Millisekunden aus Epoche Wann das Video im Video Cloud-System erstellt wurde
    created_by Objekt Informationen darüber, wer das Video erstellt hat, falls verfügbar
    cue_punkte Array von Karten Array von Cue-Point-
    custom_fields Karte von Feldwertpaaren (Strings) Benutzerdefinierte Feldwerte, die für das Video festgelegt wurden - beachten Sie, dass ein benutzerdefiniertes Feld, das keinen Wert für dieses Video hat, nicht in dieser Karte enthalten sind. Benutzerdefinierte Feldwerte haben eine maximale Länge von 1024 Single-Byte-Zeichen
    dash_manifest_id String System-ID für ein DASH-Manifest
    delivery_type String Lieferart für das Video:
    • dynamic_origin - Dynamische Lieferung
    • live_origin - Livestream von Brightcove Live
    • remote - Vermögenswert
    • static_origin - Legacy-Ingest-System
    • unknown - konnte nicht bestimmt werden (kann bedeuten, dass das Video keine wiedergabbaren Wiedergaben hat)
    description String; tritt an die Stelle des alten ShortDescription Kurzbeschreibung des Videos (maximale Länge: 248 Single-Byte-Zeichen)
    digital_master_id String Die System-ID für den digitalen Master
    drm_disabled Boolesch Wenn Sie dies für DRM-fähige Konten auf „true“ festlegen, wird verhindert, dass das Video DRM-verpackt 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 „KOSTENLOS“
    folder_id String ID des Ordners, zu dem das Video gehört
    geo [1 - 3] Zuordnung von Eigenschafts-Wert-Paaren Geo-Restriktion-Eigenschaften für das Video
    has_digital_master Boolesch Ob Video einen archivierten Master hat, der für das Retranscodieren verwendet werden kann. Beachten Sie, dass wenn Sie dieses Feld verwenden, um zu testen, ob ein Video retranscodiert werden kann, es für freigegebene Videos nicht zuverlässig ist. Wenn Videos für das Konto freigegeben werden, müssen Sie has_digital_master = true sowohl auf als auch sharing.by_external_acct = false
    id String Die Video-ID
    bilder Zuordnung von Eigenschafts-Wert-Paaren Karte von Informationen zu den Poster- und Vorschaubildern
    Link Zuordnung von Eigenschafts-Wert-Paaren Karte der zugehörigen Link-Eigenschaften
    long_description String Langbezeichnung (bis zu 5000 Zeichen)
    name String Der Name des Videos (maximale Länge: 248 Einzelbyte-Zeichen)
    offline_enabled Boolesch Ob das Video für die Offline-Wiedergabe aktiviert ist
    original_filename String Name der Videodatei, die aufgenommen wurde - wird für Remote-Asset-Videos Null sein
    projection String Die Mapping-Projektion für 360°-Videos, z.B. „equirectangular“
    published_at String ISO-8601 Datum-Zeit-Zeichenfolge, die angibt, wann das Video veröffentlicht wurde - beachten Sie, dass dieses Feld beschreibbar ist; Standardmäßig ist es auf das Datum festgelegt, an dem das Video zum ersten Mal aktiviert wurde.
    reference_id String Eine vom Benutzer festgelegte ID, die das Video eindeutig kennzeichnet und auf 150 Zeichen beschränkt ist. Eine ReferenceID kann als Fremdschlüssel verwendet werden, um dieses Video in einem anderen System zu identifizieren. Die Referenz-ID sollte keine Leerzeichen, Kommas oder Sonderzeichen enthalten.
    planen [1-1] Zuordnung von Eigenschafts-Wert-Paaren Karte der Start- und Enddatenzeiten für die Videoverfügbarkeit
    sharing Zuordnung von Eigenschafts-Wert-Paaren Zuordnung der Sharing-Eigenschaften für das Video
    smooth_client_manifest_id String System-ID für ein Smooth-Manifest
    smooth_server_manifest_id String System-ID für den Smooth-Manifestserver
    state [ 1-4] String AKTIV, INAKTIV, AUSSTEHEND, GELÖSCHT
    tags [ 1-5] Array von Tags (Strings) Array von Tags, die dem Video zugewiesen sind
    text_tracks Array von Textspuren im HTML5-artigen Stil Array von Textspuren (WebVTT-Dateien), die dem Video zugewiesen sind
    updated_at Datum-Zeit-Zeichenfolge Datum-Uhrzeit, in der das Video zuletzt geändert wurde [1-2]
    aktualisiert_by Objekt Informationen darüber, wer das Video zuletzt aktualisiert hat, falls verfügbar

    Hinweise

    • [ 1-1] Beachten Sie, dass ein geplantes Video außerhalb des Zeitraums der geplanten Verfügbarkeit nicht inaktiv ist
    • [ 1-2] Die Änderung wurde möglicherweise von einem Benutzer oder dem Video Cloud-System vorgenommen
    • [ 1-3] Geo-Restriction ist ein kostenpflichtiges Add-on zu Video Cloud. Wenn Sie Geo-Filterfunktionen erwerben möchten, wenden Sie sich an Ihren Account Manager
    • [1-4] state kann auf eingestellt werden ACTIVE oder INACTIVE , aber nicht zu PENDING oder DELETED.
    • [ 1-5] Beachten Sie die folgenden Einschränkungen für Tags:
      • Tags können bis zu 128 Zeichen lang sein. Wenn Tags mehr als 128 Zeichen haben, wird beim Versuch, Änderungen zu speichern, ein Fehler angezeigt
      • Tags dürfen keine Kommas enthalten; ein Tag von roof, attic + front yard wird beispielsweise nicht unterstützt
      • Ein Video darf maximal 1200 Tags beinhalten.
      • Ein Tag, das sich nur für den Fall unterscheidet (Kleinbuchstaben, Großbuchstaben), wird als identisches Tag behandelt und der Fall stimmt automatisch mit denen des ursprünglichen Tags überein - Probleme mit der Berücksichtigung der Groß- und Kleinschreibung müssen extern an Video Cloud behandelt werden, z. B. mit JavaScript-Methoden zum Ändern der Zeichenfolgen

    Felder der Videoquelle

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

    Dynamische Lieferquellen

    Feld Art Beschreibung
    src String URL für die Quelle
    type String Segmentierter Videotyp, normalerweise application/x-mpegURL (für HLS) oder application/dash+xml (für DASH)
    ext_x_version String HLS-Version - nur für HLS-Quellen
    profiles String Profile - nur für DASH-Quellen
    codec String Videocodec - nur für MP4-Quellen
    container String Videocontainer — nur für MP4-Quellen
    duration Ganzzahl Dauer in Millisekunden - nur für MP4-Quellen
    encoding_rate Ganzzahl Codierungsrate in BPS - nur für MP4-Quellen
    height Ganzzahl Rahmenhöhe in Pixel - nur für MP4-Quellen
    size ganzzahlig Dateigröße in Byte - nur für MP4-Quellen
    uploaded_at String Datum, an dem das Video im ISO-8601-Datumsformat hochgeladen wurde
    width Ganzzahl Rahmenbreite in Pixel - nur für MP4-Quellen

    Legacy-Ingest-Quellen (Wiedergaben)

    Feld Art
    src String-URL, nur für PD-Web-Assets und HLS-Assets
    app_name Zeichenfolge, nur für Streaming-Web-Assets
    stream_name Zeichenfolge, nur für Streaming-Web-Assets
    codec String
    container String
    duration Lang?
    encoding_rate Lang?
    height Ganzzahl
    id String
    size Long
    uploaded_at Zeichenfolge im ISO-8601-Datumsformat
    width Ganzzahl

    Legacy-Ingest-HLS-Manifest

    Feld Art
    src String-URL
    type Zeichenfolge (Anwendung/x-mpegurl)
    codec String
    container String

    Legacy-Ingest-HDS-Manifest

    Feld Art
    asset_id String
    src String-URL
    type Zeichenfolge (Anwendung/F4M)

    Legacy-Aufnahme Dash-Manifest

    Feld Art
    asset_id String
    src String-URL
    type String (Anwendung/Strich+XML)

    Legacy-Aufnahme Glatte Manifeste (Server und Client)

    Feld Art
    asset_id String
    src String-URL
    type String (Anwendung/vnd.ms-sstr+xml)

    Cuepoint-Felder

    Die folgende Tabelle zeigt Felder für Cuepoints.

    Cuepoint-Felder
    Feld Art Beschreibung
    id String System-ID für den Cue-Point
    force_stop Boolesch Ob das Video am Cue-Point gestoppt werden soll
    metadata Zeichenfolge; nur Codepunkt Eine mit dem Cue-Point verknüpfte Metadatenzei
    name Saite Der Cue-Point-Name
    time Float Die Zeit des Cue-Points in Sekunden, gemessen vom Beginn des Videos
    type Saite Der Cue-Point-Typ ( AD oder DATA)

    Geo-Felder

    Die folgende Tabelle zeigt die Geo-Objekt-Felder.

    Geo-Filterfelder
    Feld Art Beschreibung
    countries Array von Ländercode Strings Array der ISO 3166-Liste mit 2-Buchstaben-Codes (https://www.iso.org/obp/ui/) für Länder, in denen das Video abgespielt werden darf oder nicht
    exclude_countries Boolesch Wenn der Wert „true“ ist, wird das Länder-Array als Liste der Länder behandelt, die von
    restricted Boolesch Ob Geo-Filterung für dieses Video aktiviert ist

    Bild-Felder

    Die folgende Tabelle zeigt Bildobjektfelder

    Poster-Fel

    Feld Art Beschreibung
       images.thumbnail karte Zuordnen der Eigenschaften des Miniaturansichtsbilds
    poster Objekt Eigenschaften für das Videoplakat (auch Videostill genannt)
       poster.asset_id String System-ID für das Standardplakat
       poster.src String-URL URL für das Standardplakat
       poster.sources Array von Karten Array von Karten für Plakate
         poster.sources.asset_id String System-ID für das Plakat
         poster.sources.src String-URL URL für das Plakat
         poster.sources.height Number Höhe des Posters in Pixeln
         poster.sources.width Number Breite des Posters in Pixeln

    Thumbnail-Felder

    Feld Art Beschreibung
    thumbnail Objekt Eigenschaften für das Video-Thumbnail
       thumbnail.asset_id String System-ID für das Standard-Miniaturbild
       thumbnail.src String-URL Quell-URL für das Standard-Miniaturbild
       thumbnail.sources Array von Karten Array von Karten für Vorschaubilder
         thumbnail.sources.asset_id String System-ID für das Thumbnail
         thumbnail.sources.src String-URL URL für das Thumbnail
         thumbnail.sources.height Number Bildhöhe in Pixeln
         thumbnail.sources.width Number Bildbreite in Pixeln

    Die folgende Tabelle zeigt die Felder des Linkobjekts.

    Felder verknüpfen
    Feld Art Beschreibung
    url String URL für verwandte Links
    text String Verwandter Linktext

    Felder planen

    Die folgende Tabelle zeigt die Felder für das Planungsobjekt

    Felder planen
    Feld Art Beschreibung
    ends_at Zeichenfolge im ISO-8601-Datumsformat Datum-Uhrzeit, wenn das Video nicht mehr zur Ansicht verfügbar ist
    starts_at Zeichenfolge im ISO-8601-Datumsformat Datum-Uhrzeit, wenn das Video zur Ansicht verfügbar ist

    Felder teilen

    Die folgende Tabelle zeigt die Felder für das Sharing-Objekt

    Felder teilen
    Feld Art Beschreibung
    by_external_acct Boolesch True, wenn dieses Video von einem anderen Konto geteilt wurde.
    by_id String Konto-ID, aus dem die Aktie stammt
    source_id String Video-ID des Originalvideos (Sharer-Kopie)
    to_external_acct Boolesch True, wenn dieses Video mit einem anderen Konto geteilt wird
    by_reference Boolesch Es stimmt, dass dieses Video als Referenz geteilt wird (gilt immer true für Videos, die über die CMS-API geteilt werden)

    Felder der Textspur

    Die folgende Tabelle zeigt die Textspur-Felder.

    Feld Art Beschreibung
    id String System-ID für das Element „Textspuren“
    src String Adresse der Track-Datei (URL)
    srclang String Sprache des Tracks, z.B. „en“
    label String Ein benutzerlesbarer Titel für den Textspursatz
    kind String Wie soll der Track verwendet werden: „Untertitel“, „Bildunterschriften“, „Beschreibungen“, „Kapitel“, „Metadaten“
    mime_type String MIME-Typ der Textspuren, z.B. „text/vtt“
    asset_id String System-ID für die Track-Datei; Null wenn Asset remote ist
    in_band_metadata_track_dispatch_type String System-ID für die Track-Datei; Null wenn Asset remote ist
    sources Array schreibgeschützt
       src String Adresse der Track-Datei (URL)
    default Boolesch Gibt an, dass der Track standardmäßig aktiviert sein sollte. Sollte nur auf einer Spur wahr sein.

    Erstellt nach Feldern

    Die folgende Tabelle zeigt die created_by Objektfelder.

    Erstellt von Fields
    Feld Art Beschreibung
    type String Der Typ des Updaters - entweder:
    • user - ein Benutzer in Studio
    • api-key - ein Benutzer über eine API
    id String Die Benutzer-ID im Video Cloud-System
    email String Die E-Mail-Adresse des Nutzers im Video Cloud-System

    Nach Feldern aktualisiert

    Die folgende Tabelle zeigt die updated_by Objektfelder.

    Aktualisiert von Fields
    Feld Art Beschreibung
    type String Der Typ des Updaters - entweder:
    • user - ein Benutzer in Studio
    • api-key - ein Benutzer über eine API
    id String Die Benutzer-ID im Video Cloud-System
    email String Die E-Mail-Adresse des Nutzers im Video Cloud-System

    Seite zuletzt aktualisiert am 29 Sep. 2020