CMS API-Videofelder-Referenz

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

Videofelder

Videofelder
Feld Typ Beschreibung
account_id Zeichenfolge Die Video-Cloud Konto-ID
ad_keys Zeichenfolge String, der die dem Video zugewiesenen Anzeigenschlüssel/Wert-Paare darstellt. Schlüssel/Wert-Paare werden als Schlüssel=Wert formatiert und durch kaufmännische Und-Zeichen getrennt. Zum Beispiel: "adKeys": "category=sports&live=true"
clip_source_video_id Zeichenfolge Die ID des Quellvideos, das abgeschnitten wurde, um dieses Video zu produzieren, oder null wenn dieses Video kein Clip eines anderen Videos ist.
complete Boolescher Wert Ob die Verarbeitung abgeschlossen ist — Hinweis: Wenn Sie ein neues Video erstellen, wird die Eigenschaft Complete automatisch auf gesetzt false. Sobald eine Wiedergabeversion für das Video vorhanden ist, wird die vollständige Eigenschaft automatisch auf gesetzt true
created_at Zahl, Millisekunden ab Epoche Wenn das Video im Video Cloud-System erstellt wurde
erstellt von Objekt Informationen darüber, wer das Video erstellt hat, falls verfügbar
cue_points Array von Karten Reihe von Cue-Point-Maps
custom_fields Zuordnung von Feld-Wert-Paaren (Strings) Benutzerdefinierte Feldwerte, die für das Video festgelegt wurden – beachten Sie das benutzerdefinierte Feld, das dies tut nicht einen Wert für dieses Video haben, sind in dieser Karte nicht enthalten; benutzerdefinierte Feldwerte haben eine maximale Länge von 1024 Einzelbyte-Zeichen
dash_manifest_id Zeichenfolge System-ID für ein DASH-Manifest
delivery_type Zeichenfolge Lieferart für das Video:
  • dynamic_origin- dynamische Lieferung
  • live_origin- Livestream von Brightcove Live
  • remote- Anlage
  • static_origin- Legacy-Ingest-System
  • unknown- konnte nicht bestimmt werden (kann bedeuten, dass das Video keine abspielbaren Wiedergaben hat)
description Zeichenfolge; ersetzt die alte Kurzbeschreibung Kurzbeschreibung des Videos (maximale Länge: 248 Single-Byte-Zeichen)
digital_master_id Zeichenfolge Die System-ID für den digitalen Master
drm_disabled Boolescher Wert Bei DRM-aktivierten Konten wird durch Festlegen von "true" verhindert, dass das Video DRM-verpackt wird. Dieses Feld wird nicht angezeigt, wenn das Konto nicht DRM-aktiviert ist.
duration Zahl, Millisekunden Dauer des Videos in Millisekunden
economics String, muss einer der gültigen Enum-Werte sein entweder "AD_SUPPORTED" (Standard) oder "FREE"
folder_id Zeichenfolge ID des Ordners, zu dem das Video gehört
forensic_watermarking Zeichenfolge ACTIVE zeigt an, dass das Video ein forensisches Wasserzeichen hat. UNAVAILBLE bedeutet, dass kein forensisches Wasserzeichen hinzugefügt wurde. null gibt an, dass das Konto nicht für forensische Wasserzeichen aktiviert ist.
geo [1-3] Karte von Eigenschafts-Wert-Paaren Geo-Einschränkungseigenschaften für das Video
has_digital_master Boolescher Wert Ob das Video einen archivierten Master hat, der für die Neutranscodierung verwendet werden kann. Beachten Sie, dass wenn Sie dieses Feld verwenden, um zu testen, ob ein Video erneut transkodiert werden kann, es für freigegebene Videos nicht zuverlässig ist. Wenn Videos für das Konto freigegeben werden, müssen Sie beides testen has_digital_master = true und sharing.by_external_acct = false
id Zeichenfolge Die Video-ID
bilder Karte von Eigenschafts-Wert-Paaren Karte mit Informationen zum Poster und Miniaturansichten
Link Karte von Eigenschafts-Wert-Paaren Karte der zugehörigen Linkeigenschaften
long_description Zeichenfolge Lange Beschreibung (bis zu 5000 Zeichen)
name Zeichenfolge Der Name des Videos (maximale Länge: 248 Single-Byte-Zeichen)
offline_enabled Boolescher Wert Ob das Video für die Offline-Wiedergabe aktiviert ist
original_filename Zeichenfolge Name der aufgenommenen Videodatei – ist für Remote-Asset-Videos null
playback_rights_id Zeichenfolge Der eindeutige Bezeichner für die in der Playback Rights API definierten Wiedergabebeschränkungen.
projection Zeichenfolge Die Mapping-Projektion für 360°-Videos, zB "equirectangular"
published_at Zeichenfolge ISO-8601 Datum-Uhrzeit-Zeichenfolge, die 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 Zeichenfolge Eine vom Benutzer angegebene ID, die das Video eindeutig identifiziert, begrenzt auf 150 Zeichen. Eine referenceId kann als Fremdschlüssel verwendet werden, um dieses Video in einem anderen System zu identifizieren.
zeitplan [1-1] Karte von Eigenschafts-Wert-Paaren Karte der Start- und Enddatumszeiten für die Videoverfügbarkeit
sharing Karte von Eigenschafts-Wert-Paaren Karte der Freigabeeigenschaften für das Video
smooth_client_manifest_id Zeichenfolge System-ID für ein Smooth-Manifest
smooth_server_manifest_id Zeichenfolge System-ID für den Smooth-Manifest-Server
state [1-4] Zeichenfolge 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-Stil Array von Textspuren (WebVTT-Dateien), die dem Video zugeordnet sind
abschriften Array von Klartext-Transkripten Array von Transkripten (einfache Textdateien), die dem Video zugeordnet sind
updated_at Datum-Uhrzeit-String Datum und Uhrzeit der letzten Änderung des Videos [1-2]
aktualisiert von Objekt Informationen darüber, wer das Video zuletzt aktualisiert hat, falls verfügbar
Varianten Anordnung von variant Metadatenobjekte Metadatenvarianten für verschiedene Sprachen
ingestion_profile_id Zeichenfolge Die ID des Ingestion-Profils, das zur Transkodierung dieses Videos verwendet wurde. Nur lesen.

