Support Kontakt Support | Systemstatus Systemstatus
Seiteninhalt

    Füge Cue-Punkte hinzu

    In diesem Beispiel erfahren Sie, wie Sie Cue-Points programmgesteuert mit einem Video zu einem Video hinzufügen CMS API.

    Einführung

    Cue-Points sind bestimmte Stellen auf der Video-Timeline. Bei der Wiedergabe des Videos wird jedes Mal, wenn ein Cue-Punkt erreicht ist, automatisch ein Ereignis gesendet Player APISie können auf diese Ereignisse hören und alle gewünschten Maßnahmen ergreifen. Darüber hinaus können Sie alle Cue-Point-Informationen aus den im Metadaten gespeicherten Video-Metadaten lesen player mediainfo Objekt, das Ihnen erlaubt Markieren Sie die Cue-Points auf der Video-Timeline in gewisser Weise, wenn du willst.

    Es gibt zwei Arten von Cue-Points:

    • Anzeigenpunkte: Diese werden verwendet, um Stellen zu markieren, an denen eine Anzeigenanfrage gestellt werden soll (wenn das Video und player sind für Werbung aktiviert).
    • Code-Cue-Points: Diese werden verwendet, um mithilfe der Player API - Einige typische Verwendungszwecke sind das Anzeigen einer Art Handlungsaufforderung (Call-to-Action, CTA) oder das Anzeigen von Bildern oder Texten in Bezug auf Videoinhalte, möglicherweise als Video-Overlay oder auf der Seite um das player.

    Implementierungsübersicht

    Sie können Cue-Points hinzufügen das Studio Medienmodul. Sie können sie auch mithilfe der hinzufügen CMS API, das ist die Methode, die wir in diesem Beispiel verwenden werden.

    HTTP-Methode

    Cue-Punkte können entweder hinzugefügt werden, wenn Sie Erstelle das Video oder später mit einem Anfrage aktualisieren. In diesem Beispiel fügen wir sie zu einem bestehenden Video hinzu, indem wir ein Video-Update Anfrage, was bedeutet, dass Sie die verwenden werden PATCH Methode.

    Endpunkt

    Der Endpunkt für die Update-Videoanfrage ist:

              https://cms.api.brightcove.com/v1/accounts/account_id/ Videos /video_id

    Anfrage Körper

    Der Anfragetext ist ein JSON-Objekt, das viele Elemente von Video-Metadaten enthalten kann. Hier sehen wir uns nur die cue_points Feld, das wie im folgenden Beispiel auf ein Array von Cue-Point-Objekten festgelegt ist:

              {
              "cue_points": [
                  {
                    "name": "Ad Cue Point",
                    "type": "AD",
                    "time": 2.0,
                    "metadata": null,
                    "force_stop": false
                  },
                  {
                    "name": "Code Cue Point",
                    "type": "CODE",
                    "time": 4.0,
                    "metadata": "The metadata might be text or the url for an image to display",
                    "force_stop": true
                  }
                ]
              }

    Cue-Point-Objektfelder

    Im Folgenden finden Sie eine Beschreibung der Felder für Cue-Point-Objekte.

    Cue-Point-Objektfelder
    Feld Typ Erforderlich Beschreibung
    name Schnur nicht Ein beliebiger Name - Dies kann nützlich sein, um einen bestimmten Cue-Point in Ihrem zu identifizieren Player API Code
    type Schnur ja Muss sein AD or CODE
    time Anzahl ja Zeit für den Cue-Point in Sekunden ab dem Beginn des Videos [1]
    metadata Schnur nicht Jede Zeichenfolge, die bis zu 128-Einzelbyte-Zeichen reicht - dies können Informationen sein, die für Ihre Cue-Point-Ereignisbehandlungsroutine nützlich sind, z. B. der Text für eine Überlagerung oder der Speicherort eines anzuzeigenden Bilds
    force_stop boolean nicht Ob das Video angehalten werden soll, wenn der Cue-Point erreicht ist ( force_stop wird von der ignoriert Brightcove Player und es gibt derzeit keine Pläne, es zu unterstützen, aber Sie können das Video manuell in Ihrem Cue-Point-Event-Handler anhalten.

    Einschränkungen

    • [1] Technisch gesehen ist der Cue - Punkt aktiv, bis der nächste Cue - Punkt erreicht ist - also im Cue - Points - Array, das Sie aus dem Cue - Point abrufen können Brightcove Playerwirst du sehen startTime und endTime auch bei a time für den Cue-Punkt.

    Abrufen von Authentifizierungsdaten

    So verwenden Sie die CMS API Sie benötigen ordnungsgemäße Anmeldeinformationen.

    Der einfachste Weg, um Anmeldeinformationen in den meisten Fällen zu erhalten, ist über den Bereich "Studio Admin API Authentication" (erfordert Administratorberechtigungen für Ihr Konto). Sehen API-Authentifizierungsdaten verwalten für Details. In den meisten Fällen möchten Sie wahrscheinlich nur Berechtigungen für alle erhalten CMS API Operation:

    CMS API Berechtigungen
    CMS API Berechtigungen

    Wenn die von Ihnen benötigten Berechtigungen in Studio nicht verfügbar sind oder wenn Sie sie direkt von der OAuth API, benutze deine Wahl der Erhalten Sie Clientanmeldeinformationen Dokumente unten aufgeführt. Für welche Option Sie sich auch entscheiden, Sie müssen nach den richtigen Zugriffsberechtigungen fragen. Folgendes kann mit cURL oder Postman verwendet werden, um alle Berechtigungen für die CMS API:

              "operations": [
                "video-cloud/video/all",
                "video-cloud/playlist/all",
                "video-cloud/sharing-relationships/all",
                "video-cloud/notifications/all"
              ]

    Beispiel-App

    Hier finden Sie den gesamten mit diesem Beispiel verbundenen Code GitHub-Repository.

    Sieh den Stift CMS API Beispiel: Fügen Sie Cue-Punkte hinzu von Brightcove Learning Services ( @ rcrooks1969) Auf CodePen.

    Verwenden des CodePen

    • Schalten Sie die aktuelle Anzeige der App um, indem Sie auf klicken Ergebnis .
    • Klicken Sie auf die HTML / CSS / JS Schaltflächen, um einen der Codetypen anzuzeigen.
    • Klicken Sie Auf CodePen bearbeiten in der oberen rechten Ecke, um diesen CodePen in Ihr eigenes Konto einzugeben.
    • Hier finden Sie den gesamten mit diesem Beispiel verbundenen Code GitHub-Repository.

    Proxy-Code

    Um Ihre eigene Version der Beispiel-App auf dieser Seite zu erstellen, müssen Sie Ihren eigenen Proxy erstellen und hosten. (Die von Brightcove Learning Services verwendeten Proxys akzeptieren nur Anforderungen von Brightcove-Domänen.) Ein Beispiel-Proxy, der dem von uns verwendeten sehr ähnlich ist, jedoch ohne die Überprüfungen, die Anforderungen von Nicht-Brightcove-Domänen blockieren, befindet sich in Dieses GitHub-Repository. Dort finden Sie auch grundlegende Anweisungen zur Verwendung und eine ausführlichere Anleitung zum Erstellen von Apps rund um den Proxy in Verwenden der REST-APIs.


    Seite zuletzt aktualisiert am 29