Objektreferenz der Medien-API

Product
Video Cloud
Betrifft die Rollen
Entwickler
Version
Brightcove 5
Module
Media API
Edition
Alle
Erstellt von Jessica Nutting.

Dieses Thema bietet Referenzinformationen zu den Video-, Playlist-, Image-, Rendition-, CuePoint- und LogoOverlay-Objekten, die von den Lesemethoden der Medien-API zurückgegeben werden:

Diese Objekte der Medien-API ähneln den Objekten in der Nur-Flash-Player-API, sind aber nicht mit diesen identisch. Die Medien-API-Referenzinformationen enthalten auch Hinweise zu den folgenden verwandten Objekten:

Video-Objekt

Das Video-Objekt enthält Metadaten und weitere Informationen zu einem Video. Ein Video verfügt über die folgenden Eigenschaften:

Eigenschaftsname Typ Schreibgeschützt? Beschreibung
name String Nein Der Titel des Videos mit einer Länge von maximal 255 Zeichen. Der Name ist bei der Erstellung eines Videos obligatorisch.
id Long Ja Eine Nummer zur eindeutigen Identifikation des Videos, die bei der Erstellung des Videos von Video Cloud zugewiesen wird.
referenceId String Nein Eine benutzerdefinierte ID mit maximal 150 Zeichen, die das Video eindeutig identifiziert. Die referenceId-Eigenschaft kann als Fremdschlüssel zur Identifikation des Videos in einem anderen System verwendet werden. Hinweis: Die find_videos_by_reference_ids-Methode kann eine referenceId, die Kommas enthält, nicht verarbeiten. Deshalb empfiehlt es sich, Kommas in referenceId-Werten zu vermeiden.
accountId Long Ja Eine von Video Cloud zugewiesene Nummer zur eindeutigen Identifikation des Kontos, zu dem das Video gehört.
shortDescription String Nein Eine Kurzbeschreibung des Videos, die aus maximal 250 Zeichen bestehen kann. Die shortDescription-Eigenschaft ist bei der Erstellung eines Videos obligatorisch.
longDescription String Nein Eine längere Beschreibung des Videos, die aus maximal 5000 Zeichen bestehen kann.
FLVURL String Ja Die URL der Videodatei für dieses Video. Hinweis: Der Zugriff auf diese Eigenschaft über die Medien-API ist nur mit einem besonderen Lese- oder Schreibtoken möglich. Diese Eigenschaft gilt unabhängig davon, ob das Video in FLV (VP6) oder MP4 (H.264) codiert ist. Siehe Zugriff auf Videocontent über die Medien-API.
renditions Array Nein Ein Array der verfügbaren Wiedergabeversionen für das Streaming mit variablen Bitraten des Videos. Ein Video sollte über höchstens 10 Wiedergabeversionen verfügen. Hinweis: Der Zugriff auf diese Eigenschaft über die Medien-API ist nur mit einem besonderen Lese- oder Schreibtoken möglich. Siehe Zugriff auf Videocontent über die Medien-API.
videoFullLength Rendition Nein Eine einzelne Wiedergabeversion, die die Videodatei des Videos darstellt. Hinweis: Der Zugriff auf diese Eigenschaft über die Medien-API ist nur mit einem besonderen Lese- oder Schreibtoken möglich. Siehe Zugriff auf Videocontent über die Medien-API.
creationDate Datum Ja Das Erstellungsdatum des Videos, angegeben als Anzahl der Millisekunden seit der UNIX-Epoche.
publishedDate Datum Ja Das Datum, an dem dieses Video zuletzt aktiviert wurde, angegeben als Anzahl der Millisekunden seit der UNIX-Epoche.
lastModifiedDate Datum Ja Das Datum, an dem das Video zuletzt geändert wurde, angegeben als Anzahl der Millisekunden seit der UNIX-Epoche.
itemState Aufzählung Nein ItemStateEnum. mit einer der folgenden Eigenschaften: ACTIVE, INACTIVE oder DELETED. Sie können diese Eigenschaft nur auf ACTIVE oder INACTIVE setzen. Ein Video wird nicht gelöscht, indem Sie die Eigenschaft itemState auf DELETED setzen.
startDate Datum Nein Das Datum, an dem das Video erstmals zum Abspielen verfügbar ist, angegeben als Anzahl der Millisekunden seit der UNIX-Epoche.
endDate Datum Nein Das Datum, an dem das Video zum letzten Mal zum Abspielen verfügbar ist, angegeben als Anzahl der Millisekunden seit der UNIX-Epoche.
linkURL String Nein Eine optionale URL für ein verwandtes Element mit einer Länge von maximal 255 Zeichen.
linkText String Nein Der für die linkURL-Eigenschaft angezeigte Text, der auf 255 Zeichen begrenzt ist.
tags Liste Nein Eine Liste der Strings für die Tags, die diesem Video zugewiesen sind. Jedes Tag kann maximal 128 Zeichen enthalten; ein Video kann höchstens 1200 Tags umfassen.
videoStillURL String Ja Die URL des Videostandbildes, das diesem Video zugewiesen ist. Videostandbilder haben eine Größe von 480x360 Pixel.
thumbnailURL String Ja Die URL des Miniaturbildes, das diesem Video zugewiesen ist. Miniaturbilder haben eine Größe von 120x90 Pixel.
length Long Ja Die Länge des Videos in Millisekunden.
customFields Objekt Nein Eine Zuordnung der Namen und Werte der benutzerdefinierten Felder, die für die Videos in Ihrem Konto eingerichtet sind. Weitere Informationen und Beispiele.
economics Aufzählung Nein EconomicsEnum mit dem Wert Entweder FREE oder AD_SUPPORTED. AD_SUPPORTED bedeutet, dass Anzeigenanforderungen für das Video aktiviert sind.
adKeys String Nein Ein String mit den Schlüssel/Wertpaaren der Anzeige, die dem Video zugewiesen sind. Schlüssel/Wertpaare werden in Form von key=value formatiert und durch &-Zeichen getrennt. Beispiel:
"adKeys":"category=sports&live=true"
geoRestricted Boolesch Nein Beim Wert „true“ gilt für das Video eine geografische Einschränkung.
geoFilteredCountries Liste Nein Eine Liste der aus zwei Buchstaben bestehenden ISO-3166-Codes der Länder, auf die Regeln zur geografischen Einschränkung angewendet werden sollen. Verwenden Sie Kleinbuchstaben für die Ländercodes.
geoFilterExclude Boolesch Nein Beim Wert „true“ kann das Video in allen Ländern angezeigt werden, die nicht unter geoFilteredCountries aufgeführt sind. Beim Wert „false“ kann das Video nur in den Ländern angezeigt werden, die unter geoFilteredCountries aufgelistet sind.
cuePoints Liste Nein Eine Liste der CuePoints-Objekte, die diesem Video zugewiesen sind.
playsTotal Ganzzahl Ja Gibt an, wie oft das Video seit seiner Erstellung abgespielt wurde.
playsTrailingWeek Ganzzahl Ja Gibt an, wie oft das Video in den letzten sieben Tagen abgespielt wurde, ohne Berücksichtigung des heutigen Tages.

