すべてのプロダクト
Search
ドキュメントセンター

ApsaraVideo Media Processing:スナップショット ジョブの管理

最終更新日:Jan 12, 2025

ビデオ スナップショット機能を使用すると、ビデオの特定の時点において特定のサイズのスナップショットをキャプチャできます。スナップショットは、ビデオのサムネイル、スプライト、プログレスバーのサムネイルなどのシナリオで使用されます。スナップショット ジョブを使用すると、キャプチャするスナップショットの時点と間隔、スナップショットの数、スナップショットの種類、スナップショットを画像に合成するかどうかを指定できます。スナップショット ジョブは、ApsaraVideo Media Processing(MPS)コンソール、API、または SDK を使用して送信できます。このトピックでは、Java V2.0 用 MPS SDK を使用してスナップショット ジョブを送信およびクエリする方法の例を示します。

前提条件

SDK クライアントが初期化されていること。詳細については、「クライアントの初期化」をご参照ください。

スナップショット ジョブの送信

SubmitSnapshotJob オペレーションを呼び出して、スナップショット ジョブを送信できます。

説明
  • SDK を使用してスナップショット ジョブを送信する場合は、ファイルが置かれているファイルパスに対して URL エンコードを実行する必要があります。そうでない場合、スナップショット ジョブの送信に失敗します。詳細については、「URL エンコード」をご参照ください。

  • ファイル名は有効である必要があります。そうでない場合、ファイルが見つからず、スナップショット ジョブの送信に失敗します。詳細については、「パラメータの詳細」をご参照ください。

  • スナップショット ジョブの ID を記録することをお勧めします。これにより、後続のクエリ操作が容易になります。

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>説明</b> :
     * <p>AccessKey ID と AccessKey シークレットを使用してクライアントを初期化します。</p>
     * @return Client
     *
     * @throws Exception
     */
    public static com.aliyun.mts20140618.Client createClient() throws Exception {

        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必須。 ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数が設定されていることを確認してください。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必須。 ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        config.endpoint = "mts.cn-qingdao.aliyuncs.com";
        return new com.aliyun.mts20140618.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.mts20140618.Client client = Sample.createClient();
        com.aliyun.mts20140618.models.SubmitSnapshotJobRequest submitSnapshotJobRequest = new com.aliyun.mts20140618.models.SubmitSnapshotJobRequest()
                // ジョブ入力。
                .setInput("{\"Bucket\":\"example-bucket\",\"Location\":\"example-location\",\"Object\":\"example%2Ftest.flv\"}")
                // スナップショット ジョブの構成。
                .setSnapshotConfig("{\"OutputFile\":{\"Bucket\":\"example-001\",\"Location\":\"example-location\",\"Object\":\"{Count}.jpg\"},\"Time\":\"5\",\"Num\":\"10\",\"Interval\":\"20\"}")
                // ユーザー定義データ。
                .setUserData("testid-001")
                // MPS キューの ID。
                .setPipelineId("dd3dae411e704030b921e52698e5****");
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            // 必要に応じて、API オペレーションのレスポンスを表示するための独自のコードを記述します。
            client.submitSnapshotJobWithOptions(submitSnapshotJobRequest, runtime);
        } catch (TeaException error) {
            // 実際のビジネス シナリオでは、例外を慎重に処理し、プロジェクトで例外を無視しないでください。この例では、エラー メッセージは参照用にのみ表示されます。
            // エラー メッセージ。
            System.out.println(error.getMessage());
            // 対応するエラー診断ページの URL。
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 実際のビジネス シナリオでは、例外を慎重に処理し、プロジェクトで例外を無視しないでください。この例では、エラー メッセージは参照用にのみ表示されます。
            // エラー メッセージ。
            System.out.println(error.getMessage());
            // 対応するエラー診断ページの URL。
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }
    }
}

スナップショット ジョブの結果のクエリ

QuerySnapshotJobList オペレーションを呼び出して、スナップショット ジョブの結果をクエリできます。

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>説明</b> :
     * <p>AccessKey ID と AccessKey シークレットを使用してクライアントを初期化します。</p>
     * @return Client
     *
     * @throws Exception
     */
    public static com.aliyun.mts20140618.Client createClient() throws Exception {

        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必須。 ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数が設定されていることを確認してください。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必須。 ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        config.endpoint = "mts.cn-qingdao.aliyuncs.com";
        return new com.aliyun.mts20140618.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.mts20140618.Client client = Sample.createClient();
        com.aliyun.mts20140618.models.QuerySnapshotJobListRequest querySnapshotJobListRequest = new com.aliyun.mts20140618.models.QuerySnapshotJobListRequest()
                // スナップショット ジョブの ID。
                .setSnapshotJobIds("72dfa5e679ab4be9a3ed9974c736****")
                // クエリ対象の、スナップショット ジョブの状態。
                .setState("Snapshoting")
                // クエリ対象の、スナップショット ジョブが作成された時間範囲の開始。
                .setStartOfJobCreatedTimeRange("2014-01-10T12:00:00Z")
                // クエリ対象の、スナップショット ジョブが作成された時間範囲の終了。
                .setEndOfJobCreatedTimeRange("2014-01-12T12:00:00Z")
                // MPS キューの ID。
                .setPipelineId("b11c171cced04565b1f38f1ecc39****")
                // 新しい結果ページを取得するために次のリクエストで使用される、ページネーション トークン。
                .setNextPageToken("cc6cbef8e8d5481ca536f5d2a466****")
                // 各ページに返す最大エントリ数。
                .setMaximumPageSize(30L);
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            // 必要に応じて、API オペレーションのレスポンスを表示するための独自のコードを記述します。
            client.querySnapshotJobListWithOptions(querySnapshotJobListRequest, runtime);
        } catch (TeaException error) {
            // 実際のビジネス シナリオでは、例外を慎重に処理し、プロジェクトで例外を無視しないでください。この例では、エラー メッセージは参照用にのみ表示されます。
            // エラー メッセージ。
            System.out.println(error.getMessage());
            // 対応するエラー診断ページの URL。
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 実際のビジネス シナリオでは、例外を慎重に処理し、プロジェクトで例外を無視しないでください。この例では、エラー メッセージは参照用にのみ表示されます。
            // エラー メッセージ。
            System.out.println(error.getMessage());
            // 対応するエラー診断ページの URL。
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }
    }
}

参照