アップロード SDK には、ファイルリスト管理およびアップロード制御機能があります。 ファイルリスト管理では、ファイルの追加、削除、キャンセル、再開、ファイルリストの取得、およびファイルリストの削除ができます。 アップロード制御では、ファイルのアップロードの開始、停止、一時停止、および再開ができます。 SDK は、アップロード中にステータスと進行状況の変化をモニターするコールバックイベントを提供します。

アップロードのプロセス

[アップロード SDK の初期化] > [ファイルの選択] > [ファイルをリストに追加] > [アップロードの開始] > [完了イベントのアップロード]
  • アップロード SDK の初期化

    AccessKey とトークンを使用して、初期化中にアクセス許可を付与します。 クライアントに格納されている AccessKey のセキュリティを考慮し、AccessKey はテストにのみ使用して、トークンは運用環境で使用することを推奨します。 詳しくは、「開発者ガイド > ビデオファイルのアップロード > 概要」 をご参照ください。

  • ファイルの選択

    アップロードするローカルファイルを選択します。

  • ファイルをリストに追加

    addFile 関数を使用して、アップロードするすべてのファイルをリストに追加します。

  • アップロードの開始

    start 関数を呼び出して、アップロードプロセスを開始します。

  • 完了イベントのアップロード

    完了イベントには、OnUploadSucceed および OnUploadFailed があります。

概念と説明

  • マルチパートアップロードとステータス

    SDK はマルチパートアップロードモードを使用します。このモードでは、ステータスは 1 回の実行でのみ有効です。 特定の理由 (たとえば、シャットダウン、ブラウザページが閉じられたこと、アプリを終了したこと、アプリの異常終了など) が原因でアプリが終了した場合、ファイルを再度アップロードする必要があります。

  • 許可の有効期限

    トークンは一定の期間のみ有効です。 トークンの有効期限が切れると、アップロード処理は中断されます。自動的には再開されません。 アップロードを再開するには、バックエンドから新しいトークンを取得し、resumeUploadWithAuth 関数を呼び出します。

  • モバイル端末における 3G/4G ネットワークと Wi-Fi ネットワークの切り替え

    3G/4Gネットワークでのトラフィックの浪費を避けるため、アプリが 3G/4G ネットワークに切り替えたときに、自動的にネットワークを検出し、pause 関数を呼び出してアップロードを一時停止する必要があります。 アプリが Wi-Fi ネットワークが使用されていることを検出すると、resume 関数を呼び出してアップロードを再開します。

  • SDK が使用可能な端末は、次の 3 種類です。

    • HTML5: PC ブラウザーに統合することができます。 開発言語は JavaScript です。
    • iOS: iOS アプリに統合することができます。開発言語は Object-C です。
    • Android: Android アプリに統合することができます。開発言語は Java です。

機能

ファイルリストの管理
API 説明
addFile ファイルをリストに追加します。 ファイルは追加順にアップロードされます。
deleteFile リストからファイルを削除します。
cancelFile リスト内のファイルをキャンセルしますが、リストからファイルを削除しません。 この API を使用すると、このファイルのアップロードはスキップされます (JavaScript 版ではサポートされていません)。
resumeFile リストでキャンセルされたファイルのステータスを再開します (JavaScript 版ではサポートされていません)。 この API はアップロードの再開には使用されません。
listFiles リストを取得します。
clearFiles リストを消去します。 この API が使用されると、アップロードは停止し、アップロード中のファイルであってもファイルは消去されます (JavaScriptバージョンではサポートされていません)。
アップロードの制御
API 説明
start アップロードを開始します。
stop アップロードを停止します。
pause アップロードを一時停止します (JavaScript 版ではサポートされていません)。
resume アップロードを再開します (JavaScript 版ではサポートされていません)。
resumeUploadWithToken 既存のトークンの有効期限が切れた後、新しいトークンを使用してアップロードを再開します。
コールバックイベント
イベント 説明
OnUploadStarted このイベントは、各ファイルのアップロードが開始されたとき、トリガーされます。
OnUploadSucceed アップロードが成功したことを示します。
OnUploadFailed アップロードが失敗したことを示します。 ネットワークエラーまたはタイムアウトなどの再開可能なエラーが発生した場合は、ファイルのアップロードは自動的に再開します。 アップロードの認証情報が正しくない、またはファイルが存在しないなど、再開不可能なエラーが発生した場合は、ファイルのアップロードは失敗します。
OnUploadProgress アップロードの進行状況レポートです。 このイベントは、マルチパートのアップロードが成功したとき、トリガーされます。
OnUploadTokenExpired トークンがタイムアウトしたことを示します。 アップロードを再開するには、サーバーから新しいトークンを取得し、resumeUploadWithToken 関数を呼び出します。
OnUploadRetry このイベントは、アップロード中にステータスが正常から異常に切り替わるとき、トリガーされます。たとえば、ネットワークエラーまたはタイムアウトがあります (JavaScript 版ではサポートされていません)。
OnUploadRetryResume このイベントは、アップロード中にステータスが異常から正常に戻るとき、トリガーされます (JavaScript 版ではサポートされていません)。