Playlist-Objekt

Das Playlist-Objekt enthält eine Sammlung aus Videos. Eine Wiedergabeliste verfügt über die folgenden Eigenschaften:

Eigenschaftsname Typ Schreibgeschützt? Beschreibung
id Long Ja Eine Nummer, die die Wiedergabeliste eindeutig identifiziert. Diese ID wird bei der Erstellung der Wiedergabeliste automatisch zugewiesen.
referenceId String Nein Eine benutzerdefinierte ID mit maximal 150 Zeichen, die die Wiedergabeliste eindeutig identifiziert. Hinweis: Die find_playlists_by_reference_ids-Methode kann eine referenceId, die Kommas enthält, nicht verarbeiten. Deshalb empfiehlt es sich, Kommas in referenceId-Werten zu vermeiden.
accountId Long Ja Eine von Video Cloud zugewiesene Nummer zur eindeutigen Identifikation des Kontos, zu dem die Wiedergabeliste gehört.
name String Nein Der Titel dieser Wiedergabeliste mit einer Länge von maximal 100 Zeichen. Die name-Eigenschaft ist bei der Erstellung einer Wiedergabeliste obligatorisch.
shortDescription String Nein Eine Kurzbeschreibung der Wiedergabeliste, die aus maximal 250 Zeichen bestehen kann.
videoIds Liste Nein Eine Liste der IDs der Videos, die in der Wiedergabeliste enthalten sind.
videos Liste Nein Eine Liste der Video-Objekte, die in der Wiedergabeliste enthalten sind.
playlistType Aufzählung Nein

Setzen Sie diese Eigenschaft für eine manuelle Wiedergabeliste auf EXPLICIT. Für intelligente Wiedergabelisten definieren Sie die Sortierreihenfolge, indem Sie einen der folgenden Werte angeben: OLDEST_TO_NEWEST (nach Aktivierungsdatum)
NEWEST_TO_OLDEST (nach Aktivierungsdatum)
START_DATE_OLDEST_TO_NEWEST
START_DATE_NEWEST_TO_OLDEST ALPHABETICAL (nach Videoname)
PLAYS_TOTAL
PLAYS_TRAILING_WEEK

