ロゴ オーバーレイは、動画の隅を覆って表示される小さく、多くの場合は一部が透明な画像です。ロゴ オーバーレイは、オンラインでブランドを強化したり、Web サイトへのトラフィックを促すのに役立つ有用なツールです。各画像に関連付けたクリックスルー リンクを設定して、サイトへのトラフィックの促進や特定のページのプロモーションに使用できます。Video Cloud は、動画にロゴを追加する複数の方法を提供しています。
add_logo_overlay メソッドを使用して、1 つ以上の動画にロゴ オーバーレイを設定できます。このトピックでは、Media API の add_logo_overlay メソッドを使用して、既存の動画にロゴ オーバーレイを割り当てる方法について説明します。新しいロゴ オーバーレイを追加したり（ファイルのアップロードまたはリモートアセット URL の提供による）、既存のロゴ オーバーレイを動画に割り当てることができます。add_logo_overlay メソッドは、動画に追加された LogoOverlay オブジェクトを返します（LogoOverlay を新規に作成する場合、既存のものを更新する場合、既存のものを更新せずに使用するだけの場合、いずれも同じ）。remove_logo_overlay メソッドを使用して、動画からロゴ オーバーレイを削除することもできます。
ロゴ オーバーレイ画像の作成に関する詳細は、「動画にロゴを追加する」を参照してください。
「Media API リファレンス」に、add_logo_overlay メソッドで使用されている全パラメータの説明があります。「Media API オブジェクト リファレンス」には、add_logo_overlay によって作成または更新されて返される LogoOverlay オブジェクトの全プロパティの説明があります。このメソッドのシグネチャは以下のとおりです。
add_logo_overlay(token:String, logooverlay:LogoOverlay,
filename:String, maxsize:Long,
file:InputStream, file_checksum:String,
video_id:Long, video_reference_id:String):LogoOverlay
書き込みメソッドなので、お持ちのアカウントの Media API 書き込みトークンを使用してください。
add_logo_overlay メソッドでは、特定のパラメータが場合により必要となります。
file（maxsize と filename を設定）または remoteUrl（LogoOverlay のプロパティとして）を指定する必要があります。id または reference_id を（LogoOverlay のプロパティとして）指定する必要がありますvideo_id または video_reference_id を提供する必要があります。ロゴ オーバーレイを作成する標準的な方法では、画像を Video Cloud サーバーにアップロードします。アカウントでリモート アセットを有効にしている場合は、ロゴ オーバーレイ アセットを自社のサーバー上に置き、LogoOverlay の image プロパティの remoteUrl プロパティを使用して、画像の場所を指定することもできます。リモート アセットついての詳細は、「リモート動画ファイルで動画を作成する」を参照してください。
remove_logo_overlay メソッドを使用して、動画からロゴ オーバーレイを削除できます。このメソッドは、ロゴ オーバーレイと指定された動画との間の関連付けを削除するだけです。ロゴ オーバーレイは削除せず、それが割り当てられている他の動画に影響しません。「Media API リファレンス」に、remove_logo_overlay メソッドで使用されている全パラメータの説明があります。このメソッドのシグネチャは以下のとおりです。
remove_logo_overlay(token:String, video_id:Long, video_reference_id:String):void
書き込みメソッドなので、お持ちのアカウントの Media API 書き込みトークンを使用してください。トークンと共に動画の Video Cloud 動画 ID または参照 ID のいずれかを渡します。そうすると、動画へのロゴ オーバーレイの割り当てが解除されます。
add_logo_overlay メソッドの使用方法の具体例をいくつか示します。
また、JavaScript による完全な例も参照してください。
この例では、multipart/form-data の POST で画像ファイルをアップロードすることを前提としています。file_checksum はオプションです。このチェックサムが指定され、アップロードされたファイルのチェックサムと一致しない場合は、308 NonmatchingChecksumError になります。アップロードされたファイルが GIF、PNG のいずれでもない場合は、306 FileFormatError になります。この例の video_id プロパティは、id が 17035 の動画に新しいロゴ オーバーレイを割り当てようとしていることを示しています。
{
"method" : "add_logo_overlay",
"params" : {
"token" : "riBfgveLvpRb-rHGiBBouSAXs-Q8NmphGxt0z04kE.",
"logooverlay" : {
"image" : {
"referenceId" : "wicklow-1",
"displayName" : "Wicklow Corp. logo",
"type" : "LOGO_OVERLAY" },
"tooltip" : "Click the bunny to win!",
"linkURL" : "http://wicklow.example.com/bunny",
"alignment" : "TOP_LEFT" },
"file_checksum" : "d1c9c2b112993a0079a0128ecb9b36dd",
"video_id" : 17035
}
}
上記の例の JSON を送信すると、add_logo_overlay メソッドから次の内容が返されます。
{"result": {"displayName":"Wicklow Corp. logo","id":30300017070001,
"referenceId":"wicklow-1","remoteUrl":null,"type":"LOGO_OVERLAY"},
"error": null, "id": null}
この例では remoteUrl を指定しているので、ファイルをアップロードする必要はありません。リモート アセットを作成しようとしたときに、この機能がアカウントで有効になっていなければ、Media API 呼び出しが 309 RemoteAssetsDisabledError を返します。リモート アセットついての詳細は、「リモート動画ファイルで動画を作成する」を参照してください。
{
"method" : "add_logo_overlay",
"params" : {
"token" : "riBfgveLvpRb-rHGiBBouSAXs-Q8NmphGxt0z04kE.",
"logooverlay" : {
"image" : {
"referenceId" : "still-1",
"displayName" : "first remote still",
"type" : "LOGO_OVERLAY",
"remoteUrl" : "http://www.example.com/images/logoOverlay1.jpg" },
"tooltip" : "Click the bunny to win!",
"linkURL" : "http://wicklow.example.com/bunny",
"alignment" : "TOP_LEFT" },
"video_reference_id" : "video-2"
}
}
この例では、既存のロゴ オーバーレイ アセットの referenceId を指定し、新しい remoteUrl のファイルで既存のロゴ オーバーレイ アセットを更新します。この場合、アセットのタイプはすでに認識済みのため、type は不要です。実際のところ、type を指定して LOGO_OVERLAY に変えたとしても、既存のアセットの type を変えることはできないので、何の影響もありません。
referenceId. の代わりに、ロゴ オーバーレイの Video Cloud id を指定することもできます。
ただし、このロゴ オーバーレイを割り当てる動画の video_id または video_reference_id は指定する必要があります。これは常に必須です。このケースでは、他の動画に割り当てないので、すでにこのロゴ オーバーレイを使用している動画の referenceId を指定します。
{
"method" : "add_logo_overlay",
"params" : {
"token" : "riBfgveLvpRb-rHGiBBouSAXs-Q8NmphGxt0z04kE.",
"logooverlay" : {
"image" : {
"referenceId" : "logoOverlay-1",
"remoteUrl" : "http://www.example.com/public/images/logoOverlay1.jpg" },
"tooltip" : "Click the bunny to win!",
"linkURL" : "http://wicklow.example.com/bunny",
"alignment" : "TOP_LEFT"
},
"video_reference_id" : "video-2"
}
}