Hinweise

  • [1-1] Beachten Sie, dass ein geplantes Video ist nicht außerhalb des Zeitraums der geplanten Verfügbarkeit inaktiv
  • [1-2] Die Änderung wurde möglicherweise von einem Benutzer oder dem Video Cloud-System vorgenommen
  • [1-3] Die Geobeschränkung ist ein kostenpflichtiges Add-on zu Video Cloud; wenn Sie die Geofilterungsfunktion erwerben möchten, wenden Sie sich an Ihren Customer Success Manager
  • [1-4] state kann auf ACTIVE oder gesetzt werden INACTIVE, aber nicht auf PENDING oder DELETED.

    Der Mittelwert der Zustände ist wie folgt:

    • ACTIVE- das Video ist abspielbar
    • INACTIVE- das Video wurde deaktiviert oder es fehlen die erforderlichen Metadatenfelder und ist daher nicht abspielbar
    • PENDING- dies bezieht sich auf das Teilen von Medien; das Video wurde von einem anderen Konto aus geteilt, von diesem Konto jedoch noch nicht akzeptiert
    • DELETED- das Video wurde gelöscht
  • [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 ein Fehler angezeigt, wenn Sie versuchen, die Änderungen zu speichern
    • Tags dürfen keine Kommas enthalten; zum Beispiel ein Tag von roof, attic + front yard wird nicht unterstützt
    • Ein Video darf insgesamt nicht mehr als 1200 Tags haben
    • Ein Tag, das sich nur in der Groß-/Kleinschreibung (Kleinbuchstaben, Großbuchstaben) unterscheidet, wird als identisches Tag behandelt und die Groß-/Kleinschreibung wird automatisch mit dem des ursprünglichen Tags übereinstimmen. Probleme mit der Berücksichtigung der Groß-/Kleinschreibung müssen extern von Video Cloud behandelt werden, z. B. mithilfe von JavaScript-Methoden zum Ändern die Saiten

Videoquellenfelder

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

Dynamische Bereitstellungsquellen

Feld Typ Beschreibung
src Zeichenfolge URL für die Quelle
type Zeichenfolge Segmentierter Videotyp, normalerweise application/x-mpegURL (für HLS) oder application/dash+xml (für DASH)
ext_x_version Zeichenfolge HLS-Version - nur für HLS-Quellen
profiles Zeichenfolge Profile – nur für DASH-Quellen
codec Zeichenfolge Videocodec - nur für MP4-Quellen
container Zeichenfolge Videocontainer - 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 Pixel - nur für MP4-Quellen
size ganze Zahl Dateigröße in Byte - nur für MP4-Quellen
uploaded_at Zeichenfolge Datum, an dem das Video im ISO-8601-Datumsformat hochgeladen wurde
width Ganze Zahl Rahmenbreite in Pixel - nur für MP4-Quellen

Legacy-Aufnahmequellen (Wiedergabe)

Feld Typ
src String URL, Nur für PD-Web-Assets und HLS-Assets
app_name String, Nur zum Streamen von Web-Assets
stream_name String, Nur zum Streamen von Web-Assets
codec Zeichenfolge
container Zeichenfolge
duration Lang?
encoding_rate Lang?
height Ganze Zahl
id Zeichenfolge
size Lang
uploaded_at String im ISO-8601-Datumsformat
width Ganze Zahl

Altes HLS-Manifest aufnehmen

Feld Typ
src String-URL
type String (Anwendung/x-mpegURL)
codec Zeichenfolge
container Zeichenfolge

Altes HDS-Manifest aufnehmen

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

Legacy-Ingest Dash-Manifest

Feld Typ
asset_id Zeichenfolge
src String-URL
type Zeichenfolge (Anwendung/Bindestrich+xml)

Legacy-Ingest Smooth-Manifeste (Server und Client)

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

Cuepoint-Felder

Die folgende Tabelle zeigt Felder für Cuepoints.

Cuepoint-Felder
Feld Typ Beschreibung
id Zeichenfolge System-ID für den Cue-Point
force_stop Boolescher Wert Ob das Video am Cue-Point gestoppt werden soll
metadata String; Nur Codepunkt Eine mit dem Cue-Point verknüpfte Metadatenzeichenfolge
name Zeichenfolge Der Cue-Point-Name
time Schweben Zeit des Cue-Points in Sekunden gemessen ab dem Start des Videos
type Zeichenfolge Der Cue-Point-Typ ( AD oder DATA)

Geo-Felder

Die folgende Tabelle zeigt die Geo-Objektfelder.

Geo-Filter-Felder
Feld Typ Beschreibung
countries Array von Ländercode-Strings Array von ISO 3166-Liste von 2-Buchstaben-Codes (https://www.iso.org/obp/ui/) für Länder, in denen das Video abgespielt werden darf oder nicht.
exclude_countries Boolescher Wert Wenn true, wird das Länderarray als Liste der Länder behandelt, die von der Anzeige ausgeschlossen sind
restricted Boolescher Wert Ob Geofilterung 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 (auch bekannt als Videostill)
   poster.asset_id Zeichenfolge System-ID für das Standardposter
   poster.src String-URL URL für das Standardposter
   poster.sources Array von Karten Kartenauswahl für Poster
     poster.sources.asset_id Zeichenfolge System-ID für das Poster
     poster.sources.src String-URL URL für das Poster
     poster.sources.height Nummer Posterhöhe in Pixel
     poster.sources.width Nummer Posterbreite in Pixel

Thumbnail-Felder

Feld Typ Beschreibung
thumbnail Objekt Eigenschaften für das Video-Thumbnail
   thumbnail.asset_id Zeichenfolge System-ID für das Standard-Miniaturbild
   thumbnail.src String-URL Quell-URL für das Standard-Thumbnail
   thumbnail.sources Array von Karten Karten-Array für Miniaturbilder
     thumbnail.sources.asset_id Zeichenfolge System-ID für das Thumbnail
     thumbnail.sources.src String-URL URL für das Thumbnail
     thumbnail.sources.height Nummer Bildhöhe in Pixel
     thumbnail.sources.width Nummer Bildbreite in Pixel

Die folgende Tabelle zeigt die Verknüpfungsobjektfelder.

Felder verknüpfen
Feld Typ Beschreibung
url Zeichenfolge Verwandte Link-URL
text Zeichenfolge Zugehöriger Linktext

Zeitplanfelder

Die folgende Tabelle zeigt die Felder für das Zeitplanobjekt

Zeitplanfelder
Feld Typ Beschreibung
ends_at String im ISO-8601-Datumsformat Datum und Uhrzeit, wann das Video nicht mehr zur Anzeige verfügbar ist
starts_at String im ISO-8601-Datumsformat Datum und Uhrzeit, wann das Video zum Anzeigen verfügbar wird

Felder freigeben

Die folgende Tabelle zeigt die Felder des Sharing-Objekts

Felder freigeben
Feld Typ Beschreibung
by_external_acct Boolescher Wert True, wenn dieses Video von einem anderen Konto geteilt wurde.
by_id Zeichenfolge Konto-ID, von der die Freigabe stammt
source_id Zeichenfolge Video-ID des Originalvideos (Kopie des Sharers)
to_external_acct Boolescher Wert True, wenn dieses Video mit einem anderen Konto geteilt wird
by_reference Boolescher Wert Es stimmt, dass dieses Video als Referenz geteilt wird (wird immer so sein true für Videos, die über die CMS-API geteilt werden)

Textspurfelder

Die folgende Tabelle zeigt die Textspurfelder.

Feld Typ Beschreibung
id Zeichenfolge System-ID für das Textspurelement
src Zeichenfolge Adresse der Trackdatei (URL)
srclang Zeichenfolge Sprache des Tracks, zB "en"
label Zeichenfolge Ein vom Benutzer lesbarer Titel für den Textspursatz
kind Zeichenfolge Wie der Track benutzt werden soll: subtitles captions, descriptions, chapters, metadata
mime_type Zeichenfolge MIME-Typ der Texttracks, z. B. „text/vtt“
asset_id Zeichenfolge System-ID für die Track-Datei; null, wenn das Asset entfernt ist
in_band_metadata_track_dispatch_type Zeichenfolge System-ID für die Track-Datei; null, wenn das Asset entfernt ist
status Zeichenfolge Zustand der Tracks: published, draft, oder null
sources Reihe schreibgeschützt
   src Zeichenfolge Adresse der Trackdatei (URL)
default Boolescher Wert Gibt an, dass die Spur standardmäßig aktiviert sein sollte. Sollte nur auf einem Track zutreffen.

Transkriptionsfelder

In der nachstehenden Tabelle sind die Felder der Abschrift aufgeführt.

Feld Typ Beschreibung
id Zeichenfolge System-ID für das Textspurelement
account_id Zeichenfolge Die Systemkontonummer
src Zeichenfolge Adresse der Trackdatei (URL)
srclang Zeichenfolge Sprache des Titels, z. B. "en" oder "ex-MX" - dieses Feld kann aktualisiert werden
label Zeichenfolge Ein benutzerdefinierter Titel für den Text-Track-Set - dieses Feld kann aktualisiert werden
status Zeichenfolge Der Status der Transkription, entweder published oder draft- dieses Feld kann aktualisiert werden
sources Reihe schreibgeschützt - eine Reihe von URLs, über die das Transkript von einem Client abgerufen werden kann - für jedes Transkript gibt es eine http https UND-URL
default Boolescher Wert Gibt an, dass die Spur standardmäßig aktiviert sein sollte. Sollte nur auf einem Track zutreffen.

Erstellt von Feldern

Die folgende Tabelle zeigt die created_by Objektfelder bzw.

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

Aktualisiert nach Feldern

Die folgende Tabelle zeigt die updated_by Objektfelder bzw.

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

Variantenfelder

Die folgende Tabelle zeigt die variant Objektfelder bzw.

Aktualisiert von Feldern
Feld Typ Beschreibung
language Zeichenfolge Die Sprache für diese Variante im Sprach-Ländercode-Format (Beispiele: en-US, es-ES). Beachten Sie, dass language ist nur enthalten, wenn Sie eine Variante erstellen - Sie dürfen es NICHT beim Aktualisieren der Variante einschließen
name Zeichenfolge Der Titel des Videos in dieser Sprache
description Zeichenfolge Der Titel des Videos in dieser Sprache
long_description Zeichenfolge Der Titel des Videos in dieser Sprache
custom_fields Objekt Karte von fieldname: value Paaren, wobei die Werte für diese Sprache stehen; Werte haben eine maximale Länge von 1024 Einzelbyte-Zeichen. Hinweis: Verwenden Sie unbedingt die intern Name für das Feld, nicht der Anzeigename/td>