@brightcove/player-url

一个将 URL 获取到 亮湾玩家。 。 。 .

安装

npm install --save @brightcove/player-url

使用量

包括 @brightcove/player-url 使用下列任何方法.

ES 模块

当在与ES模块相兼容的环境中使用,或者像Rollup或webpack这样的捆绑器时,安装 @brightcove/player-url 通过 npm 和 import 插件,如您想要其它模块.

import brightcovePlayerUrl from '@brightcove/player-url';

const myPlayerUrl = brightcovePlayerUrl({
  accountId: '1234567890',
  playerId: 'abc123xyz'
});

console.log(myPlayerUrl); // https://players.brightcove.net/1234567890/abc123xyz_default/index.min.js

浏览/共同JS

在使用浏览器时安装 @brightcove/player-url 通过 npm 和 require 插件,如您想要其它模块.

var brightcovePlayerUrl = require('@brightcove/player-url');

var myPlayerUrl = brightcovePlayerUrl({
  accountId: '1234567890',
  playerId: 'abc123xyz'
});

console.log(myPlayerUrl); // https://players.brightcove.net/1234567890/abc123xyz_default/index.min.js

要求JS/AMD

使用 RequestJS( 或另一个 AMD 库) 时, 以您喜欢的方式获取脚本 require 通常情况下的插件 :

require(['@brightcove/player-url'], function(brightcovePlayerUrl) {
  var myPlayerUrl = brightcovePlayerUrl({
    accountId: '1234567890',
    playerId: 'abc123xyz'
  });

  console.log(myPlayerUrl); // https://players.brightcove.net/1234567890/abc123xyz_default/index.min.js
});

<script> 标记

这是最简单、最不可取的案例。 我们期望大多数人会将这个模块捆绑到一个应用程序或另一个模块中.

<script src="//path/to/brightcove-player-url.min.js"></script>
<script>
  var myPlayerUrl = brightcovePlayerUrl({
    accountId: '1234567890',
    playerId: 'abc123xyz'
  });

  console.log(myPlayerUrl); // https://players.brightcove.net/1234567890/abc123xyz_default/index.min.js
</script>

参数

本单元取以下参数.

accountId

需求 类型 : string

黑洞的账号.

playerId

类型 : string 默认 : "default"

闪亮湾玩家身份证明.

embedId

类型 : string 默认 : "default"

闪光湾玩家嵌入了ID.

iframe

类型 : boolean 默认 : false

是否返回嵌入到 Iframe 中的 HTML 文档的 URL .

minified

类型 : boolean 默认 : true

当 iframe 参数是: false,这可用于控制是否返回已修改或未修改的JavaScript URL.

base

类型 : string 默认 : "https://players.brightcove.net"

一个基础CDN协议和主机名. 主要用于测试,但可能有其他用途. 可能还有后面的斜线.

queryParams

类型 : Object 默认 : null

当 iframe 参数是: true,此选项可用于在 URL 中添加一个查询字符串,其中包含一个可能的参数的白名单:

• adConfigId: 回放令牌,指定哪些SSAI配置,CDN和DVR选项用于Brightcove Live流.
• applicationId:用于区分同一玩家不同用途的分析分析的应用程序ID.
• catalogSearch:要表演的视频云目录搜索.
• catalogSequence:一个Video Cloud目录序列,用来流行一个播放列表.
• playlistId:一个要加载的视频云播放列表 ID.
• playlistVideoId:一个视频ID,在此开始视频云播放列表回放.
• videoId: 需要加载的视频云视频ID.
• interactivityProjectId: 用于加载的互动项目 ID.

许可证

Apache-0. 版权 (c) Blightcove, Inc.