label: string

Default value: "Upload with Clipchamp!"

埋め込みボタン上のラベル。この文字がボタンの上に表示され、ラッパー要素の中に置かれます。

size: string

Default value: "medium"
Allowed values:
tiny small medium large

Clipchampボタンのサイズ。4つのサイズからお選びいただけます。

title: string

Default value: "Ye' olde video-upload shoppe"

ユーザーが埋め込みボタンをクリックした後に表示されるUIのタイトル。このタイトルはポップアップiframeの一番上に表示されます。

logo: string

Default value: "https://api.clipchamp.com/static/button/images/logo.svg"

UIのロゴ画像のURL。これはiframeの左上の角に表示される画像です。

color: string

Default value: "#303030"

Clipchampボタンの色、ポップアップのタイトルバーの背景、その他グラフィック要素を定義します。色の名前(blueなど)、16進法のカラーコード(例えば#3300cc)、またはRGBにエンコードされた色(rgba(78,24,212,0.5)など)で指定することができます。

style: object

Default value: undefined

Clipchamp API のCSSを使ったビジュアルアピアランスの詳細なカスタマイズができます。カスタマイズされたCSSスタイルシートは、URL(style.url)またはCSSを宣言する文字列(style.text)で得ることができます。どちらの場合も、カスタマイズされたCSSの宣言は増加しますが、Bootstrap 3 の既定のスタイリングに基づいた既存のユーザーインターフェイスのスタイリングを置き換えることはありません。つまり、カスタマイズされたCSSスタイリングは既存のCSSスタイリングの上に重ねられ、既存のCSSのクラスを増幅したり、CSSのプロパティを追加したり置き換えたりすることができます。エンタープライズプランです。

inline: object

Default value: undefined

Clipchamp ウィジェットを含む<iframe>が埋め込まれるページの指定されたラッパー要素の中に置かれる場合に、APIのウィジェットのインライン配置が許可されます。エンタープライズ・プラン。

encoding: object

Default value: undefined

出力エンコーディングパラメーターを構成します。

inputs: Array<string>

Default value: ["file", "camera"]
Allowed values:
file camera direct

ユーザーが入力動画を取得できる入力ソース:ウェブカムの場合はcamera、コンピューターのファイルシステムの場合はfiledirectオプションを選択すると、直接direct.files パラメーターを通じて、エンドユーザーの操作なしに、Clipchamp APIが入力動画ファイルを取得するように指示します。結果として、direct入力オプションは他の2つのオプション(file, camera)のいずれかと合わせて使うべきではありません。仮に、directfileまたはcameraの2つが inputs配列に与えられると、filecamera のオプションが無視され、direct.filesパラメーターが Blobインスタンスの配列になると想定されます。

output: string

Default value: "dummy"
Allowed values:
dummy blob azure s3 youtube gdrive dropbox

出力動画を利用可能にしたりアップロードしたりする行き先。”BLOB”が選択された場合には、出力動画はクライアントサイドのJavaScriptコードに対するBlob として提供されます。”youtube”、”azure”または”s3″のいずれかが選択するには、構成のページから適切なアカウントに動画をアップロードするための認証を与える必要があります。”ダミー”出力は何も出力しませんが、シンプルタイマーを使ってアップロードに刺激を与えるため、バックエンドを構成せずに当初の統合やテストに使うことができます。

upload: object

Default value: undefined

全ての対応するアップロード先に対してアップロードプロセスを構成する設定。

camera: object

Default value: undefined

カメラアップロードをカスタマイズするための構成要素

direct: object

Default value: undefined

入力パラメーターの中でdirectオプションを適用する追加パラメーター

enable: Array<string>

Default value: []
Allowed values:
batch fixup-webcam-webm mobile-webcam-format-fallback no-branding no-error-bypass no-hidden-run no-popout no-probe-reject no-thank-you no-user-retry

Clipchamp APIの特別なビヘイビアを有効にします:

  • batch – ユーザーが随時操作しなくても、複数のファイルをシークエンスとして処理・アップロードできるようになります。
  • fixup-webcam-webm – 時間を合わせる長さに関するメタデータに誤りや欠損が起こりうるWebMウェブカム録画を「修復」します。埋め込まれる動画のメタデータが正しくそろっている状態で、動画処理パイプラインの次のステップがWebMファイルを確実に受け取るようにしたいときに、このフラグを使います。このフラグは現在モバイル端末(つまり、mobile-webcam-format-fallback フラグセットのあるAndroid端末)には適用されません。ベータ
  • mobile-webcam-format-fallback – ターゲットフォーマットが利用できない(エクスペリメンタル)な時でも、モバイル端末でのウェブカム録画の圧縮を有効にします。この機能は、現在、Clipchamp APIがVP8やVP9の動画コーデックを使っているWebMファイルを作成する際にこのフラグを使うAndroid上のChromeに限定されています。
  • no-branding – プランで許可されている場合に、ユーザーの目に入るUIからClipchampのブランディングを削除します。これは埋め込みボタンには適用されません。カスタムボタンAPIオプションを使うと、埋め込みボタンのスタイルを設定することができます(プランで許可されている場合)。
  • no-error-bypass – 何らかの理由でトランスコーディングに失敗した場合には、通常、Clipchampが再ソートして、単に入力ファイルをそのままアップロードします。このフラグはそのビヘイビアよりも優先されます。トランスコーディングの失敗の最も一般的な原因は、入力コーデックへの非対応です。
  • no-hidden-run – ユーザーが「送信」をクリックした後にウィンドウを閉じた場合に、バックグラウンドで処理やアップロードを継続するオプションを無効にします。
  • no-popout – 一部のブラウザはサードパーティのコードの特定の機能の利用をブロックします。これを感知した時に、Clipchampはこれら機能へのアクセスを得るために、新しいウィンドウを開きます。no-popoutの設定はこのビヘイビアよりも優先され、Clipchampを利用可能な範囲で稼働させます。これによって、必要なメモリが増加したり、その他の事態が発生する可能性があります。
  • no-probe-reject – 入力ファイルが動画かどうか判断することができない場合には、通常そのファイルを拒否します。このオプションは全ての入力ファイルを受け入れ、動画でないファイルはそのままアップロードします。
  • no-thank-you – ありがとう画面が表示されないようにして、ウィンドウを即座に閉じます。このプロセスの間に何らかのエラーに遭遇した場合には、最後の画面が表示され続けます。
  • no-user-retry – ウェブカム録画が完了した後、ファイルのアップロード前に、ユーザーの確認と再試行のオプションを無効にします。このフラグを追加することで、ウェブカム録画が終了した後に、すぐにアップロードを始めることができます。ユーザーがウェブカム録画を繰り返す機会はなくなります。

experimental: Array<string>

Default value: []
Allowed values:
force-popout overlong-recording h264-hardware-acceleration

Clipchamp APIの実験的なビヘイビアを有効にします

  • force-popout – 埋め込まれるウェブサイトのDOMの中のiframeの中で稼働する場合でも、Clipchamp APIのインターフェイスを常に別の「ポップアップ」型のブラウザウィンドウで立ち上げます。no-popoutフラグ(enable)パラメーターと組み合わせて使用しないでください。
  • overlong-recording – 録画時間の制限なしでウェブカム/モバイルカメラの録画を許可します(Clipchamp APIでは通常制限がかかります)。camera.limitパラメーターに数値(秒数)を設定することで、意図的に録画時間を制限することは引き続き可能です。クライアントは、対応ブラウザ(現在はChrome・Opera・Firefox)でoverlong-recordingフラグだけを確実に設定する必要があります。
  • h264-hardware-acceleration – 対応プラットフォーム(現在x86ベースの ChromeOSまたはChromebook)でハードウェアアクセレーションされたH.264 ビデオエンコーディングを有効にします。このフラグはweb (デフォルト)preset および mp4(デフォルト)フォーマットだけに適用可能です。基盤となるハードウェアによっては、h264-hardware-acceleration フラグを設定することで、数倍のスピードアップが可能になります。クライアントは(主観的に)同じように感じられる出力品質で異なる圧縮率を体験することができるので、受け入れ可能な品質と圧縮率のトレードオフを見つけるためにcompressionパラメーターを調整することが推奨されます。

dropbox: object

Default value: undefined

Dropboxをアップロード先として使う場合の構成要素。

youtube: object

Default value: undefined

YouTubeをアップロード先として使う場合の構成要素。

onWebcamStatusChange(status): function

このコールバック関数は、statusがウェブカムや録画の新しいステータスを反映したStringである場合など、ウェブカムや携帯端末のカメラの録画に影響を与えるイベントの数によって作動します。:

  • capture_started – ウェブカムや携帯端末のカメラの電源が正常に入り、ビデオストリームを取得しています(録画はしていません)。
  • capture_ended – ウェブカムや携帯端末のカメラの電源が切られ、ビデオストリームはもう取得していません。
  • capture_failed – ウェブカムや携帯端末のカメラへのアクセスが失敗しました。
  • recording_running – ウェブカム録画が開始、または一時停止された後に再開されました。
  • recording_paused – ウェブカム録画が一時停止され、後で再開または終了することができます。
  • recording_finished – ウェブカム録画は終了しましたが、まだ処理を続けないと、アップロードしたり、onVideoCreatedのコールバックで利用したりできない場合があります。
  • recording_cancelled – ウェブカム録画はキャンセルされました。

ウェブカムや携帯端末のカメラのステータスを追跡する関数には、デスクトップ・ブラウザ(およびmobile-webcam-format-fallbackフラグがenableパラメーターの配列に設定されているAndroid上のChrome)が対応しています。

onMetadataAvailable(metadata): function

このコールバック関数は、ウェブカム録画や入力動画ファイルの分析が正常に行われた時に、すべてのウェブカム録画や入力動画ファイルに対して作動します。そのmetadataパラメーターは、以下のプロパティのオブジェクトです:

  • raw – 以下のプロパティのオブジェクトとなる未処理動画のメタデータ:
    • format – 動画コンテナフォーマットの情報
    • streams – 動画に含まれる動画・音声・字幕・データなどのストリームの配列

ユーザーがウェブカム録画を廃棄または繰り返した時には、このコールバックが様々な録画のメタデータにより複数回作動することにご注意ください。 batchフラグを使う時には、onMetadataAvailableも複数回作動し、この場合にはユーザーは複数の入力動画を選択できます。ベータ

onPreviewAvailable(imageBlob): function

onPreviewAvailableは、プレビュー画像が利用可能な時に呼び出されます。パラメーターはBlobインスタンスで、URLではなく、その画像が出力動画と一緒に指定されたアップロード先にアップロードされることはないことにご注意ください。また、すべてのシナリオがプレビュー画像を作成する訳ではなく、特に入力動画が壊れていたり、正しくないまたは不完全なメタデータを含んでいる場合には、作成されないことにご注意ください。ベータ

onUploadComplete(data): function

このコールバック関数は、単一のdataオブジェクトがアップロードされたファイルに関するメタ情報を含んでいる状態で、出力動画のアップロードが完了した時に作動します。ここには2つの共通するプロパティがあります:

  • filename – 元々の動画のファイル名
  • duration – 動画の長さ。状況によっては、この項目がない場合があります。

ここにも outputに特有のプロパティが数多くあります:

  • “youtube”出力を使う場合
    • kind – “youtube”
    • id – その動画ID
    • url – ビューのURL
    • embedHtml – 動画を埋め込むためにYouTubekから提供されるHTMLスニペット(提供される場合)。
  • If using output “azure”
    • kind – “azure”
    • blob – アップロードを保管する時に最終的に使われる実際のAzure BLOB名
  • “s3″出力を使う場合
    • kind – “s3”
    • key – アップロードを保管する時に最終的に使われる実際のAmazon S3オブジェクト
  • “gdrive”出力を使う場合
    • kind – “gdrive”
    • id – GoogleのファイルID
    • name – Google Driveに保管される時のファイル名。
    • url – ファイルのURL
    • folder – そのファイルが入るGoogleフォルダID、または、最上位の場合はルートフォルダ
  • “dropbox”出力を使う場合
    • kind – “dropbox”
    • id – Dropbox ファイル ID
    • name – Dropboxに保管される時のファイル名
    • path – Dropboxのファイルパス
    • link – Dropbox 上のファイルの共有用リンク(Clipchamp APIの設定で切り替える対応オプションが必要です。)
  • “blob”出力を使う場合
    • kind – “blob”
    • dataonVideoCreated が結果的になった何らかの配列

onVideoCreated(blob [,done [,fail [,notify]]]): function

出力がblobに設定されると、onVideoCreatedが呼び出され、出力動画BLOBが最初のパラメーターとして渡されます。このBLOBは、この関数が3つのうち1つのケースに従って定義される処理を終えるまで有効です:

  1. 関数のシグネチャが最低でも1つのdoneパラメーターを持ち、コールバックの完了または失敗が呼び出された場合
  2. promise(またはthenable)が返された場合には、それが解決または拒否されるのを待ちます。
  3. 関数がpromise以外の何かを返し、最低1つのdone-callbackパラメーターも特定しなかった場合、返されるとすぐに処理は即座に完了したと考えられます。

関数が処理を完了するまでは、出力ファイルは「アップデート中」と考えられます。進捗レポートを提供できるpromiseが返される場合(つまり、then関数が3つ目のコールバックを受け入れる場合)、または通知コールバックが使われる場合には、数字による進捗がアップロード完了率と解釈され、画面などに表示されます。(上に定義したように)処理が完了した後は、後ろ立てる保管内容が削除された可能性があるため、BLOBを信頼して利用することはもうできません。

onErrorOccurred(error): function

動画の録画・処理・アップロード、またはウェブカムやカメラでの録画の間にエラーが検知された時に、onErrorOccurredが呼び出されます。 error パラメーターは、必須であるtypeプロパティを持つオブジェクトで、以下のうちの1つである可能性があります:

  • ウェブカム(または携帯端末のカメラ)での録画中にエラーが発生した時のwebcam_processing;
  • 動画のアップロード前に、入力動画またはウェブカムやカメラでの録画が処理(トランスコードや圧縮)されている間にエラーが発生した時の、video_processing;
  • 指定された保管場所に処理された出力動画ファイルがアップロードされる時にエラーが発生した時のvideo_uploading;
  • エラーの原因がその他の何か、または不明である時の、 other_unknown;

2つ目の(オプションの)プロパティmessage は、人間が読めるエラーの説明を表示します。messageプロパティの文字列の値を使って、ユーザーに対してエラーメッセージを見せることができます。オプションのdetailsプロパティは、例外やエラーイベントなど、エラーに関するより詳しい技術情報を含む配列です。detailsプロパティの値を使えば、どんな問題に関してもClipchampサポートとやり取りすることができます。このonErrorOccurredコールバックは、同じ根本原因について複数回呼び出されることが時々あります。Clipchamp APIには、onErrorOccurredコールバックに報告されたインシデントの一部に対して補償を行うという規則があることにご注意ください。例えば、no-probe-reject フラグ(有効なパラメーターを参照 )は、ファイルから技術的メタデータを抽出することができなかった場合でも、動画トランスコーディングエンジンに動画ファイルを確実に受け渡します。

localization: object

Default value: undefined

ローカライゼーションについて利用可能な配列表。ウェブサイトの言語が英語でない場合には、これを使って、APIのユーザーに見える全ての要素を調節することができます。また、ユーザーに見せたくないテキストスニペットを空白にするためにこれらの文字列を使うこともできます。