Die playlistType-Eigenschaft ist bei der Erstellung einer Wiedergabeliste obligatorisch.
filterTags Liste Nein Eine Liste der Tags, die auf diese intelligente Wiedergabeliste angewendet wurden. Zum Beispiel:

"filterTags":["Sitka","ticks"]
tagInclusionRule Aufzählung Nein Definiert bei einer intelligenten Wiedergabeliste, ob das Video alle oder mindestens einen der Werte in filterTags enthalten muss. Verwenden Sie AND für „enthält alle“ und OR für „enthält mindestens einen Wert“. Nicht verfügbar in API-Lesemethoden.
thumbnailURL String Ja Die URL des Miniaturbildes, das dieser Wiedergabeliste zugewiesen ist.

Image-Objekt

Dieses Objekt enthält Metadaten zu einer Bilddatei in Ihrem Konto. Bilder werden Videos in Form von Miniaturbildern, Videostandbildern oder Logo-Overlays zugewiesen. Bilder können das JPEG-, GIF- oder PNG-Format aufweisen. Bei der Erstellung eines neuen Bildes ist nur die type-Eigenschaft erforderlich. Wenn Sie keine Datei hochladen, muss zudem die remoteUrl-Eigenschaft angegeben werden. Weitere Informationen finden Sie unter Hinzufügen von Bildern zu Videos mithilfe der Medien-API und Hinzufügen von Logo-Overlays zu Videos mithilfe der Medien-API.

Eigenschaftsname Typ Schreibgeschützt? Beschreibung
id Long Ja Eine Nummer, die das Bild eindeutig identifiziert. Diese ID wird bei der Erstellung des Bildes automatisch von Video Cloud zugewiesen.
referenceId String Nein Eine benutzerdefinierte Kennung zur eindeutigen Identifikation des Bildes.
type ImageTypeEnum Nein THUMBNAIL, VIDEO_STILL oder LOGO_OVERLAY. Der Typ ist schreibbar und bei der Erstellung eines Bildes erforderlich. Er kann anschließend nicht mehr geändert werden.
remoteUrl String Nein Die URL einer Remote-Bilddatei. Diese Eigenschaft ist erforderlich, wenn Sie keine Datei für das Bild hochladen.
displayName String Nein Der im Medienmodul angezeigte Name des Bildes.

Rendition-Objekt

Das Rendition-Objekt bezieht sich auf eine der Wiedergabeversionen für das Streaming mit variablen Bitraten eines Videos mit einem MP4- oder FLV-Container (Versionen mit einem M2TS-Container finden Sie im iOS-Rendition-Objekt). Ein Video sollte über insgesamt höchstens 10 Rendition- und iOS-Rendition-Objekte verfügen. Weitere Informationen finden Sie unter Streaming mit variablen Bitraten und Erstellen von Videos für das Streaming mit variablen Bitraten mittels der Medien-API.

Eigenschaftsname Typ Schreibgeschützt? Beschreibung
audioOnly Boolesch Nein Bei „true“ enthält diese Wiedergabeversion nur Audio und keinen Videocontent. Nur-Audio-Wiedergabeversionen können für das Mobilgeräte-Streaming über Verbindungen mit niedriger Bandbreite verwendet werden Wir empfehlen, Videos in iOS-Anwendungen eine Nur-Audio-Wiedergabeversionen mit 64 kbit/s hinzuzufügen.
controllerType Aufzählung Nein Abhängig von Ihrem CDN einer der folgenden Werte:
  • AKAMAI_STREAMING
  • AKAMAI_SECURE_STREAMING
  • AKAMAI_LIVE
  • AKAMAI_HD
  • AKAMAI_HD_LIVE
  • LIMELIGHT_LIVE
  • LIMELIGHT_MEDIAVAULT
