Anleitung zur Player-Konfiguration

In diesem Thema wird beschrieben, wie Sie die Player-Konfiguration anzeigen und ändern können. Die JSON-Syntax ist ebenfalls dokumentiert.

Einleitung

Die Eigenschaften, die Sie in der Player-Konfiguration einstellen können, sind unten aufgeführt (und in der linken Navigation aufgelistet) beginnend mit account_id. Dieses Dokument enthält auch Informationen zum Anzeigen und Konfigurieren von Eigenschaftswerten.

Konfiguration anzeigen

Es gibt zahlreiche Möglichkeiten, die Konfiguration des Players anzuzeigen, die in diesem Abschnitt beschrieben werden.

Verwenden von Studio

Sie können Studio verwenden, um die JSON-Konfiguration des Players anzuzeigen. Der folgende Schritt beschreibt den Prozess:

  1. Öffne das SPIELER Modul und suchen Sie den Player, dessen Konfiguration Sie anzeigen möchten.
  2. Klicken Sie auf den Link für den Spieler, um die Eigenschaften des Spielers zu öffnen.
  3. Klicken JSON-Editor im linken Navigationsmenü.
  4. Sie können die Konfiguration des Players ähnlich wie folgt anzeigen:
    JSON-Editor

Surfen mit config.json

Eine Instanz der Konfiguration des neuen Brightcove-Players wird in einer JSON-Datei gespeichert. Sie können diese JSON-Datei oder Teile davon auf verschiedene Weise anzeigen.

Eine Möglichkeit, die Player-Konfiguration anzuzeigen, besteht darin, die URL des Players so zu ändern, dass sie nicht mit endet index.html zu config.json. Zum Beispiel:

  http://players.brightcove.net/1507807800001/HJyMlHiuZ_default/config.json

Einige der Eigenschaften in der Player-Konfiguration definieren Folgendes:

  • Der Name und die Version des Spielers
  • Die Videos, die der Player abspielen wird
  • Das Konto, zu dem der Spieler gehört
  • Die ID des Spielers
  • Alle Plugins, die der Player verwenden kann, sowie die URLs für die Speicherorte des Plugin-Codes
  • Ein Poster zum Anzeigen vor der Videowiedergabe

Eine Beispiel-Player-Konfigurationsdatei für einen Player aus der Schritt-für-Schritt-Anleitung: Die Spielerverwaltung lautet wie folgt:

  {
      "player": {
        "template": {
          "version": "0.9.5",
          "name": "single-video-template"
        }
      },
      "media": {
        "poster": {
          "highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
        },
        "sources": [{
          "type": "application/x-mpegURL",
          "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
        }, {
          "type": "video/mp4",
          "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
        }]
      },
      "scripts": [
        "http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"
      ],
      "stylesheets": [
        "http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"
      ],
      "plugins": [{
        "name": "firstPlugin"
      }],
      "account_id": "1507807800001",
      "player_id": "54ade2f3-3b51-4a6b-bc87-32b9a0b81384",
      "embed_id": "default"
  }
  {
      "media": {
        "poster": {
          "highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
        },
        "sources": [{
          "type": "application/x-mpegURL",
          "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
        }, {
          "type": "video/mp4",
          "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
        }]
      },
      "video_cloud": {
        "video": "4093372393001",
        "policy_key": "BCpkADawqM2FnBS3Inxz...ZzHMB6hT"
      },
      "player": {
        "template": {
          "name": "single-video-template",
          "version": "6.5.0"
        }
      },
      "scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
      "stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
      "plugins": [{
        "name": "firstPlugin"
      }]
  }

ERHALTEN Sie mit $PLAYER_ID/configuration Endpunkt

Sie können dieselben Informationen abrufen, die gerade angezeigt wurden, indem Sie HTTP verwenden GET Methode. Verwenden von GET mit dem /$PLAYER_ID/configuration Endpunkt können Sie abrufen veröffentlichte Spieler Konfigurationsinformationen. Eine Beispiel-Curl-Anweisung und die abgerufene JSON wird hier gezeigt:

  curl \
  --header "Content-Type: application/json" \
  --user $EMAIL \
  --request GET \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
  {
      "player": {
        "template": {
          "version": "0.9.5",
          "name": "single-video-template"
        }
      },
      "media": {
        "poster": {
          "highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
        },
        "sources": [{
          "type": "application/x-mpegURL",
          "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
        }, {
          "type": "video/mp4",
          "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
        }]
      },
      "scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
      "stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
      "plugins": [{
        "name": "firstPlugin"
      }]
  }
  {
      "media": {
        "poster": {
          "highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
        },
        "sources": [{
          "type": "application/x-mpegURL",
          "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
        }, {
          "type": "video/mp4",
          "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
        }]
      },
      "video_cloud": {
        "video": "4093372393001",
        "policy_key": "BCpkADawqM2FnBS3InxzDx...HMB6hT"
      },
      "player": {
        "template": {
          "name": "single-video-template",
          "version": "6.5.0"
        }
      },
      "scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
      "stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
      "plugins": [{
        "name": "firstPlugin"
      }]
  }

GET-Methode $PLAYER_ID Endpunkt

