Support Kontakt Support | Systemstatus Systemstatus

Player Konfigurationsanleitung

In diesem Thema wird beschrieben, wie Sie das anzeigen und ändern player Aufbau. Die JSON-Syntax ist ebenfalls dokumentiert.

Einführung

Die Eigenschaften, die Sie in festlegen können player Die Konfiguration wird unten detailliert beschrieben (und in der linken Navigation aufgeführt), beginnend mit Konto_ID. In diesem Dokument finden Sie außerdem Informationen zum Anzeigen und Konfigurieren von Eigenschaftswerten.

Konfiguration anzeigen

Es gibt zahlreiche Möglichkeiten, das anzuzeigen playerKonfiguration in diesem Abschnitt.

Verwenden von Studio

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

  1. Öffnen Sie die PLAYERS Modul und suchen Sie die player von denen Sie die Konfiguration anzeigen möchten.
  2. Klicken Sie auf den Link für das player öffnen playerEigenschaften.
  3. Eine detaillierte JSON-Editor im linken Navigationsmenü.
  4. Sie können das anzeigen playerKonfiguration ähnlich der folgenden:
    JSON-Editor

Durchsuchen mit config.json

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

Eine Möglichkeit, die player Die Konfiguration erfolgt durch Ändern der playerDie URL von endet mit index.html zu config.json. Zum Beispiel:

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

Einige der Eigenschaften in der player Konfiguration definieren Sie Folgendes:

  • Der Name und die Version des player
  • Die Videos der player wird wiedergegeben
  • Das Konto, auf das die player gehört
  • Unser playerID
  • Alle Plugins die player kann verwendet werden, sowie die URLs für die Speicherorte des Plugin-Codes
  • Ein Poster, das vor der Videowiedergabe angezeigt werden soll

Ein Beispiel player Konfigurationsdatei für a player von der Schritt für Schritt: Player Management ist 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": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT"
        },
        "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 mit $PLAYER_ID/configuration Endpunkt

Sie können die gleichen Informationen abrufen, die gerade mit HTTP angezeigt werden GET Methode. Verwenden GET mit dem /$PLAYER_ID/configuration Endpunkt, den Sie abrufen können veröffentlicht player's Konfigurationsinformationen. Ein Beispiel für eine curl-Anweisung, und der JSON-Abruf 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": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT"
        },
        "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 mit der verwendet /$PLAYER_ID Endpunkt ist der Weg, um vollständig abzurufen player Information. Dieser Ansatz ergibt eine Obermenge von player Konfiguration, die Sie gerade gesehen haben. Sie können sich vorstellen, dass dieser Endpunkt Ihre Konfigurationsinformationen "eine Ebene höher" anzeigt und aktuelle Konfigurationsinformationen sowohl für die Vorschau als auch für die Veröffentlichung enthält player Versionen. Eine beispielhafte Curl-Anweisung und der abgerufene JSON werden 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": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT",
                "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": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT"
              },
              "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-sni6Tc0sFppBHaE91MRyLjE8kUwQjOkXjmK-b2R9fN3IuOnRf_4uuV2LSFwT3eeKUxgYU75eT0c20JEnUKpKU6L-oyjn81zE_P1NF0HJBZiyXyqtHcAdvTpTb29d4S-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-sni6Tc0sFppBHaE91MRyLjE8kUwQjOkXjmK-b2R9fN3IuOnRf_4uuV2LSFwT3eeKUxgYU75eT0c20JEnUKpKU6L-oyjn81zE_P1NF0HJBZiyXyqtHcAdvTpTb29d4S-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 das zu ändern player Konfiguration 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 Option ändern /$ACCOUNT_ID/players/$PLAYER_ID Endpunkt. Diese beiden Eigenschaften sind name und description.