Weitere Informationen finden Sie unter Festlegen des controllerType.
encodingRate Ganzzahl Ja Die Codierrate der Wiedergabeversion in Bit pro Sekunde.
frameHeight Ganzzahl Ja Die Anzeigehöhe der Wiedergabeversion in Pixeln.
frameWidth Ganzzahl Ja Die Anzeigebreite der Wiedergabeversion in Pixeln.
id Long Nein Die Video-ID.
referenceid String Nein Die Videoreferenz-ID.
remoteUrl String Nein Für Remoteobjekte erforderlich. Der vollständige Pfad der auf dem Remoteserver gehosteten Datei. Wenn die Datei über den progressiven Download bereitgestellt wird, müssen Sie den Namen und die Erweiterung der Datei angeben. Sie können auch eine URL zur Weiterleitung an eine URL verwenden, die den Namen und die Erweiterung der Datei enthält. Wenn die Datei per Flash-Streaming bereitgestellt wird, geben Sie den Stream-Namen über das remoteStreamName-Attribut an.
remoteStreamName String Nein [Optional, nur für das Streaming von Remoteobjekten erforderlich] Ein Stream-Name für das Flash-Streaming, der an den Wert der remoteUrl-Eigenschaft angehängt wird.
size Long Ja Erforderlich. Die Dateigröße der Wiedergabeversion in Byte.
uploadTimestampMillis Long Nein Das Datum/die Uhrzeit im Epoch-Millisekundenformat, an dem bzw. zu der das Video zu Video Cloud hochgeladen wurde.
url String Ja Die URL der Datei mit der Wiedergabeversion.
videoCodec Aufzählung Nein Erforderlich. Gültige Werte sind SORENSON, ON2 und H264.
videoContainer Aufzählung Nein Das Format des Wrappers, der Metadaten bereitstellt und beschreibt, wie das Video und Audio in der Datei gespeichert sind. FLV und MP4 sind gültige Werte (Werte für M2TS-Versionen finden Sie im iOS-Rendition-Objekt). Weitere Informationen finden Sie unter Unterstützte Videocodes und Container.
videoDuration Long Nein Erforderlich. Die Länge des Remote-Videocontents in Millisekunden.

Festlegen des controllerType

Der Wert des Felds controllerType im Rendition-Objekt kann davon abhängen, wie Sie Content bereitstellen und welches CDN Sie verwenden. Mögliche Werte für controllerType:

controllerType-Wert Beschreibung
AKAMAI_STREAMING Akamai-CDN, nicht live, ohne TTL
AKAMAI_SECURE_STREAMING Akamai-CDN, nicht live, mit TTL
AKAMAI_LIVE Akamai-CDN, live, ohne DVR
AKAMAI_HD Akamai HD
AKAMAI_HD_LIVE live mit DVR (egal, ob das Haupt-CDN Ihres Kontos Akamai ist oder nicht)
LIMELIGHT_LIVE Limelight CDN, live
LIMELIGHT_MEDIAVAULT Limelight CDN, unter Verwendung der Serviceoption Media Vault von Limelight

iOS-Rendition-Objekt

Das iOS-Rendition-Objekt bezieht sich auf eine der Wiedergabeversionen für das Streaming mit variablen Bitraten eines Videos mit dem Containertyp M2TS, d. h. ein auf iOS-Geräten abspielbarer HLS-Stream. Ein Video sollte über insgesamt höchstens 10 Rendition- und iOS-Rendition-Objekte verfügen. Weitere Informationen finden Sie unter Streaming mit variablen Bitraten und Erstellen von Videos für das Streaming mit variablen Bitraten mittels der Medien-API.

Eigenschaftsname Typ Schreibgeschützt? Beschreibung
audioOnly Boolesch Nein Bei „true“ enthält diese Wiedergabeversion nur Audio und keinen Videocontent. Nur-Audio-Wiedergabeversionen können für das Mobilgeräte-Streaming über Verbindungen mit niedriger Bandbreite verwendet werden Wir empfehlen, Videos in iOS-Anwendungen eine Nur-Audio-Wiedergabeversionen mit 64 kbit/s hinzuzufügen.
controllerType Aufzählung Nein STANDARD
encodingRate Ganzzahl Ja Die Codierrate der Wiedergabeversion in Bit pro Sekunde.
frameHeight Ganzzahl Ja Die Anzeigehöhe der Wiedergabeversion in Pixeln.
frameWidth Ganzzahl Ja Die Anzeigebreite der Wiedergabeversion in Pixeln.
id Long Nein Die Video-ID.
referenceid String Nein Die Videoreferenz-ID.
remoteUrl String Nein Für Remoteobjekte erforderlich. Der vollständige Pfad der auf dem Remoteserver gehosteten Datei. Wenn die Datei über den progressiven Download bereitgestellt wird, müssen Sie den Namen und die Erweiterung der Datei angeben. Sie können auch eine URL zur Weiterleitung an eine URL verwenden, die den Namen und die Erweiterung der Datei enthält. Wenn die Datei per Flash-Streaming bereitgestellt wird, geben Sie den Stream-Namen über das remoteStreamName-Attribut an.
remoteStreamName String Nein [Optional, nur für das Streaming von Remoteobjekten erforderlich] Ein Stream-Name für das Flash-Streaming, der an den Wert der remoteUrl-Eigenschaft angehängt wird.
size Long Ja Erforderlich. Die Dateigröße der Wiedergabeversion in Byte.
uploadTimestampMillis Long Nein Das Datum/die Uhrzeit im Epoch-Millisekundenformat, an dem bzw. zu der das Video zu Video Cloud hochgeladen wurde
url String Nein Die URL für den m3u8-Stream.
videoCodec Aufzählung Nein Erforderlich. Der gültige Wert lautet H264.
videoContainer Aufzählung Nein Das Format des Wrappers, der Metadaten bereitstellt und beschreibt, wie das Video und Audio in der Datei gespeichert sind. Der gültige Wert lautet M2TS. Weitere Informationen finden Sie unter Unterstützte Videocodes und Container.
videoDuration Long Nein Erforderlich. Die Länge des Remote-Videocontents in Millisekunden.