Das HTTP GET Methode verwendet mit der /$PLAYER_ID Endpunkt ist der Weg, um vollständige Spielerinformationen abzurufen. Dieser Ansatz liefert eine Obermenge der Player-Konfiguration, die Sie gerade gesehen haben. Sie können sich diesen Endpunkt vorstellen, der Ihnen Konfigurationsinformationen "eine Ebene höher" anzeigt und aktuelle Konfigurationsinformationen sowohl für die Vorschau- als auch für die veröffentlichten Player-Versionen enthält. Eine Beispiel-Curl-Anweisung und die abgerufene JSON wird hier gezeigt:

  curl \
  --header "Content-Type: application/json" \
  --user $EMAIL \
  --request GET \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID
  {
      "id": "HJyMlHiuZ",
      "name": "Video Cloud CURL 10 March",
      "branches": {
        "preview": {
          "configuration": {
            "plugins": [{
              "name": "firstPlugin"
            }],
            "stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
            "scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
            "player": {
              "template": {
                "version": "6.5.0",
                "name": "single-video-template"
              }
            },
            "video_cloud": {
              "policy_key": "BCpkADawqM2FnBS3Inx...N44i24jZzHMB6hT",
              "video": "4093372393001"
            },
            "media": {
              "sources": [{
                "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8",
                "type": "application/x-mpegURL"
              }, {
                "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4",
                "type": "video/mp4"
              }],
              "poster": {
                "highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
              }
            }
          },
          "video_cloud": {
            "aspect_ratio_height": "9",
            "aspect_ratio_width": "16",
            "video_id": "4093372393001",
            "poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_4093546643001_7c09c5bb-7643-414d-81da-847a7e5e3654-AWSAccessKeyId-AKIAJWBBMGHEBQ6SISMA-Expires-1425580379-Signature-h4xCk8Zf9xH-2Be779r9ltwGI7Jzg-3D-vs.jpg?pubId=1507807800001&videoId=4093372393001"
          },
          "updated_at": "2017-08-23T18:09:52.590Z",
          "template_updated_at": "2017-08-23T17:48:55.615Z",
          "preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/HJyMlHiuZ/preview/embeds/default/master/index.html"
        },
        "master": {
          "configuration": {
            "media": {
              "poster": {
                "highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
              },
              "sources": [{
                "type": "application/x-mpegURL",
                "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
              }, {
                "type": "video/mp4",
                "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
              }]
            },
            "video_cloud": {
              "video": "4093372393001",
              "policy_key": "BCpkADawqM2FnBS3InxzD...4i24jZzHMB6hT"
            },
            "player": {
              "template": {
                "name": "single-video-template",
                "version": "6.5.0"
              }
            },
            "scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
            "stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
            "plugins": [{
              "name": "firstPlugin"
            }]
          },
          "video_cloud": {
            "poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_4093546643001_7c09c5bb-7643-414d-81da-847a7e5e3654-AWSAccessKeyId-AKIAJWBBMGHEBQ6SISMA-Expires-1425580379-Signature-h4xCk8Zf9xH-2Be779r9ltwGI7Jzg-3D-vs.jpg?pubId=1507807800001&videoId=4093372393001",
            "video_id": "4093372393001",
            "aspect_ratio_width": "16",
            "aspect_ratio_height": "9"
          },
          "updated_at": "2017-08-23T18:10:11.843Z",
          "template_updated_at": "2017-08-23T17:48:55.622Z",
          "preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/HJyMlHiuZ/master/embeds/default/master/index.html"
        }
      },
      "created_at": "2017-08-23T17:48:55.615Z",
      "accountId": "1507807800001",
      "embed_count": 1,
      "url": "http://players.brightcove.net/1507807800001/HJyMlHiuZ_default/index.html"
  }
  {
      "account_id": "1507807800001",
      "branches": {
        "preview": {
          "configuration": {
            "plugins": [{
              "name": "firstPlugin"
            }],
            "stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
            "scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
            "player": {
              "template": {
                "version": "1.5.0",
                "name": "single-video-template"
              }
            },
            "video_cloud": {
              "policy_key": "BCpkADawqM3ClR-sni6...AdvTpTb29d4S-BH",
              "video": "3495887198001"
            }
          },
          "video_cloud": {
            "aspect_ratio_height": "14",
            "aspect_ratio_width": "25",
            "video_id": "3495887198001",
            "poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_3495968128001_humbles-scrappy-statue2-vs.jpg?pubId=1507807800001"
          },
          "updated_at": "2014-10-23T14:33:21.107Z",
          "preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/a90a8479-9831-46f6-9eab-90efc7fb9c6b/preview/embeds/default/master/index.html"
        },
        "master": {
          "configuration": {
            "video_cloud": {
              "video": "3495887198001",
              "policy_key": "BCpkADawqM3ClR-sn...tHcAdvTpTb29d4S-BH"
            },
            "player": {
              "template": {
                "name": "single-video-template",
                "version": "1.5.0"
              }
            },
            "scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
            "stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
            "plugins": [{
              "name": "firstPlugin"
            }]
          },
          "video_cloud": {
            "poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_3495968128001_humbles-scrappy-statue2-vs.jpg?pubId=1507807800001",
            "video_id": "3495887198001",
            "aspect_ratio_width": "25",
            "aspect_ratio_height": "14"
          },
          "updated_at": "2014-10-23T14:33:41.201Z",
          "preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/a90a8479-9831-46f6-9eab-90efc7fb9c6b/master/embeds/default/master/index.html"
        }
      },
      "id": "a90a8479-9831-46f6-9eab-90efc7fb9c6b",
      "name": "1031+on+Oct+23",
      "created_at": "2014-10-23T14:32:21.384Z",
      "embed_count": 1,
      "url": "http://players.brightcove.net/1507807800001/a90a8479-9831-46f6-9eab-90efc7fb9c6b_default/index.html"
  }

Name/Beschreibung festlegen

Um die Player-Konfiguration zu ändern, verwenden Sie die /$ACCOUNT_ID/players/$PLAYER_ID/configuration Endpunkt, und das ist der Schwerpunkt dieses Dokuments. Es gibt jedoch zwei Eigenschaften, die Sie nur mit der ändern /$ACCOUNT_ID/players/$PLAYER_ID Endpunkt. Diese beiden Eigenschaften sind name und description.

Beachten Sie das name Sie geben für den Spieler zurück als player_name wenn Sie die Konfiguration erhalten, indem Sie setzen config.json am Ende der Player-Vorschau-URL (wird zurückgegeben als name wenn Sie die Konfiguration über die Player Management API erhalten. Aber du musst verwenden name wenn Sie den Player erstellen oder aktualisieren.

Der erste Codeblock zeigt ein Beispiel für eine curl-Anweisung, die das eines Spielers ändert name und description. Beachten Sie, dass die JSON-Antwort zeigt, dass Vorschauversionen des Players von der PATCH-Methode generiert werden, sodass Sie den Player veröffentlichen müssen, um die optimierten Versionen zu erhalten.

  curl \
  --header "Content-Type: application/json" \
  --user $EMAIL \
  --request PATCH \
  --data '{
    "name": "My New Player Name",
    "description": "My new player description"
  }' \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
  {
      "id": "62da9b4d-b8aa-45d5-ba46-f77eac9c9059",
      "preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/62da9b4d-b8aa-45d5-ba46-f77eac9c9059/preview/embeds/default/master/index.html",
      "preview_embed_code": "<iframe src='//preview-players.brightcove.net/v1/accounts/1507807800001/players/62da9b4d-b8aa-45d5-ba46-f77eac9c9059/preview/embeds/default/master/index.html' allowfullscreen allow='encrypted-media'></iframe>"
  }

Einstellwerte

Sie können die Player-Konfigurationswerte mit jedem Tool festlegen, das HTTP-Methodenaufrufe ausgibt ODER mit der JSON-Editor das ist Teil von Studio's SPIELER Modul. Das curl-Tool kann verwendet werden, und Beispielanweisungen werden in der Schritt für Schritt: Spielerverwaltung und AJAX-Nutzung in vielen der Brightcove Player-Beispiele.

Eine Beispieländerung mit dem JSON-Editor wird hier angezeigt:

JSON Editor kein Brightcove Player-Branding

Achten Sie darauf, Ihre Änderungen zu speichern, nachdem Sie die JSON-Konfiguration des Players bearbeitet haben.

Eigenschaften konfigurieren

Einige Konfigurationseigenschaften werden vom Player Management Service festgelegt und können nicht geändert werden. Jene sind:

  • account_id
  • Spieler-ID
  • embed_id

Alle anderen unten aufgeführten Eigenschaften können geändert werden.

Details zu den Eigenschaften folgen. Sie können die folgende Liste verwenden, um schnell auf bestimmte Eigenschaften zuzugreifen.

account_id

Die dem Player zugeordnete Video Cloud-Konto-ID. Dieser Wert kann nicht geändert werden.

ad_config_id

ad_config_id information:

  • Datentyp: string
  • Standard: undefined
  • Eine SSAI-Anzeigenkonfigurations-ID für Dynamic Delivery. Sie kann nicht nur in der Player-Konfiguration festgelegt werden, sondern kann auch zur Laufzeit über den Abfragezeichenfolgenparameter adConfigId für iframe-Player oder das data-ad-config-id-Attribut für In-Page-Player festgelegt werden. Beides überschreibt alle Werte in der Player-Konfiguration.

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
Daten-Anzeige-Konfigurations-ID HTML-Attribut in-Seite Überschreibt die Konfiguration
adConfigId Parameter abfragen iframe Überschreibt die Konfiguration

ad_failover

ad_failover information:

  • Datentyp: boolescher Wert
  • Standard: undefined
  • Auf "true" setzen, um das Anzeigen-Failover-Verhalten zu aktivieren. Dies ist eine mehrteilige Konfiguration, die abhängig ist von:
    • Sowohl IMA3- als auch SSAI-Plugins müssen auf dem Player konfiguriert werden.
    • Ein ad_config_id sollte verfügbar sein, andernfalls sind SSAI-Anzeigen nicht verfügbar.

Bei Einstellung auf wahr Der Player verzögert den automatischen Initialisierungsprozess, bis die Ad-Block-Erkennung eine Entscheidung getroffen hat. Dies kann die Initialisierung des Spielers um bis zu 100 Millisekunden verzögern.

application_id

application_id information:

  • Datentyp: string
  • Standard: undefined
  • Die Anwendungs-ID wird verwendet, um mehrere Verwendungen eines einzelnen Players in Metriken zu unterscheiden. Es ist für den Benutzer unsichtbar.

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
Datenanwendungs-ID HTML-Attribut in-Seite Überschreibt die Konfiguration
Anwendungs-ID Parameter abfragen iframe Überschreibt die Konfiguration