Beachten Sie das name Sie geben für die player wird zurückgegeben als player_name wenn Sie die Konfiguration durch setzen bekommen config.json am Ende des player Vorschau-URL (wird zurückgegeben als name wenn Sie die Konfiguration über die Player Management API. Aber du musst verwenden name wenn Sie die erstellen oder aktualisieren player.

Der erste Codeblock zeigt eine beispielhafte Curl-Anweisung, die a ändert player's name und description. Beachten Sie, dass in der JSON-Antwort Vorschauversionen von angezeigt werden player werden von der PATCH-Methode generiert, daher müssen Sie die veröffentlichen player 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 webkitallowfullscreen mozallowfullscreen></iframe>"
    }

Einstellwerte

Sie können das Set player Konfigurationswerte mit einem beliebigen Tool, das HTTP-Methodenaufrufe ausgibt, ODER mit dem JSON-Editor das ist Teil von Studio PLAYERS Modul. Das Curl-Tool kann verwendet werden, und Beispielanweisungen werden in angezeigt Schritt für Schritt: Player Verwaltung und AJAX Verwendung in vielen der erklärt Brightcove Player Beispiele.

Eine Beispieländerung mit der JSON-Editor wird hier gezeigt:

JSON-Editor Nr Brightcove Player Branding

Stellen Sie sicher, dass Sie Ihre Änderungen nach dem Bearbeiten der speichern playerJSON-Konfiguration.

Konfigurieren von Eigenschaften

Einige Konfigurationseigenschaften werden von der festgelegt Player Management Service und sind nicht veränderbar. Jene sind:

  • Konto_ID
  • player_id
  • eingebettete_id

Alle anderen unten aufgeführten Eigenschaften sind modifizierbar.

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

Konto_ID

Unser Video Cloud Konto-ID, die dem zugeordnet ist player. Dieser Wert kann nicht geändert werden.

ad_config_id

ad_config_id Informationen:

  • Datentyp: Zeichenfolge
  • Standard: undefined
  • Eine Konfigurations-ID für die Dynamic Delivery SSAI-Anzeige. Zusätzlich zur Einstellung auf der player Konfiguration kann es zur Laufzeit über den Abfragezeichenfolgenparameter adConfigId für iframe festgelegt werden players oder das Attribut data-ad-config-id für In-Page players. Beides überschreibt jeden Wert in der player Konfiguration.

ad_failover

ad_failover Informationen:

  • Datentyp: Boolesch
  • Standard: undefined
  • Auf true setzen, um das Anzeigenfailover-Verhalten zu aktivieren. Dies ist eine mehrteilige Konfiguration, die abhängt von:
    • Sowohl IMA3- als auch SSAI-Plugins müssen auf dem konfiguriert werden player.
    • An ad_config_id sollte verfügbar sein, sonst sind SSAI-Anzeigen nicht verfügbar.

application_id

application_id Informationen:

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

Autovorfahrt

autoadvance Informationen:

  • Datentyp: Zeichenfolge
  • Standard: Nicht anfänglich aktiviert
  • Wird mit Wiedergabelisten verwendet und legt das Verhalten für die automatische Vorauswahl der Wiedergabeliste fest.

Für weitere Informationen siehe die Wiedergabelisten Abschnitt unten, sowie die Wiedergabelisten-API Dokument.

Autoplay

autoplay Informationen:

  • Datentyp: Boolean oder String
  • Standard: false
  • Zeigt an, dass die player sollte sofort mit dem Spielen beginnen, auf Plattformen, auf denen dies zulässig ist.

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

  • play: Das player wird manuell versuchen, play abzurufen.
  • muted: Das player schaltet das manuell stumm player und Play anrufen.
  • any: Das player Ich werde zuerst versuchen, Play aufzurufen. Wenn dies fehlschlägt, schalten Sie die Stummschaltung aus player und Play anrufen.

Wenn einer der oben genannten Fehler auftritt, wird der player zeigt den "Big Play Button" an, als ob Autoplay auf false gesetzt wäre.

Im Folgenden wird eine curl-Anweisung gezeigt, mit der die 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 String-Werten

    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

Das automatische Abspielen eines Videos kann eine komplexe Situation sein. Siehe die Autoplay-Überlegungen Dokument für weitere Details.

base_url (für Probleme mit IP-Einschränkungen)

