EmbedコードJavaScript API

EmbedコードJavaScript APIを使用すると、アセットのembedコードの取得、設定、アセット説明の取得、画像の取得、アセットのメタデータをフェッチすることが可能です。

embedコードのプロパティ

次の表はembedコードに関連付けられたすべてのJavaScriptプロパティを示します。

関数 説明
SetEmbedCode

現在のプレイヤーにembedCodeを設定します。

タイプ:文字列

getCurrentItemEmbedCode

チャンネルで現在のビデオのembedCodeを取得/設定します。

タイプ:文字列

getEmbedCode

現在のプレイヤーのembedCodeを取得します。

タイプ:文字列

getItem

埋め込みアイテムを説明するオブジェクトを取得します。

タイプ:オブジェクト

戻り値:オブジェクトオブジェクトにはembedCode、title、description、time (秒単位の再生時間)、lineup、promo、hostedAtURLが含まれます。

setCurrentItemEmbedCode チャンネルの現在のビデオのembedCodeを設定します。タイプ:文字列

EmbedCode 関数

次の表は、embedコードに関連付けられたすべてのJavaScriptメソッドを示します。

イベント 説明
fetchMetadata(embedCode)

指定されたembedCodeのカスタムメタデータのフェッチを開始します。メタデータがフェッチされると、 すべてのアセットの名前/値ペアが含まれるmetadataReadyイベントが発動されます。このAPIはプロフェッショナルアカウント及びエンタープライズアカウントでご利用可能です。

タイプ:文字列

有効値:embedコード文字列を指定。

戻り値: 名前/値ペア

getPromoFor(embedCode, width, height)

少なくとも指定されたディメンションに存在するチャンネル内の指定されたembedコードに対するプロモ画像URLを返します。あるいはチャンネル内にないembedコードについてはnullを返します。

タイプ:文字列

有効値:embedコードと横幅、高さを指定します。

戻り値:URL | null

changeCurrentItem(embedCode)

ビデオがある場合、チャンネル内の現在のビデオを設定します。 受諾された場合にはtrue、そうでない場合にはfalseを返します。

タイプ:ブーリアン

有効値: true | false

currentItemEmbedCodeChanged( )

description, embedCode, hostedAtURL, lineup, promo, time (秒単位), title

タイプ:ハッシュ

embedCodeChanged( )

description, embedCode, hostedAtURL, lineup, promo

タイプ:ハッシュ

fetchRelatedMedia(embedCode, options) 指定されたembedCodeについて関連メディアのフェッチを開始します。関連メディアがフェッチされると、 アセットの関連メディアを含むrelatedMediaReadyイベントが発動されます。関連メディアはBacklotの公開->プレイヤーブランディング->終了画面で指定してください。

オプションは、以下のフィールドがある任意のオブジェクトパラメータです。

  • orderBy:
  • uploadedAt,DESC
  • uploadedAt,ASC

次の例は最新ビデオにあるEmbedCodeの関連メディアを最初にフェッチ する方法です。
fetchRelatedMedia("theEmbedCode", { orderBy: "uploadedAt,DESC" })

関連情報

以下はembedコードとembedコードスニペットに関する一般情報が記載されたBacklotドキュメンテーションのリンク一覧です。

この記事はお役にたちましたか?