nur Audio-Wiedergabe

Bei der Verwendung von Audio-Assets mit dem Brightcove-Player gibt es zwei Optionen zum Anpassen des Players:

  • Nur Audio-Modus

    In diesem Modus ist die gesamte Benutzeroberfläche des Spielers bis auf die Kontrollleiste ausgeblendet.

  • Audio-Poster-Modus

    In diesem Modus wird das Posterbild während der Wiedergabe permanent angezeigt. Die Abmessungen des Players bleiben in diesem Modus dieselben wie bei einem Videoplayer.

Beide Modi können nicht gleichzeitig aktiviert werden.

  • Wenn beide audio_only_mode und in der Player-Konfiguration auf true gesetzt audio_poster_mode sind, hat der Modus Nur Audio Vorrang.
  • Wenn Sie einen Modus programmgesteuert über player.audioOnlyMode(true) oder aktivieren, player.audioPosterMode(true) wird der andere Modus deaktiviert, falls er aktiviert ist.

Einzelheiten zur Implementierung finden Sie im Dokument Nur Audio mit Brightcove-Player .

automatischer Vorlauf

autoadvance information:

  • Datentyp: string
  • Standard: Anfangs nicht aktiviert
  • Wird mit Wiedergabelisten verwendet und legt das automatische Vorschubverhalten der Wiedergabeliste fest.

Weitere Informationen finden Sie im Wiedergabelisten Abschnitt unten, sowie die Playlist-API dokumentieren.

Autoplay

autoplay information:

  • Datentyp: boolean oder string
  • Standard: false
  • Zeigt an, dass der Spieler sofort mit dem Spielen beginnen sollte, auf Plattformen, auf denen dies zulässig ist.

Wenn autoplay auf einen booleschen Wert gesetzt ist, wird das native Autoplay-Verhalten des Browsers verwendet. Wenn es auf einen der folgenden drei gültigen Zeichenfolgenwerte festgelegt ist, tritt Folgendes auf:

  • play: Der Spieler wird manuell versuchen, Play aufzurufen.
  • muted: Der Spieler schalte den Spieler manuell stumm und ruft Play an.
  • any: Der Spieler wird zuerst versuchen, Play aufzurufen. Wenn das fehlschlägt, schalten Sie den Spieler stumm und rufen Sie Play an.

Wenn einer der oben genannten Punkte fehlschlägt, zeigt der Spieler den „Big Play Button“ an, als wäre das Autoplay auf false gesetzt.

Das Folgende zeigt eine curl-Anweisung zum Festlegen der autoplay Wert:

Beispiel mit booleschen Werten

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
      "autoplay": true
      }' \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

Beispiel mit Zeichenfolgenwerten

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
      "autoplay": "muted"
      }' \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

Ein Video zur Autoplay zu bringen, kann eine komplexe Situation sein. Siehe die Überlegungen zur automatischen Wiedergabe Dokument für weitere Details.

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
Autoplay HTML-Attribut in-Seite Dies ist nur ein boolesches Attribut. Alle Werte gelten als wahr.
Autoplay Parameter abfragen iframe
veraltet: in-page
Überschreibt die Konfiguration
#autoplay URL-Hash Veraltet: Iframe und In-Page Überschreibt die Konfiguration
Autoplay Spieler-Option in-Seite Überschreibt alle anderen Methoden zum Festlegen von autoplay.n

block_roboter

block_robots information:

  • Datentyp: boolescher Wert
  • Standard: undefined
  • Nur in Brightcove Player 6.51.0 und höher verfügbar.
  • Wenn true, wird a hinzugefügt <meta> Tag zum Einbetten von HTML in den Iframe, um zu verhindern, dass Roboter wie der Crawler von Google den Inhalt des HTML zum Einbetten des Iframes indizieren.

Folgendes wird hinzugefügt, wenn es wahr ist:

<meta name="robots" content="noindex,nofollow">

china_proxy_domain

china_proxy_domain information:

  • Datentyp: string
  • Standard: undefined
  • Wenn angegeben, wird diese Domäne verwendet, um Anfragen des Players an Brightcove-Dienste über einen alternativen Hostnamen weiterzuleiten. Ein Beispiel ist:
    "china_proxy_domain": "china.example.com"

Kontextmenü

context_menu information:

  • Datentyp: Boolescher Wert oder Objekt
  • Standard: true
  • Wenn wahr oder ein Objekt enthält der Player ein Kontextmenü, das bei jedem zweiten Rechtsklick oder jeder langen Berührung aktiviert wird. Dieses Kontextmenü kann ein Modal für Spielerinformationen oder einen Link zur Unternehmenswebsite von Brightcove öffnen. Weitere Informationen zur Verwendung des Kontextmenüs finden Sie im Brightcove Player-Informationen Modal Dokument.

    Wenn es sich um ein Objekt handelt, wird die folgende Eigenschaft unterstützt:

    Eigentum Effekt
    brightcove_branding Kann auf eingestellt werden falsch explizit zu entfernen Über Brightcove Link aus dem benutzerdefinierten Kontextmenü.

    Beispiel:

    "context_menu": {
      "brightcove_branding": false
    }

Crossorigin

crossorigin information:

  • Datentyp: boolescher Wert
  • Standard: falsch
  • Wenn das stimmt, wird das zugrunde liegende <video> -Element crossorigin="anonymous“ haben. Dies bedeutet, dass alle Videos oder Textspuren, die in den Player gezogen werden, CORS-Header haben müssen.

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
crossorigin = "anonym" HTML-Attribut in-Seite Überschreibt die Konfiguration
Crossorigin Parameter abfragen iframe Überschreibt die Konfiguration

CSS-Farbüberschreibungen

Es gibt drei Eigenschaften, die verwendet werden können, um die Farben im Player zu überschreiben. Sie sind:

  • controlColor: Die Farbe der Schaltflächen und des Textes (z. B. Abspielposition und Videodauer)
  • controlBarColor: Die Hintergrundfarbe der Kontrollleiste und des großen Play-Buttons
  • progressColor: Die Farbe des Fortschrittsbalkens

Alle gültigen CSS-Farben (einschließlich beispielsweise Hex-Farben) sind akzeptable Werte für diese Eigenschaften.

Hier ist eine curl-Anweisung, um alle drei CSS-Eigenschaften auf Grün zu setzen, gefolgt von einem Screenshot mit den Ergebnissen:

  curl \
  --header "Content-Type: application/json" \
  --user $EMAIL \
  --request PATCH \
  --data '{
      "css": {
        "controlColor": "green",
        "controlBarColor": "green",
        "progressColor": "green"
      }
  }' \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
Player mit CSS-Überschreibungen
Player mit CSS-Überschreibungen

debuggen

debug information:

  • Datentyp: boolescher Wert
  • Standard: false
  • Wenn wahr wird der Player in den Debug-Modus versetzt. Dies kann verwendet werden, um die Protokollierung für verschiedene Player-Komponenten wie die Wiedergabe-Engine und die Analyse zu aktivieren.

Debugger

Diese Eigenschaft ist veraltet, siehe Kontextmenü.

Delivery_config_id

delivery_config_id information:

  • Datentyp: string
  • Standard: undefined
  • Eine Konfigurations-ID für dynamische Übermittlungsregeln.

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
Datenübermittlungs-Konfigurations-ID HTML-Attribut in-Seite Überschreibt die Konfiguration
DeliveryConfigId Parameter abfragen iframe Überschreibt die Konfiguration

Dock

dock information:

  • Datentyp: boolescher Wert
  • Standardwert: true
  • Wenn ausdrücklich false , wird der Spieler nicht die sogenannte Dock wo der Videotitel und die Beschreibung angezeigt werden können.

embed_id