Bei Verwendung von IP-Einschränkungen mit können Probleme auftreten Brightcove Players außerhalb von Nordamerika verwendet. Wenn ein Brightcove Player wird gebeten, ein Video von einem zu laden Video Cloud Konto, es verbindet sich mit dem Katalog unter dieser Adressehttps://edge.api.brightcove.com/playback/v1/.

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

  • Wenn Edge von WITHIN North America aus auf Edge trifft, trifft es Edge direkt und Edge erkennt die IP-Adresse des Benutzers. Es kann den Zugriff auf den Katalog gemäß der IP-Einschränkungs-Whitelist entweder zulassen oder verweigern. Dies ist die gewünschte Funktionalität.
  • Wenn Sie Edge von OUTSIDE North America aus erreichen, wird es über Cloudfront für CDN-Gründe für das Lastenausgleichs- / lokale Caching bereitgestellt. Das ist wichtig, weil Edge dadurch die Cloudfront-IP anstelle der IP des Benutzers erkennt und allen verweigert, weil Cloudfront nicht auf der Whitelist steht (und dies nie tun sollte, weil jeder, der Cloudfront verwendet, Zugriff hätte).

Um dieses Problem zu beheben, können Sie das konfigurieren player um einen alternativen Edge-Endpunkt zu verwenden, edge-alb.api.brightcove.com. Diese Änderung muss an jedem vorgenommen werden player das muss von außerhalb Nordamerikas auf das IP-beschränkte Konto zugreifen.