CuePoint-Objekt

Ein CuePoint-Objekt markiert einen genauen Zeitpunkt während der Dauer eines Videos. Mithilfe von Cue-Points können Sie Mid-Roll-Anzeigen auslösen oder Kapitel bzw. Szenen in langen Videos unterteilen. Weitere Informationen finden Sie unter Hinzufügen von Cue-Points zu Videos und Festlegen von Cue-Points mit der Medien-API.

Eigenschaftsname Typ Schreibgeschützt? Beschreibung
name String Ja Erforderlich. Ein Name für den Cue-Point, mit dem Sie darauf verweisen können.
videoId String Ja Eine Liste (mit Komma als Trennzeichen) der IDs von einem oder mehreren Videos, auf die dieser Cue-Point angewendet wurde.
time Long Ja Erforderlich. Die Zeit des Cue-Points, gemessen in Millisekunden ab dem Beginn des Videos.
forceStop Boolesch Nein Wenn dieser Parameter auf „true“ eingestellt ist, wird die Wiedergabe des Videos am Cue-Point gestoppt. Diese Einstellung gilt nur für Anzeigen-Cue-Points.
type Aufzählung Ja Erforderlich. Ein ganzzahliger Code, der den Typ des Cue-Points angibt. Entweder 0 (AD, Anzeige) oder 1 (CODE). Ein Anzeigen-Cue-Point dient zum Auslösen von Mid-Roll-Anzeigenanforderungen. Ein Code-Cue-Point kann ein neues Kapitel oder eine neue Szene im Video markieren.
metadata String Nein Ein String, der mit einem CODE-Cue-Point übergeben werden kann. Maximal 512 Zeichen.

 

LogoOverlay-Objekt

Ein LogoOverlay-Objekt bezieht sich auf das einem Video zugewiesene Logo-Overlay. Ein Logo-Overlay wird während der gesamten Dauer des Videos über einem Teil des Videodisplays eingeblendet. Weitere Informationen finden Sie unter Erstellen von Logo-Overlays und Hinzufügen von Logo-Overlays zu Videos mithilfe der Medien-API. Sie können auch ein standardmäßiges Logo-Overlay für Ihr Konto festlegen. Wenn ein Logo-Overlay auf Kontoebene und ein Logo-Overlay für ein Video festgelegt sind, wird das Logo-Overlay des Videos angezeigt, das Logo-Overlay auf Kontoebene dagegen nicht.

Eigenschaftsname Typ Beschreibung
id Long Eine Nummer, die das Logo-Overlay eindeutig identifiziert. Diese ID wird bei der Erstellung des LogoOverlays automatisch von Video Cloud zugewiesen.
image Image Ein Image-Objekt, das über die id- oder referenceId-Eigenschaft definiert wird, mit der Einstellung type=LOGO_OVERLAY.
tooltip String Optional. Text, der eingeblendet wird, wenn der Betrachter mit der Maus auf das Logo-Overlay zeigt.
linkURL String Optional. Eine URL, die aufgerufen wird, wenn der Betrachter auf das Logo-Overlay klickt.
alignment Aufzählung Optional. LogoOverlayAlignmentEnum zum Festlegen der Ausrichtung des Logo-Overlays relativ zum Videodisplay. Einer der folgenden Werte: TOP_LEFT, BOTTOM_LEFT, TOP_RIGHT oder BOTTOM_RIGHT. Der Standardwert ist BOTTOM_RIGHT.
Tags
Verweis