embed_id information:

  • Datentyp: string
  • Standard: undefined
  • Die diesem Player zugeordnete Video Cloud-Einbettungs-ID. Wenn der Wert ist default es bedeutet, dass der Spieler kein untergeordneter Spieler ist. Ist der Wert nicht default , ist es ein Wert, der das Elternteil des Spielers darstellt.

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
Daten einbetten HTML-Attribut in-Seite Wird hauptsächlich verwendet, um Spieler zur Init-Zeit zu identifizieren. Kann das nicht überschreiben embedded_id in der Konfiguration gefunden.

Fehler

errors information:

  • Datentyp: Objekt oder boolescher Wert
  • Standardwert: true
  • Explizit einstellen false verhindert, dass der Spieler einschließt videojs-Fehler , das ist das Plugin für Fehlermeldungen. Wenn dieser Wert auf "false" gesetzt wird, zeigt der Player den Zuschauern keine detaillierten Fehlermeldungen an, wenn ein Fehler auftritt. Fehler, die die Wiedergabe verhindern, werden weiterhin in der Webentwicklerkonsole angezeigt.

fullscreen_control (oder fullscreenControl)

fullscreen_control information:

  • Datentyp: boolescher Wert
  • Standardwert: true
  • Gibt an, ob das Vollbild-Steuerelement in der Steuerleiste angezeigt werden soll. Wenn falsch Die Doppelklick-Vollbild-Aktion wird ebenfalls deaktiviert.

Das Folgende zeigt eine curl-Anweisung zum Festlegen der fullscreen_control Wert:

  curl \
  --header "Content-Type: application/json" \
  --user $EMAIL \
  --request PATCH \
  --data '{
    "autoplay": true,
    "fullscreen_control": false
    }' \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

Die folgenden beiden Screenshots zeigen den Player mit und ohne Vollbildsteuerung:

Player mit Vollbildsteuerung
Player mit Vollbildsteuerung
Player ohne Vollbildsteuerung
Player ohne Vollbildsteuerung

hls

hls information:

  • Datentyp: Objekt oder boolescher Wert
  • Standard: {}
  • Wenn false , wird der Spieler nicht enthalten videojs-http-streaming. Andernfalls wird ein Objekt als Optionen für übergeben videojs-http-streaming.

initial_bandwidth

initial_bandwidth information:

  • Datentyp: Nummer
  • Standard: undefined
  • Nur in 6.53.0 und neuer verfügbar
  • Legt einen anfänglichen Bit-pro-Sekunde-Wert fest, der verwendet wird, um die Wiedergabeauswahl der Wiedergabe-Engine vorzubereiten, um Szenarien mit niedriger oder hoher Bandbreite zu bevorzugen

Sprache

language information:

  • Datentyp: string
  • Standard: undefined
  • Kann bereitgestellt werden, um die einzustellen lang Attribut der <html> Element in eine Iframe-Einbettung und damit die Sprache des Players.

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
Sprache HTML-Attribut in-Seite Überschreibt die Konfiguration
Sprache Parameter abfragen iframe Überschreibt die Konfiguration

Sprachen

languages information:

  • Datentyp: String-Array
  • Standard: undefined
  • Kann ein Array von Zeichenfolgen sein, das bewirkt, dass die angegebenen Sprachen in den Player aufgenommen werden. Die einzigen gültigen Sprachen sind die in Video.js enthaltenen Sprachen. Siehe die Lokalisieren von Brightcove Player Dokument für weitere Informationen.

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
Sprachen Spieler-Option in-Seite Überschreibt die Konfiguration

Schleife

loop information:

  • Wenn wahr , bewirkt, dass das Video neu gestartet wird, sobald es endet.

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
Schleife HTML-Attribut in-Seite Dies ist nur ein boolesches Attribut. Alle Werte gelten als wahr.
Schleife Parameter abfragen iframe Überschreibt die Konfiguration
Schleife Spieler-Option in-Seite Überschreibt die Konfiguration

Medien

Das media Eigenschaft kann ein Objekt oder ein Array von Objekten sein und hat untergeordnete Eigenschaften, wie in der folgenden Tabelle gezeigt.

Eigentum Datentyp Beschreibung
Höhe String
  • Die Höhe des Videos
  • Der Standardwert bezieht sich auf die Breite und ist für ein Video mit einem Seitenverhältnis von 2:1 geeignet
Poster Objekt
  • Enthält URLs zu Posterbildern
poster.highres String
  • Der Dateipfad zum hochauflösenden Posterbild relativ zum Stammverzeichnis der Skin
poster.lowres String
  • Der Dateipfad zum Posterbild mit niedriger Auflösung, relativ zum Stammverzeichnis der Skin
poster.orig String
  • URL zum ursprünglichen, nicht dimensionierten Posterbild
Quellen Array von Objekten
  • Ein Array von Quellobjekten in der Reihenfolge ihrer Präferenz
  • Die Elemente dieses Arrays werden direkt übersetzt in source Elemente
  • EIN Quelle Objekt sollte zwei Eigenschaften haben: src und type
  • Die type -Attribut ist der MIME-Typ des Videos, wie im HTML5-Standard festgelegt
Quellen []. src String
  • Die URL zu einer Medienressource für diese Quelle
Quellen. []. Typ
  • Der MIME-Typ der Medienressource, wie im HTML5-Standard für diese Quelle angegeben (z video / mp4).
src String
  • Wenn nur eine Quelle benötigt wird, die URL zur Medienressource
Titel String
  • Inhalt der <title> Element der Seite
Spuren[] Array
  • Ein Array von Gleisobjekten
  • Die Elemente dieses Arrays werden fast direkt in übersetzt Spurelemente
  • Siehe die Untertitel zu Videos hinzufügen Dokument für ein Beispiel für die Verwendung von Spuren mit Brightcove Player.
verfolgen Objekt
  • Ein Verfolgungsobjekt zwei erforderliche Eigenschaften: src & srclang und eine optionale Eigenschaft Etikette)
Tracks []. Label stark
  • Etwas Optional Text, der die srclang und die Beschriftung
Tracks []. src stark
  • Eine URL, die auf eine zu ladende VTT-Datei verweist
Tracks []. srclang stark
  • Der aus zwei Buchstaben bestehende Code für den Sprachtyp der Beschriftung, wie in angegeben BCP47
Breite String
  • Die Breite des Videos
  • Der Standardwert bezieht sich auf die Höhe und ist für ein Video mit einem Seitenverhältnis von 2:1 geeignet

Beispiele

Ein Beispiel aus einer Hand:

"media": {
  "height": "300px",
  "poster": {
    "highres": "//path/to/poster.jpg"
  },
  "src": "//path/to/some/media-file.mp4",
  "width": "600px"
}

Beispiel für mehrere Quellen:

"media": {
  "height": "300px",
  "poster": {
    "highres": "//path/to/poster.jpg"
  },
  "sources": [{
    "src": "//path/to/some/media-file.mp4",
    "type": "video/mp4"
  }, {
    "src": "//path/to/some/media-file.webm",
    "type": "video/webm"
  }],
  "width": "600px"
}

Beispiel für mehrere Medienobjekte:

"media": [{
  "height": "300px",
  "src": "//path/to/some/media-file.mp4",
  "width": "600px"
}, {
  "height": "300px",
  "sources": [{
    "src": "//path/to/some/media-file.mp4",
    "type": "video/mp4"
  }, {
    "src": "//path/to/some/media-file.webm",
    "type": "video/webm"
  }],
  "width": "600px"
}]

Weitere Informationen darüber, welche Quelle tatsächlich abgespielt wird, finden Sie in der Bestimmen, welche Wiedergabe abgespielt wird Dokument.

Sie können sehen, welche Quelle abgespielt wird, indem Sie die currentSrc() Funktion. Der folgende Screenshot zeigt die Verwendung der Funktion in einer Browserkonsole.

Stromquelle
Stromquelle

Medienobjekt mit Titeln Beispiel:

"media": {
  "height": "300px",
  "poster": {
    "highres": "//path/to/poster.jpg"
  },
  "sources": [{
    "src": "//path/to/some/media-file.mp4",
    "type": "video/mp4"
  }, {
    "src": "//path/to/some/media-file.webm",
    "type": "video/webm"
  }],
  "tracks": [{
    "src": "//path/to/captions.vtt",
    "srclang": "en",
    "label": "English"
  }],
  "width": "600px"
}