Die eigentliche Konfigurationsänderung beinhaltet das Setzen eines Wertes für die Video Cloud base_url. Denken Sie daran, dies sollte NUR geändert werden, wenn IP-Beschränkungen mit verwendet werden Brightcove Players außerhalb von Nordamerika. Für eine bestehende playerwürden Sie den folgenden Curl-Befehl verwenden, der das verwendet PATCH HTTP-Methode (Sie müssen Ihre Daten für 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

Wenn Sie neu sind, werden folgende Dokumente hilfreich sein:

Haltepunkte

breakpoints Informationen:

  • Datentyp: Objekt
  • Standard: Die Standardhaltepunkte sind:
  • Bei Verwendung mit ansprechbar Option, setzt Haltepunkte, die konfigurieren, wie Klassennamen auf dem umgeschaltet werden player um die Benutzeroberfläche basierend auf dem anzupassen playerDimensionen.
    Klassenname Breitenbereich
    vjs-layout-tiny 0-210
    vjs-layout-x-small 211-320
    vjs-layout-small 321-425
    vjs-layout-medium 426-768
    vjs-layout-large 769-1440
    vjs-layout-x-large 1441-2560
    vjs-layout-riesig 2561+

Während die Klassennamen nicht geändert werden können, können die Breitenbereiche über ein Objekt wie das folgende konfiguriert werden:

    breakpoints: {
      tiny: 300,
      xsmall: 400,
      small: 500,
      medium: 600,
      large: 700,
      xlarge: 800,
      huge: 900
    }
  • Die Schlüssel des Haltepunktobjekts werden von den zugehörigen Klassennamen abgeleitet, indem Sie das vjs-layout- Präfix und beliebiges - Zeichen.
  • Die Werte des Haltepunktobjekts definieren die maximale Breite für einen Bereich.
  • Nicht alle Schlüssel müssen definiert werden. Sie können einen einzelnen Haltepunkt einfach überschreiben, indem Sie ein Objekt mit einem Schlüssel / Wert-Paar übergeben. Benutzerdefinierte Haltepunkte werden mit den Standard-Haltepunkten zusammengeführt, wenn die player geschaffen.

Wenn das playerWenn sich die Größe ändert, werden die zusammengeführten Haltepunkte in der Größenreihenfolge überprüft, bis ein passender Haltepunkt gefunden wird. Der diesem Haltepunkt zugeordnete Klassenname wird als Klasse zum hinzugefügt player. Die Klasse des vorherigen Haltepunkts wird entfernt.

crossorigin

crossorigin Informationen:

  • Datentyp: Boolesch
  • Voreinstellung: false
  • If was immer dies auch sein sollte., das zugrunde liegende <video> Element wird haben crossorigin = "anonym". Dies bedeutet, dass alle Videos oder Textspuren in die player muss CORS-Header haben.

CSS-Farbüberschreibungen

Es gibt drei Eigenschaften, mit denen die Farben in überschrieben werden können player. Es sind dies:

  • controlColor: Die Farbe der Schaltflächen und des Textes (z. B. Abspielposition und Videodauer)
  • controlBarColor: Die Hintergrundfarbe der Kontrollleiste und die große Play-Taste
  • progressColor: Die Farbe der Fortschrittsleiste

Jede gültige CSS-Farbe (z. B. Hexfarben) ist für diese Eigenschaften akzeptabel.

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

Debugger

Der Debugger zeigt player Informationen in einem modalen Fenster. Siehe die Player Informationen Modal Dokument für vollständige Informationen.

Dock

dock Informationen:

  • Datentyp: Boolesch
  • Voreinstellung: true
  • Wenn explizit false, das player wird die sogenannten nicht enthalten Dock wo der Videotitel und die Beschreibung angezeigt werden können.

eingebettete_id

embed_id Informationen:

  • Datentyp: Zeichenfolge
  • Standard: undefined
  • Unser Video Cloud damit verbundene ID einbetten player. Wenn der Wert ist default es bedeutet das player ist kein Kind player. Wenn der Wert nicht ist defaultist ein Wert, der das übergeordnete Element des player.

Fehler

errors Informationen:

  • Datentyp: Object oder Boolean
  • Voreinstellung: true
  • Explizit festlegen false wird das verhindern player von einschließlich Videojs-Fehler, das ist das Plugin für Fehlermeldungen. Wenn Sie diesen Wert falsch machen, wird das player um den Zuschauern keine detaillierten Fehlermeldungen anzuzeigen, wenn ein Fehler auftritt. Fehler, die die Wiedergabe verhindern, werden weiterhin in der Webentwicklerkonsole angezeigt.

Blitz

flash Informationen:

  • Datentyp: Objekt
  • Standard: undefined
  • Kann verwendet werden, um benutzerdefinierte Flash-Optionen bereitzustellen Video.js.

fullscreenControl

fullscreenControl Informationen:

  • Datentyp: Boolesch
  • Voreinstellung: true
  • Gibt an, ob das Vollbild-Steuerelement in der Steuerleiste angezeigt werden soll

Im Folgenden wird eine curl-Anweisung gezeigt, mit der die fullscreenControl Wert:

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

Die folgenden zwei Screenshots zeigen die player mit und ohne Vollbildsteuerung:

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

hls

hls Informationen:

  • Datentyp: Object oder Boolean
  • Standard: {}
  • If false, das player wird nicht enthalten videojs-http-streaming. Andernfalls wird ein Objekt als Optionen für übergeben videojs-http-streaming.

Inaktiv player

Es ist möglich zu machen players inaktiv. Vielleicht möchten Sie dies tun, um eine zu haben player Stoppen Sie die Bereitstellung von Inhalten, aber es wird kein 404-Fehler angezeigt, wenn ein gelöschter Inhalt angezeigt wird player wird durchsucht.

So deaktivieren Sie a player Stellen Sie den player Felder inactive Eigentum zu 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

Natürlich, wenn Sie das aktivieren möchten playerkönnen Sie die inactive Eigentum zu false.

Sobald die player ist deaktiviert, wenn ein Benutzer das durchsucht player Die folgende Meldung wird angezeigt:

Deaktiviert Player
Deaktiviert Player

Sprache

language Informationen:

  • Datentyp: Zeichenfolge
  • Standard: undefined
  • Kann zur Verfügung gestellt werden, um die lang Attribut des <html> Element.

Sprachen

languages Informationen:

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

Schleife

loop Informationen:

  • Bewirkt, dass das Video neu gestartet wird, sobald es beendet wird.

Medien

Unser media Eigenschaft hat untergeordnete Eigenschaften, wie in der folgenden Tabelle gezeigt.

Immobilien Dateityp Beschreibung
src Schnur
  • Die URL der Videodatei, die in die geladen werden soll player
Quellen Array von Objekten
  • Ein Array von Quellobjekten in der Reihenfolge ihrer Präferenz
  • Die Elemente dieses Arrays werden direkt übersetzt source Elemente
  • A Quelle Objekt sollte zwei Eigenschaften haben: src und type
  • Unser type Attribut ist der MIME-Typ des Videos, wie im HTML5-Standard angegeben
Titel Schnur
  • Inhalt der <title> Element der Seite
poster.hochzeiten Schnur
  • Der Dateipfad zum Posterbild relativ zum Stammverzeichnis der Skin
Höhe Schnur
  • Die Höhe des Videos
  • Der Standardwert ist relativ zur Breite und eignet sich für ein Video mit einem 2: 1-Seitenverhältnis
Breite Schnur
  • Die Breite des Videos
  • Der Standardwert ist relativ zur Höhe und eignet sich für ein Video mit einem 2: 1-Seitenverhältnis
Spuren Feld
  • Ein Array von Track-Objekten
  • Der Standardwert ist nicht definiert
  • Die Elemente dieses Arrays werden fast direkt übersetzt Titelelemente. Siehe Fügen Sie Videos Untertitel hinzu Dokument für ein Beispiel für die Verwendung von Tracks mit Brightcove Player.

Im folgenden JSON können Sie a sehen media Eigenschaft mit:

  • A poster.hochzeiten Eigentum
  • A 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"
      }]
    },

