EmbedコードActionScript API

embedコードActionScript APIは、アセットのembedコードの取得、設定、アセットの説明の取得、画像の取得、 アセットのメタデータをフェッチするために使用出来ます。

embedコードのプロパティ

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

関数 説明
getCurrentItemEmbedCode

チャンネルの現在のビデオのembedコードを取得します。

タイプ:文字列

戻り値: embedコード情報を返します。

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

タイプ:文字列

戻り値: embedコード情報を返します。

例:"Q3bDhiMToizUftO"

getItem 埋め込みアイテムを説明するオブジェクトを取得します。オブジェクトにはembedCode、title、description、time (秒単位の再生時間)、lineup、promo、hostedAtURLが含まれます。

タイプ:オブジェクト

戻り値:アイテム説明

setCurrentItemEmbedCode チャンネルの現在のビデオのembedCodeを設定します。

タイプ:文字列

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

タイプ:文字列

EmbedCode関数

次の表はembedコードに関連付けられたすべてのJavaScript関数について説明します。

イベント 説明
changeCurrentItem(embedCode)

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

タイプ:ブーリアン

戻り値: true | false

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

タイプ:ハッシュ

embedCodeChanged()

description, embedCode, hostedAtURL, lineup, promo

タイプ:ハッシュ

fetchMetadata(embedCode)

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

タイプ:文字列

戻り値: 名前/値ペア

fetchRelatedMedia(embedCode, options)

指定されたembedCodeについて関連メディアのフェッチを開始します。関連メディアがフェッチされると、アセットの関連メディアを含むrelatedMediaReadyイベントが送信されます。関連メディアは、Backlotの公開->プレイヤーブランディング->終了タブで指定して下さい。 オプションパラメータは任意のObjectパラメータで、以下のフィールドを持ちます。

  • orderBy:
  • uploadedAt,DESC
  • uploadedAt,ASC

例:最新ビデオにあるembedコードの関連メディアを最初にフェッチする方法:

 fetchRelatedMedia("theEmbedCode", { orderBy: "uploadedAt,DESC" })
getPromoFor(embedCode, width, height) 少なくとも指定されたディメンションにおけるチャンネル内の特定のembedコードについてプロモ画像URLを 返します。 あるいはチャンネル内にないembedコードについてはnullを返します。

タイプ:文字列

戻り値:URL | null

関連情報

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

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