Im folgenden JSON sehen Sie a media Eigenschaft mit:

  • EIN poster.highres Eigentum
  • EIN Quellen Eigenschaft, die zwei Quellobjekte enthält, eines für ein HLS-Video und eines für ein MP4-Video
  "media": {
    "poster": {
      "highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
    },
    "sources": [{
      "type": "application/x-mpegURL",
      "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
    }, {
      "type": "video/mp4",
      "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
    }]
  },

gedämpft

muted information:

  • Datentyp: boolescher Wert
  • Standard: falsch
  • Bestimmt, ob der Ton beim Laden des Players stummgeschaltet wird.

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
gedämpft HTML-Attribut in-Seite Dies ist nur ein boolesches Attribut. Alle Werte gelten als wahr.
gedämpft Parameter abfragen iframe Überschreibt die Konfiguration
gedämpft Spieler-Option in-Seite Überschreibt die Konfiguration

picture_in_picture_control

picture_in_picture_control information:

  • Datentyp: boolescher Wert
  • Standardwert: true
  • Gibt an, ob die integrierte Bild-in-Bild-Steuerung in der Steuerleiste angezeigt werden soll.

play_button

play_button information:

  • Datentyp: object
  • Standard: undefined
  • Fügt CSS-Klassen für benutzerdefinierte Player-Schaltflächenstile hinzu, nur Brightcove Player-Versionen 5+

Objekteigenschaften:

Eigentum Typ Effekt
schweben String glühen oder verdunkeln Standard ist Rosa /. Fortschritt Farbe
gestalten String Quadrat oder Rechteck Standard ist a Kreis
Position String oben links oder oben rechts Standard ist Center

Abspielraten

playback_rates information:

  • Datentyp: Array
  • Standard: Keine
  • Array von Wiedergaberaten, die in der Wiedergaberatensteuerung angezeigt werden sollen.

Die Werte werden gelesen und dann in einer Wiedergabegeschwindigkeitssteuerung in der Steuerleiste des Players dargestellt.

Wiedergaberaten ui

Sie können entweder Studio oder curl verwenden, um den Wert der Eigenschaft zu ändern:

Wiedergaberaten json editor
  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
        "playback_rates": [0.1,1,2.5,6]
       }' \
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

Spieler

player information:

  • Datentyp: Objekt
  • Standard: Mit spielerspezifischen Informationen füllen
  • Enthält verschiedene Metadaten zu diesem Player, die in der folgenden Tabelle am relevantesten sind.
Eigentum Typ Effekt
inaktiv boolescher Wert Wann wahr wird der Player als graues Feld mit einer Fehlermeldung angezeigt, die besagt, dass der Inhaltseigentümer den Player deaktiviert hat. Siehe die inaktive Details Inhalt unter dieser Tabelle für weitere Informationen.
Vorlage.Version String Die Versionsnummer der Vorlage, aus der der Player erstellt wird. Sie können die Player-Version manuell einstellen, indem Sie die SPIELER Modul JSON-Editor.
Version
in_page_embed_url String Basis-URL für die Einbettung in eine Seite

inaktive Details

Es ist möglich, Spieler inaktiv zu machen. Möglicherweise möchten Sie dies tun, damit ein Player keine Inhalte mehr bereitstellt, aber kein 404-Fehler angezeigt wird, wenn ein gelöschter Player durchsucht wird.

Um einen Player zu deaktivieren, stellen Sie die player Feld's inactive Eigentum an true , wie folgt:

            curl \
            --header "Content-Type: application/json" \
            --user $EMAIL \
            --request PATCH \
            --data '{
              "player": {
                  "inactive": true
              }
            }' \
            https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

Wenn Sie den Player aktivieren möchten, können Sie natürlich die inactive Eigentum an false.

Sobald der Player deaktiviert ist und ein Benutzer den Player durchsucht, wird die folgende Meldung angezeigt:

Deaktivierter Spieler
Deaktivierter Spieler

Spieler-ID

player_id information:

  • Datentyp: string
  • Die einem Player zugeordnete Video Cloud-Player-ID

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
Daten-Player HTML-Attribut in-Seite Wird hauptsächlich verwendet, um Spieler zur Init-Zeit zu identifizieren. Kann das nicht überschreiben player_id in der Konfiguration gefunden

Spielername

player_name information:

  • Datentyp: string
  • Der Name eines Video Cloud-Players, der einem Player zugeordnet ist

Playsinline

playsinline information:

  • Datentyp: boolescher Wert
  • Standard: falsch
  • Legt fest, ob der Player die Inline-Wiedergabe auf Plattformen zulassen soll, die ein spieltinline Attribut für Inline-/Nicht-Native-Player-Wiedergabe (zB iOS).

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
Playsinline HTML-Attribut in-Seite Dies ist nur ein boolesches Attribut. Alle Werte gelten als wahr.
Playsinline Parameter abfragen iframe Überschreibt die Konfiguration
Playsinline Spieler-Option in-Seite Überschreibt die Konfiguration

Plugins

Die plugins array gibt die Reihenfolge zum Initialisieren von video.js-Plugins und alle benutzerdefinierten Einstellungen an, die auf sie angewendet werden. Das Plugin muss von einem entsprechenden scripts Eigenschafts-URL-Eintrag und bei Bedarf ein unterstützendes stylesheets URL. Jedes Element der plugins Array ist ein Objekt mit a name Eigentum.

Eigentum Typ Effekt
Name String Der Methodenname des Plugins
Optionen Objekt Ein Optionsobjekt, das an die Methode des Plugins übergeben wird
Skripte Array Skripte für dieses Plugin
Stylesheets Array Stylesheets für dieses Plugin

Wenn Ihre Plugins-Eigenschaft beispielsweise wie folgt aussieht:

"plugins": [{
  "name": "foo",
  "options": {
    "bar": true
  }
}]

Zur Laufzeit wird die foo Plugin würde mit den mitgelieferten Optionen initialisiert:

player.foo({bar: true});

Alle Skripte oder Stylesheets, die in einem Plugin-Objekt enthalten sind, werden auf die gleiche Weise eingefügt wie Skripte oder Stylesheets der obersten Ebene; sie werden vor den Assets der obersten Ebene eingefügt.

Optionen Details der Immobilie

In diesem options Child-Eigenschaft übergeben, übergeben Sie Daten, die bei der Initialisierung verwendet werden sollen. Der folgende JSON übergibt ein einzelnes Objekt im options.

  "plugins": [{
    "name": "navigateOnVideoEnd",
    "options" : {"redirectURL": "http://docs.brightcove.com"}
  }]

Dies gibt Ihnen die Möglichkeit, Daten über die Player-Konfiguration an ein Plugin zu übergeben. Um beispielsweise das oben gezeigte redirectURL Objekt zu verwenden, würden Sie im Plugin selbst Folgendes tun:

  videojs.registerPlugin('navigateOnVideoEnd', function (options) {
    var myPlayer = this;
    myPlayer.on("ended", function () {
      window.location.href = options.redirectURL;
    });
  });

Hinweis: Sie verwenden die Standard-Plugin-Implementierung, verwenden aber options als Parameter in der anonymen Funktion. Sie können dann mit options.propertyName Notation auf den Wert zugreifen.

Einige von Brightcove bereitgestellte Plugins verwenden die Plugin-Registrierung und die Konfiguration unterscheidet sich von der hier gezeigten. Siehe die Überblick: Plugin-Registrierung Dokument für detaillierte Informationen.

vorladen

preload information:

  • Datentyp: string
  • Standard: none
  • Das preload-Attribut informiert den Browser darüber, ob die Videodaten heruntergeladen werden sollen oder nicht, sobald das Video-Tag geladen wird. Die Optionen sind auto, Metadaten und keine.