Die Quelle, die für die Wiedergabe ausgewählt wird, hängt von der von Ihnen konfigurierten Videoreihenfolge und den Funktionen des Browsers und des Geräts ab, auf dem sich das Video befindet player wird geladen. Wenn Sie die Standardeinstellungen nicht geändert haben und HLS nativ unterstützt wird, wird die player prüft, ob eine der Quellen auf HLS-Videos verweist, und wählt die erste aus, die gefunden wird. Wenn HLS nicht nativ unterstützt wird oder keine HLS-Videoquellen angegeben wurden, wird als nächstes die HTML-Wiedergabe versucht. Wie zuvor wird die erste abspielbare Quelle ausgewählt. Wenn die ersten beiden Versuche, das Video abzuspielen, fehlschlagen, wird ein Flash-Fallback versucht.

Zusammenfassend gibt die Abspielreihenfolge Ihr bevorzugtes Wiedergabemedium an und dann probiert jede konfigurierte Option alle verfügbaren Quellen aus und verwendet die erste, die sie spielen kann.

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

Aktuelle Quelle
Aktuelle Quelle

gedämpften

muted Informationen:

  • Datentyp: Boolesch
  • Voreinstellung: false
  • Legt fest, ob der Ton stummgeschaltet ist, wenn die player Ladungen.

picture_in_picture_control

picture_in_picture_control Informationen:

  • Datentyp: Boolesch
  • Voreinstellung: true
  • Gibt an, ob das integrierte Bild-in-Bild-Steuerelement in der Steuerleiste angezeigt werden soll.

Wiedergaberaten

playback_rates Informationen:

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

Die Werte werden gelesen und dann in einer Wiedergaberatensteuerung in der angezeigt playerSteuerleiste.

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

player

player Informationen:

  • Datentyp: Objekt
  • Standard: Füllen mit player genaue Informationen
  • Enthält verschiedene Metadaten dazu player, zum Beispiel inactive und template.version.

play_button

play_button Informationen:

  • Datentyp: Objekt
  • Die folgenden Eigenschaften können über geändert werden player Konfiguration:
    Immobilien Typ Bewirken
    schweben Schnur glow or darken; Standard ist Rosa / Fortschrittsfarbe
    gestalten Schnur square or rectangle; Standard ist ein Kreis
    Position Schnur topLeft or topRight; Standard ist Mitte

player_id

player_id Informationen:

  • Datentyp: Zeichenfolge
  • Unser Video Cloud player ID zugeordnet mit a player

player_name

player_name Informationen:

  • Datentyp: Zeichenfolge
  • Unser Video Cloud player Name verbunden mit a player - beachten Sie das name Sie geben für die player wird zurückgegeben als player_name wenn Sie die Konfiguration durch setzen bekommen config.json am Ende des player Vorschau-URL (wird zurückgegeben als name wenn Sie die Konfiguration über die Player Management API. Aber du musst verwenden name wenn Sie die erstellen oder aktualisieren player.

Spielzeile

playsinline Informationen:

  • Datentyp: Boolesch
  • Voreinstellung: false
  • Aktiviert die player für die Inline-Wiedergabe (für die Wiedergabe auf einigen Geräten erforderlich).

Wiedergabelisten

Es gibt jetzt zwei verschiedene Playlist - Implementierungen, die im Playlisten verwenden Dokument. Der Standardwert ist Version 3. Informationen zur Konfiguration beider Versionen finden Sie hier.

Beide Konfigurationen zeigen, wie Sie Folgendes festlegen:

  • autoadvance: Zugewiesene Ganzzahl in Sekunden, um zu verzögern, bevor das nächste Video in die Wiedergabeliste geladen wird; Wert von 0 zugewiesen wird keine Wartezeiten zwischen den Videos verursachen; Wert von null zugewiesen wird keine automatische Weiterschaltung verursachen.
  • playOnSelect: Zugewiesen true Wenn Sie also auf ein Element im Wiedergabelistenmenü klicken, wird das Video beim Laden abgespielt, auch wenn das vorherige Video in der Wiedergabe angezeigt wird player wurde angehalten.

Playlist-Version 3 (Standard)

Um Wiedergabelisten mit dem 3-Plugin zu konfigurieren, verwenden Sie die Plugin-Registrierung. Hier ist eine curl-Anweisung, um die Verwendung des Playlist-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 das zu setzen playOnSelect und autoadvance Optionen beim Erstellen der player Verwenden Sie Folgendes:

    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, mit denen die Verwendung der Wiedergabelistenversion 1 konfiguriert wird. Sie sind:

  • playlist: Zugewiesen true Ein ... Haben player Verwenden Sie Wiedergabelisten.
  • adjusted: Zugewiesen true das haben player einstellen player Abmessungen für die Wiedergabeliste.

Hier ist eine curl-Anweisung, um drei Eigenschaften für die Wiedergabeliste 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 Für die Playlist-Version 1 verwende 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 player enthält eine Wiedergabeliste

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

    player.hasPlugin('playlist')

Wenn Sie prüfen, ob ein Wiedergabelisten-Plugin vorhanden ist, und nicht auf einer Seite mit einem player (Zum Beispiel beim Überprüfen einer Liste von players für die Verwendung mit einem Stecker) müssen Sie einen etwas komplizierteren Prozess verwenden. Sie würden das lesen playerÜberprüfen Sie dann die Konfiguration, um festzustellen, ob die Plugins Abschnitt der playerJSON 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');
    }

Plugins

Unser plugins property gibt die Reihenfolge an, in der die video.js-Plugins und alle benutzerdefinierten Einstellungen, die für sie gelten sollen, initialisiert werden. Das Plugin muss von einem entsprechenden unterstützt werden scripts Property URL-Eintrag und bei Bedarf eine Unterstützung stylesheets URL Jedes Element der plugins Array ist ein Objekt mit a name Eigenschaft und kann auch optional enthalten options Eigentum:

  • name: Der Name des video.js-Plugins, der aus dem unterstützenden JavaScript-Code stammt
  • options: Ein Objekt-Hash für Einstellungen, die beim Initialisieren dem Plug-in zugewiesen werden

Optionen Kind

In diesem options Untergeordnete Eigenschaft übergeben Sie Daten, die zur Initialisierungszeit verwendet werden. Der folgende JSON übergibt ein einzelnes Objekt in der options.

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

Dies gibt Ihnen die Möglichkeit, Daten über das an ein Plugin zu übergeben player Aufbau. Zum Beispiel, um die zu verwenden redirectURL Objekt oben gezeigt, würden Sie das folgende im Plugin selbst 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 auf den Wert mit zugreifen options.propertyName Notation.

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