Optionsdetails

  • Auto: Zeigt an, dass die gesamte Videodatei heruntergeladen werden kann, auch wenn der Benutzer das Video schließlich nicht ansieht. Positiv ist, dass wenn der Zuschauer das Video abspielt, es sofort mit der Wiedergabe beginnen kann. Auf der negativen Seite erhöht diese Option den Bandbreitenverbrauch, da das Vorladen/Laden auch dann erfolgt, wenn der Zuschauer das Video nicht abspielt.

  • Metadaten (Ursprünglich): Laden Sie die Metadaten des Videos, die Informationen wie Dauer und Abmessungen des Videos enthalten. Diese Einstellung lädt auch mehrere Sekunden Videodaten.

  • keine: Laden Sie keine der Videodaten vorab. Dies wird warten, bis der Benutzer auf Play klickt, um mit dem Herunterladen zu beginnen.

Andere Möglichkeiten, den Wert festzulegen:

Nennen Typ Typ (en) einbetten Verhalten
vorladen HTML-Attribut in-Seite Überschreibt die Konfiguration
vorladen Parameter abfragen iframe Überschreibt die Konfiguration
vorladen Spieler-Option iframe Überschreibt Konfiguration und Attribut oder Abfrageparameter
  <video-js preload ...>
  or
  { "preload": "auto" }

query_string_to_window

query_string_to_window information:

Wird verwendet, um die Auffüllung des globalen Namespace (Fensters) anhand von Abfragezeichenfolgenparametern zu steuern. Dies ist insbesondere bei eingebetteten Playern wie den AMP-Komponenten von Google oder Facebook Instant Articles sinnvoll. Das Parsen von Abfragezeichenfolgen erfolgt mit dem Node.js-Abfragestring-Modul. Die Verwendung dieses Konfigurationsobjekts erfordert mindestens eine der folgenden Untereigenschaften. Beide können gleichzeitig verwendet werden.
    • Name: query_string_to_window.target
    • Datentyp: string
    • Beschreibung: Ein im Fenster zu erstellendes Zielobjekt, das mit der gesamten geparsten Abfragezeichenfolge gefüllt wird. Zum Beispiel eine Verwendung von query_string_to_window.target Folgendes in einer Player-Konfiguration gegeben:
        {
        "query_string_to_window": {"target": "queryStringParams"}
        }
      und gegeben die folgende Abfragezeichenfolge:
        ?foo=bar&nums=1&nums=2
      würde folgendes ergeben window.queryStringParams globales Objekt wäre für den Player und die Plugins verfügbar:
        {
        foo: 'bar',
        nums: ['1', '2']
        }
    • Name: query_string_to_window.globals
    • Datentyp: Array
    • Beschreibung: Ein Array von Eigenschaftsnamen des Fensterobjekts, das aus Werten gefüllt wird, die in der Abfragezeichenfolge gefunden werden. Alle übereinstimmenden Eigenschaften, die bereits auf dem . vorhanden sind window Objekt oder seine Prototypkette wird nicht gesetzt. Zum Beispiel eine Verwendung von query_string_to_window.globals Folgendes in einer Player-Konfiguration gegeben:
        {
        "query_string_to_window": {
          "globals": [
            "foo",
            "nums",
            "self"
          ]
        }
        }
      und geben Sie den folgenden Abfragestring ein:
        ?foo=bar&nums=1&nums=2&self=not-allowed
      würde folgendes ergeben window globales Objekt mit den folgenden hinzugefügten Eigenschaften:
        window.foo; // 'bar'
        window.nums; // ['1', '2']
        
        // Because `self` already exists on the `window` object, it will not be set
        // and a warning will be logged to the browser console.
        window.self; // window

wiederholen

repeat information:

  • Datentyp ist boolean
  • Führt dazu, dass eine Playlist wiederholt abgespielt wird, WENN der Player ein Playlist-Player ist. Das heißt, wenn die Wiedergabeliste Eigentum verwendet wird.
  • Auf der obersten Ebene der Player-Konfiguration einstellen.

Skripte

scripts information:

  • Der Datentyp ist ein Array von Strings, die auf JavaScript-Dateien verweisen, die im Player enthalten sind
  • Kein Standardwert
  • Zum Zeitpunkt der Erstellung des Players werden diese Dateien heruntergeladen und in die resultierende Ausgabe eingefügt, sodass sie nicht später zur Laufzeit abgerufen werden müssen
  • Skripte werden in der Reihenfolge eingefügt, in der sie im angegeben sind Skripte Array:
    "scripts": [
      "https://example.com/script.js",
      "https://example.com/depends-on-script.js"
    ]
  • Da Skripte in einer bestimmten Reihenfolge eingefügt werden, können Sie Skripte, die voneinander abhängen, sicher einschließen

Haut

skin information:

  • Datentyp: boolean oder string
  • Standardwert: undefined
  • Bestimmt die visuelle Stilvariante, die der Player verwendet. Dieser Wert spiegelt sich auch in den weltweit zugänglichen bc.SKIN Eigenschaft im Browser. Es erkennt folgende Werte:
    Wert bc.SKIN Beschreibung
    "graphite" "graphite" Verwendet den alten Brightcove Player-Stil sowie einige Kompatibilitäts-Hacks.
    falsch "none" Deaktiviert alle Brightcove Player-Stile. Dies ist die Option, die Sie von Grund auf für eine stark angepasste Benutzeroberfläche verwenden können.
    undefiniert "luna" Das verlassen undefined bewirkt, dass der Spieler den Standard-Skin (auch bekannt als Luna).
    "Saphir" "Saphir" Standard-Skin bei der Verwendung von Video Cloud Studio zum Erstellen von Playern, aber nicht der Standard für den Player selbst.

Stylesheets

stylesheets information:

  • Ein Array von URL-Strings, die auf CSS-Dateien verweisen, die im Player enthalten sein sollten
  • Beim Erstellen des Players werden die zusätzlichen Stylesheets heruntergeladen und in den Player eingefügt, sodass sie nicht zur Laufzeit abgerufen werden müssen
  • Stylesheets sind in der Reihenfolge enthalten, in der Sie sie im angeben Stylesheets Array:
    "stylesheets": [
      "https://example.com/layout.css",
      "https://example.com/skin.css"
    ]

suppress_not_supported_error

suppress_not_supported_error information:

  • Datentyp: boolescher Wert
  • Standardwert: undefined
  • Wenn wahr , wird ein anfänglicher Fehler, dass eine Quelle nicht wiedergegeben werden kann, bis zur ersten Benutzerinteraktion verschoben. Nützlich, um Fehler vor Browsern zu verbergen, die kein Video abspielen können, z. B. Googlebot.

tech_order (oder techOrder)

tech_order information:

  • Datentyp: Array
  • Standard: ['html5','flash']
  • Standardmäßig führt Brightcove Player Technik zuerst Sortieren, wenn nach einer Quelle/Technologie-Kombination zum Abspielen von Videos gesucht wird. Das bedeutet, wenn Sie zwei Quellen und zwei Techniker haben, versucht der Player, jedes Video mit der ersten Technik im . abzuspielen tech_order option-Eigenschaft, bevor Sie fortfahren, um die nächste Wiedergabetechnologie auszuprobieren. Siehe die Handbuch: Wiedergabetechnologie Dokument für weitere Informationen.

Sie können die folgende curl-Anweisung verwenden, um die tech_order von der Standardeinstellung von ['html5','flash'] zu ['flash','html5']:

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
        "tech_order": "['flash','html']"
       }' \
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

Eine andere Möglichkeit, den Wert einzustellen:

Nennen Typ Typ (en) einbetten Verhalten
tech_order Spieler-Option in-Seite Überschreibt die Konfiguration

umd

umd (Universal Module Definition) information:

  • Datentyp: boolescher Wert
  • Standardwert: true
  • Nur verfügbar in Brightcove Player 6.53.0 und höher
  • Wann wahr , fügt dem Player eine UMD-Boilerplate (Universal Module Definition) für die Verwendung mit Modulsystemen wie RequireJS hinzu. Wenn explizit auf gesetzt falsch , funktioniert der Player nicht mit Modulladern und macht einfach die globale Variable bc verfügbar.

video_cloud

  • Datentyp: object
  • Standard: undefined
  • Konfiguriert diesen Player für die Interaktion mit Video Cloud

Ein Beispiel für die Verwendung des Objekts ist das Erstellen eines Players mithilfe eines Videos aus Ihrer Video Cloud-Bibliothek. Die folgende curl-Anweisung zeigt die Player-Erstellung mit der ID eines Video Cloud-Videos.

curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request POST \
--data '{
    "name": "Video Cloud CURL 10 March",
    "configuration": {
      "video_cloud": {
        "video": "4093372393001"
      }
    }
  }' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players

Beachten Sie, dass im Anfragetextobjekt name und description sind Eigenschaften der obersten Ebene, und alle anderen sind Eigenschaften der configuration Objekt. Irgendeiner von Konfigurationseigenschaften kann in die aufgenommen werden configuration wenn Sie den Player erstellen.

Die folgende Tabelle zeigt die in der video_cloud Objekt.

Eigentum Effekt
allow_playready_in_chromium_edge Steuern Sie die Auswahl der DRM-Quelle auf Chromium Edge.
  • Wenn wahr Entfernen Sie keine PlayReady-Quellen oder Schlüsselsysteme.
  • Wenn falsch Entfernen Sie in jedem Fall PlayReady-Quellen und Schlüsselsysteme.
  • Wenn nicht definiert Entfernen Sie PlayReady-Quellen und Schlüsselsysteme nur für EPA-Quellen!
base_url Einstellen der base_url ist eine Konfigurationsänderung, die NUR geändert werden sollte, wenn IP-Einschränkungen bei Brightcove-Playern außerhalb Nordamerikas verwendet werden. Siehe die base_url Details Inhalt unter dieser Tabelle für weitere Informationen.
intervall_wiederholung Für Generic Stream Concurrency das Intervall in Millisekunden zwischen den Wiederholungsversuchen, wenn der Player keine Verbindung zum Server herstellen kann.
max_wiederholung Für Generic Stream Concurrency die Anzahl der Versuche des Players, eine Verbindung zum Server herzustellen, um die Gleichzeitigkeitsgrenzen zu überprüfen.
Wiedergabeliste Eine zu ladende Video Cloud-Wiedergabelisten-ID. Siehe die Details zur Wiedergabeliste Inhalt unter dieser Tabelle für weitere Informationen.
policy_key Ein Richtlinienschlüssel für die Video Cloud-API. Siehe die Richtlinienschlüssel Dokument für weitere Informationen.
source_selection_rules Ein Objekt, das Regeln enthält, um das Filtern und Sortieren des Quellenarrays zu steuern, das in der Playback-API-Antwort zurückgegeben wird. Das Ergebnis der Anwendung dieser Regeln bestimmt, welche Quelle an Video.js übergeben wird.
Video Eine Video Cloud-Video-ID zum Laden. Ein Beispiel finden Sie im Curl-Beispiel oben in diesem Abschnitt.

base_url Einzelheiten

Bei der Verwendung von IP-Beschränkungen mit Brightcove-Playern, die außerhalb von Nordamerika verwendet werden, können Probleme auftreten. Wenn ein Brightcove-Player aufgefordert wird, ein Video von einem Video Cloud-Konto zu laden, stellt er unter dieser Adresse eine Verbindung zum Katalog herhttps://edge.api.brightcove.com/playback/v1/.

Dieser Edge-Endpunkt verhält sich so, dass Probleme bei der IP-Einschränkung auftreten können:

  • Wenn Edge von INNERHALB Nordamerikas aus aufgerufen wird, trifft es Edge direkt und Edge sieht die IP-Adresse des Benutzers. Es kann den Zugriff auf den Katalog gemäß der Whitelist für die IP-Einschränkung entweder zulassen oder verweigern. Dies ist die gewünschte Funktionalität.
  • Wenn Edge von AUSSERHALB Nordamerikas aufgerufen wird, erfolgt dies aus Gründen des Load-Balancing/des lokalen Caching von CDN über Cloudfront. Das ist wichtig, denn dadurch sieht Edge die Cloudfront-IP anstelle der IP des Benutzers und verweigert jeden, weil Cloudfront nicht auf der Whitelist steht (und sollte es auch nie sein, denn dann hätte jeder, der Cloudfront verwendet, Zugriff).

Um dieses Problem zu beheben, können Sie den Player so konfigurieren, dass er einen alternativen Edge-Endpunkt verwendet. edge-elb.api.brightcove.com. Diese Änderung muss für jeden Spieler vorgenommen werden, der von außerhalb Nordamerikas auf das IP-beschränkte Konto zugreifen muss.

Die eigentliche Konfigurationsänderung beinhaltet das Festlegen eines Werts für die Video Cloud base_url. Denken Sie daran, dass dies NUR geändert werden sollte, wenn IP-Beschränkungen mit Brightcove-Playern außerhalb von Nordamerika verwendet werden. Für einen vorhandenen Player würden Sie den folgenden curl-Befehl verwenden, der die verwendet PATCH HTTP-Methode (Sie müssen Ihre Daten durch die Umgebungsvariablen ersetzen $EMAIL , $ACCOUNT_ID und $PLAYER_ID):

curl
  --header "Content-Type: application/json"
  --user $EMAIL
  --request PATCH
  --data '{
      "video_cloud": {
        "base_url": "https://edge-elb.api.brightcove.com/playback/v1/"
      }
    }'
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

Details zur Wiedergabeliste

Es gibt jetzt zwei verschiedene Playlist-Implementierungen, die im Verwenden von Wiedergabelisten dokumentieren. Die Standardeinstellung ist Version 3. Informationen zur Konfiguration beider Versionen finden Sie hier.

Beide Konfigurationen zeigen, wie Sie Folgendes einstellen:

  • autoadvance: Zugeordnete Ganzzahl in Sekunden, um das Laden des nächsten Videos in der Wiedergabeliste zu verzögern; Wert von 0 zugewiesen verursacht keine Wartezeit zwischen den Videos; Wert von null zugewiesen wird, wird kein automatischer Vorlauf verursacht.
  • playOnSelect: Zugewiesen true Wenn Sie also auf ein Element im Wiedergabelistenmenü klicken, wird das Video beim Laden abgespielt, auch wenn das vorherige Video im Player angehalten wurde.

Playlist-Version 3 (Standard)

Um Wiedergabelisten mit dem Plugin der Version 3 zu konfigurieren, verwenden Sie die Plugin-Registrierung. Hier ist eine curl-Anweisung, um die Verwendung des Playlist Version 3-Plugins zu konfigurieren:

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request POST \
    --data '{
        "name": "Plugin Registry Test Player",
        "configuration": {
          "video_cloud": {
            "video": "4093372393001"
          },
          "plugins": [
            {
              "registry_id": "@brightcove/videojs-bc-playlist-ui",
              "version": "3.x"
            }
          ]
        }
    }' \
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players

Siehe die Plugin-Registrierung Dokument für Informationen über seine Verwendung und Vorteile.

Um die einzustellen playOnSelect und autoadvance Optionen beim Erstellen des Players verwenden die folgenden:

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request POST \
    --data '{
        "name": "Plugin Registry Test Player",
        "configuration": {
          "video_cloud": {
            "video": "4093372393001"
          },
          "plugins": [
            {
              "registry_id": "@brightcove/videojs-bc-playlist-ui",
              "version": "3.x",
              "options": {
                "playOnSelect": true
              }
            }
          ],
          "autoadvance": 2
        }
    }' \
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players

Playlist-Version 1 (Legacy)

Zusätzlich zu autoadvance und playOnSelect zwei weitere Eigenschaften, die verwendet werden, um die Verwendung von Playlists Version 1 zu konfigurieren. Sie sind:

  • playlist: Zugewiesen true damit ein Spieler Wiedergabelisten verwendet.
  • adjusted: Zugewiesen true damit der Player die Player-Dimensionen für die Playlist anpasst.