Vorspannung

preload Informationen:

  • Datentyp: Zeichenfolge
  • Standard: none
  • Das Preload-Attribut informiert den Browser darüber, ob die Videodaten heruntergeladen werden sollen, sobald das Video-Tag geladen ist. Die Optionen sind Auto, Metadaten, und keiner.
  • Auto: Gibt an, dass die gesamte Videodatei heruntergeladen werden kann, auch wenn der Benutzer das Video möglicherweise nicht sieht. Auf der positiven Seite, wenn der Zuschauer das Video spielt, kann es sofort spielen. Auf der negativen Seite erhöht diese Option den Bandbreitenverbrauch, da das Vorladen / Laden stattfindet, selbst wenn der Betrachter das Video nicht abspielt.

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

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

    <video-js preload ...>
    or
    { "preload": "auto" }

query_string_to_window

query_string_to_window Informationen:

Wird verwendet, um die Grundgesamtheit des globalen Namespace (Fensters) über Abfragezeichenfolgenparameter zu steuern. Dies ist besonders in Fällen von Embedded nützlich players, wie z. B. AMP-Komponenten von Google oder Facebook-Sofortartikel. Das Parsen von Abfragezeichenfolgen erfolgt mit Node.js Querystring-Modul. Die Verwendung dieses Konfigurationsobjekts erfordert mindestens eine der folgenden Untereigenschaften. Beide können gleichzeitig verwendet werden.
    • Name: query_string_to_window.target
    • Datentyp: Zeichenfolge
    • Beschreibung: Ein Zielobjekt, das im Fenster erstellt werden soll und mit der gesamten analysierten Abfragezeichenfolge gefüllt wird. Zum Beispiel eine Verwendung von query_string_to_window.target gegeben das folgende in a player Konfiguration:
          {
          "query_string_to_window": {"target": "queryStringParams"}
          }
      und die folgende Abfragezeichenfolge angegeben:
          ?foo=bar&nums=1&nums=2
      würde folgendes ergeben window.queryStringParams globales Objekt wäre für die verfügbar player und Plugins:
          {
          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 in der window Objekt oder seine Prototypkette wird nicht gesetzt. Zum Beispiel eine Verwendung von query_string_to_window.globals gegeben das folgende in a player Konfiguration:
          {
          "query_string_to_window": {
            "globals": [
              "foo",
              "nums",
              "self"
            ]
          }
          }
      und geben Sie die folgende Abfragezeichenfolge ein:
          ?foo=bar&nums=1&nums=2&self=not-allowed
      würde folgendes ergeben window globales Objekt mit folgenden Eigenschaften hinzugefügt:
          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 Informationen:

  • Datentyp ist boolean
  • Bewirkt, dass eine Wiedergabeliste die Wiedergabe wiederholt, wenn die player ist eine Wiedergabeliste player. Stellen Sie auf der obersten Ebene des player Konfiguration.

ansprechbar

responsive Informationen:

  • Datentyp: Boolesch
  • Standard: true
  • Setzen Sie diese Option auf true wird das dazu führen, player um sich basierend auf reaktionsfähigen Haltepunkten anzupassen (siehe: Haltepunkte Möglichkeit).

Ausführliche Informationen zu dieser Funktion finden Sie in den Release-Informationen für Brightcove Player 6.29.2.

Skripte

scripts Informationen:

  • Der Datentyp ist ein Array von Zeichenfolgen, die auf JavaScript-Dateien verweisen, die im enthalten sind player
  • Kein Standardwert
  • Zu der Zeit die player Wenn diese Dateien erstellt werden, werden sie heruntergeladen und in die resultierende Ausgabe eingefügt, sodass sie zur Laufzeit nicht anschließend abgerufen werden müssen
  • Skripts werden in der angegebenen Reihenfolge inline eingefügt, sodass Sie sicher Skripts einschließen können, die voneinander abhängig sind

Haut

skin Informationen:

  • Datentyp: Boolean oder String
  • Standard: nicht definiert
  • Bestimmt die visuelle Stilvariante, die die player wird benutzen. Dieser Wert spiegelt sich auch im global zugänglichen wider bc.SKIN Eigenschaft im Browser. Es erkennt die folgenden Werte:
    Wert bc.SKIN Beschreibung
    "Graphit" "Graphit" Benutzt das alte Brightcove Player Stil sowie einige Kompatibilitäts-Hacks.
    falsch „Keine“ Deaktiviert alle Brightcove Player Styling. Dies ist die Option, die von Grund auf für eine stark angepasste Benutzeroberfläche verwendet werden kann.
    undefiniert "luna" Verlasse das undefined wird das dazu führen, player um die Standard-Skin (auch bekannt als Luna) zu verwenden.

Stylesheets

stylesheets Informationen:

  • Ein Array von URL-Zeichenfolgen, die auf CSS-Dateien verweisen, die in der enthalten sein sollten player
  • Zu der Zeit die player erstellt wird, werden die zusätzlichen Stylesheets heruntergeladen und in die eingefügt player damit sie zur Laufzeit nicht abgerufen werden müssen
  • Stylesheets sind in der Reihenfolge enthalten, in der Sie sie angeben

techOrder

techOrder Informationen:

  • Datentyp: Array
  • Standard: ['html5', 'flash']
  • Standardmäßig Brightcove Player führt Tech-first Bestellung, wenn nach einer Quelle / Technologie-Kombination zum Abspielen von Videos gesucht wird. Dies bedeutet, dass, wenn Sie zwei Quellen und zwei Techniker haben, die player Ich werde versuchen, jedes Video mit der ersten Technologie in der Wiedergabe abzuspielen techOrder Option Eigenschaft, bevor Sie fortfahren, um die nächste Wiedergabe-Technologie zu versuchen. Siehe die Anleitung: Wiedergabe-Technologie Dokument für weitere Informationen.

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

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

Version

Sie können die manuell einstellen player Version mit dem PLAYERS Modul JSON-Editor.

Version

video_cloud

Mit dieser Eigenschaft können Sie eine erstellen player mit einem Video von Ihrem Video Cloud Bibliothek. Die folgende Curl-Anweisung zeigt player Erstellung mit a Video Cloud Video ID.

    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 Top-Level-Eigenschaften, und alle anderen sind Eigenschaften der configuration Objekt. Irgendwelche der Konfigurationseigenschaften kann in die aufgenommen werden configuration wenn Sie die erstellen player.

Volumenorientierung

volume_orientation Informationen:

  • Datentyp: Zeichenfolge
  • Voreinstellung: horizontal
  • Unser volume_orientation Diese Eigenschaft legt fest, ob der Lautstärkeregler horizontal oder vertikal ausgerichtet ist.
    Volumen horizontal
    Volumen vertikal

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

Lautstärkeausrichtung einstellen
    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 Informationen:

  • Datentyp: Zeichenfolge
  • Standardeinstellung: vjs.zencdn.net CDN
  • Legt die URL fest, von der geladen werden soll vtt.js. Dies ist die gleiche wie bei der standardmäßigen Video.js-Option vtt.jsdem „Vermischten Geschmack“. Seine Brightcove Player verwendet vttjs stattdessen ist als gepunkteter Eigenschaftenname keine Verwendung in der möglich Player Management APIund kann an anderer Stelle problematisch sein. Die Option kann als eingestellt werden data-vttjs Attribut a vttjs iframe-Abfrageparameter, a vttjs Setup-Option oder vttjs in player Konfiguration.

wait_for_ad_block_detect

wait_for_ad_block_detect Informationen:

  • Datentyp: Boolesch
  • Standard: nicht definiert
  • Wenn auf eingestellt true, das player verzögert den automatischen Initialisierungsprozess, bis die Ad-Block-Erkennung eine Entscheidung getroffen hat. Dies kann sich verzögern player Initialisierung um bis zu 100 Millisekunden oder so. Dies muss nicht eingestellt sein true bei der Verwendung von ad_failover da das Verzögerungsverhalten in beiden Fällen auftritt.

Seite zuletzt aktualisiert am 12. Juni 2020