Hier ist eine curl-Anweisung, um drei der Playlist-bezogenen Eigenschaften festzulegen:

  curl \
  --header "Content-Type: application/json" \
  --user $EMAIL \
  --request PATCH \
  --data '{
    "playlist": true,
    "autoadvance": 2,
    "studio_configuration": {
      "player": {
        "adjusted": true,
        "height": "",
        "width": ""
      }
    }
  }' \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

Einstellen playOnSelect Verwenden Sie für Playlists Version 1 die folgende curl-Anweisung:

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
         {"playOnSelect": true}
    }' \
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

Programmgesteuert feststellen, ob der Player eine Playlist enthält

Wenn Sie JavaScript auf einer Seite verwenden, die einen Player enthält, und überprüfen möchten, ob ein Playlist-Plugin verwendet wird, können Sie Folgendes verwenden:

  player.hasPlugin('playlist')

Wenn Sie prüfen, ob ein Playlist-Plugin vorhanden ist und nicht auf einer Seite mit einem Player (z. B. wenn Sie eine Liste von Playern für die Verwendung mit einem Connector überprüfen), müssen Sie einen etwas komplizierteren Prozess verwenden. Sie würden die Konfiguration des Players lesen und dann prüfen, ob die Plugins Abschnitt der JSON des Players enthält "name": "bcPlaylistUi". Eine Lösung für diese Aufgabe folgt:

  var theJSON = {},
    pluginAra = [],
    ifFound = [],
    theJSONString =
    '{"account_id":"1507807800001","autoadvance":0,"autoplay":false,"embed_id":"default","fullscreenControl":true,"id":"r1fbqySRZ","player":{"inactive":false,"template":{"locked":false,"name":"single-video-template","version":"6.8.3","version_alias":null}},"player_id":"r1fbqySRZ","player_name":"playlist v2 junk","playlist":true,"plugins":[{"injected_version":"2.1.2","name":"bcPlaylistUi","options":{"playOnSelect":true},"registry_id":"@brightcove/videojs-bc-playlist-ui","version":"2.x"}],"preload":"metadata","scripts":["//players.brightcove.net/videojs-bc-playlist-ui/2.1.2/videojs-bc-playlist-ui.min.js"],"studio_configuration":{"player":{"adjusted":true,"height":150,"width":300}},"stylesheets":["//players.brightcove.net/videojs-bc-playlist-ui/2.1.2/videojs-bc-playlist-ui.css"],"updated_at":"2017-10-30T18:06:07.800Z","video_cloud":{"policy_key":"BCpkADawqM2_X3Xxh3xln23EqlR3BETHrfycIPT-a7kqhBi6q8g3XOmTr3tEJiFoi_YmI7vfbJzS4mY0Un5RACc3jC8cLVqyvmfWFLI-tG5oJYGXNUrvOwRJYQEt2eVpMZnBd0FH22i7Mtk3","video":null}}';
  
  theJSON = JSON.parse(theJSONString);
  pluginAra = theJSON.plugins;
  ifFound = pluginAra.filter(function(pluginAra) {
    return pluginAra.name === "bcPlaylistUi"
  });
  if (ifFound.length === 1) {
    console.log('Contains playlist plugin');
  } else {
    console.log('No playlist');
  }

source_selection_rules Einzelheiten

  • Datentyp: object
  • Diese Eigenschaft, die Regeln enthält, die entscheiden, welche Quelle gespielt wird, enthält selbst eine Eigenschaft bevorzugt_mp4.
  • Nur verfügbar in Brightcove Player 6.55.0 und höher.

Die bevorzugt_mp4 -Eigenschaft kann einen booleschen Wert oder ein Array enthalten. Die Eigenschaft wird verwendet, um das Quellenarray auf nur MP4-Quellen zu filtern. Mit anderen Worten, dies entfernt HLS- oder DASH-Streaming-Medien aus dem Quellen-Array. Die Verwendung dieser Konfiguration ist ziemlich ungewöhnlich, da Streaming-Medien in den meisten Fällen eine bessere Benutzererfahrung bieten, aber es gibt gültige Fälle, in denen Publisher möchten, dass einige Player nur MP4s abspielen. In diesen Fällen ist ein benutzerdefiniertes Aufnahmeprofil im Allgemeinen der bevorzugte Ansatz, ist jedoch möglicherweise nicht immer machbar. Wenn ein Publisher beispielsweise Videos hat, die er einmal aufnehmen möchte, aber möglicherweise in unterschiedlichen Kontexten abgespielt wird, kann diese Konfiguration hilfreich sein. Wann

"prefer_mp4": true
verwendet wird, werden alle Nicht-MP4-Medienquellen aus dem Quellen-Array herausgefiltert, bevor sie an den Player übergeben werden, als ob sie nie von der Wiedergabe-API zurückgegeben worden wären.

Herausgeber können auch die Sortierung dieser gefilterten Liste von Quellen steuern, indem sie ein Array bereitstellen. Dies unterstützt nur numerische Eigenschaften (wie Größe, Höhe, Breite usw.), die von der Playback-API zurückgegeben werden. In diesem Fall sollte das erste Element des Arrays die Eigenschaft sein, nach der sortiert werden soll, und das zweite optionale Element sollte die Sortierrichtung sein, entweder "auf" oder "abs". Der Standardwert ist "abs". Um beispielsweise Nicht-MP4-Medienquellen herauszufiltern und sie nach Größe vom kleinsten zum größten zu sortieren, würden Sie Folgendes verwenden:

"video_cloud": {
  "source_selection_rules": {
    "prefer_mp4": ["size", "asc"]
  }
}

volume_orientation

volume_orientation information:

  • Datentyp: string
  • Standard: horizontal
  • Nur verfügbar in Brightcove Player 6.32.0 und höher
  • Die volume_orientation -Eigenschaft bestimmt, ob der Lautstärkeregler horizontal oder vertikal ausgerichtet ist.
    Volumen horizontal
    Volumen vertikal

Gültige Werte sind:

Wert Beschreibung
"vertical" Zeigt den vertikalen Lautstärkebereich an (dies entspricht der Übergabe des Optionsobjekts mit controlBar.volumePanel.inline=false und controlBar.volumePanel.vertical=true zu bc() Methode oder Daten-Setup Attribut).
"horizontal" Anzeige des horizontalen Lautstärkereglers (Standardrichtung des Lautstärkereglers in den Skins Graphit, Luna und Saphir)
undefiniert Wenn Sie diesen Wert nicht definieren, wird die Lautstärkeregelung horizontal angezeigt (Standardrichtung der Lautstärkeregelung in den Skins Graphit, Luna und Saphir)

Sie können entweder Studio oder curl verwenden, um den Wert der Eigenschaft zu ändern:

Lautstärke ausrichten
  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
        "volume_orientation": "vertical"
       }' \
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

vttjs

vttjs information:

  • Datentyp: string
  • Standard: vjs.zencdn.net CDN
  • Dies entspricht der Standardoption Video.js vtt.js. Der Brightcove Player verwendet vttjs stattdessen ist ein gepunkteter Eigenschaftsname in der Player Management API nicht möglich und kann an anderer Stelle problematisch sein.
  • Kann als eingestellt werden Daten-vttjs Attribut, a vttjs iframe-Abfrageparameter, a vttjs Setup-Option oder vttjs in der Player-Konfiguration.

wait_for_ad_block_detect

wait_for_ad_block_detect information:

  • Datentyp: boolescher Wert
  • Standardwert: undefined
  • Bei Einstellung auf true , verzögert der Player seinen automatischen Initialisierungsvorgang, bis die Adblock-Erkennung eine Entscheidung getroffen hat. Dies kann die Initialisierung des Spielers um bis zu 100 Millisekunden verzögern. Dies muss nicht eingestellt werden auf true beim Benutzen ad_failover da das verzögernde Verhalten in beiden Fällen auftritt.