Soracom

Users

ドキュメント
フィードバック
Home ドキュメント Soracom Cloud Camera Services API の使いかた

タイムラプス動画を作成する

カメラを設置した場所の状況や経過を確認する場合、クラウドに録画された映像を 再生 したり、画像を一覧表示 したりして確認すると思いますが、カメラの数や確認頻度が多いと大変な作業です。

たとえば、定点観察のような映像に変化が少ない場合は、すべての映像を再生して確認する方法では変化の差分に気づきにくいことがあります。また、1 時間ごとに 1 回確認するような場合は、すべての映像を再生する必要がないこともあります。

このような場合に、タイムラプス動画 (一定間隔で取得した静止画を繋ぎ合わせた動画) を作成すると、通常では視覚的に捉えにくい変化を、長時間の視聴をせずに短時間で確認できます。

ここでは、SORACOM API (以下、API) を使ったサンプルコードを実行することで、録画データから一定間隔で取得した静止画を元に、タイムラプス動画の作成を体験できます。サンプルコードは、Colaboratory(以下、Colab) を使って実行します。

Colaboratory はソラコムが提供するサービスではありません
  • Colaboratory の利用には Google アカウントが必要です。
  • ソラコムは、Colaboratory に関するサポートを行いません。
  • Colaboratory については、Colaboratory の運営会社へ お問い合わせ ください。
サンプルコードの利用について
  • サンプルコードでは、API を使って録画データを操作するため、クラウドに動画が保存 されている必要があります。
  • サンプルコードの実行には SORACOM ユーザーコンソールの ログイン情報 が必要です。
  • サンプルコードでは、実際に動画や静止画のエクスポートを行うため、動画のエクスポート可能時間 が消費されます。
  • サンプルコードは、API の使いかたを紹介することを目的として提供されています。SORACOM サポートではサポートを行いません。
  • サンプルコードを実行したことによる利用者自身、もしくは第三者が被った損害に対して、直接的、間接的を問わず、株式会社ソラコムは責任を負いかねます。
操作を始める前に準備が必要です (クリックして確認してください)

(1) サンプルコードを実行するための環境を準備する

ソラカメ対応カメラでクラウドに録画した映像を、SORACOM API を使って操作できることを確認してください。詳しくは、API の使いかたについて を参照してください。

準備完了

サンプルコード

このページで使用するサンプルコードです。

リンクをクリックして Colab で開いて、ガイドページに沿って体験してください。

警告が表示されることがあります

  • GitHub からサンプルコードを実行する際、「警告: このノートブックは Google が作成したものではありません。」と表示されることがあります。表示された内容を確認して、[このまま実行] をクリックしてください。

  • GitHub から実行したサンプルコードを修正して保存する際、「変更を保存できませんでした」と表示されることがあります。保存する場合には表示された内容を確認して、[ドライブにコピーを保存] をクリックしてください。ログインしている Google アカウントの Google ドライブ にノートブックのコピーが保存されます。

ステップ 1: サンプルコードの実行に必要なライブラリや定数を設定する

サンプルコード全体で利用するライブラリや関数、定数の定義を行います。ここで定義された内容は、他のコードセルでも利用できます。

  1. サンプルコードの [ステップ 1] のコードセルにマウスポインターを合わせて [▶] クリックします。

    実行結果に Python のバージョン (例: # ℹ️ Python Version = 3.10.11 (main, Apr 5 2023, 14:15:10) [GCC 9.4.0]) が表示されます。

ステップ 2: SORACOM API を使うための認証処理をする

SORACOM API を使うための認証処理を行います。ユーザーコンソールのログイン情報を入力するフォームに必要な情報を入力して、[Login] をクリックすると SORACOM API の認証処理が実行され、このステップ以降で SORACOM API が実行できます。

呼び出している SORACOM API

このステップでは、以下の SORACOM API を呼び出しています。

API説明
Auth:auth APIAPI アクセスの認証を行い、API キーと API トークンを発行する

  1. サンプルコードの [ステップ 2] の以下の項目を設定します。

    項目説明
    [endpoint_url]SORACOM API の日本カバレッジのエンドポイント (https://api.soracom.io/v1) を入力します。
    [login_type]

    SORACOM API を利用するユーザーの種別を選択します。具体的なログイン情報は、手順 3 で入力します。

    • Root User: ルートユーザーのログイン情報が分かる場合
    • SAM User: SAM ユーザーのログイン情報が分かる場合
    [use_mfa]

    多要素認証 (Multi-Factor Authentication: MFA) を有効化しているユーザーの場合はチェックします。

    具体的なワンタイムパスワード (Time-based One-Time Password: TOTP) 情報は、手順 3 で入力します。

  2. サンプルコードの [ステップ 2] のコードセルにマウスポインターを合わせて [▶] クリックします。

    実行結果にログイン情報の入力フォームが表示されます。

  3. ログイン情報を入力して、[Login] をクリックします。

    • 手順 2 の [login_type] で「Root User」を選択した場合は、ルートユーザーのメールアドレスとパスワードを入力します。

    • 手順 2 の [login_type] で「SAM User」を選択した場合は、SAM ユーザーが所属するオペレーターのオペレーター ID、SAM ユーザー名、パスワードを入力します。

    • 手順 2 の [use_mfa] をチェックした場合は、MFA 認証コードを入力します。

    正しい認証情報を入力していれば、# 🔑 API access has been authenticated 💯 と表示され、入力欄が初期化されます。

ステップ 3: カメラを 1 台選択する

ソラカメ対応カメラの一覧を取得し、そこからソラカメ対応カメラを 1 台選択します。このステップ以降では、ここで選択したソラカメ対応カメラがクラウドに保存した動画や画像に対して、API で操作を行います。

呼び出している SORACOM API

このステップでは、以下の SORACOM API を呼び出しています。

API説明
SoraCam:listSoraCamDevices APIソラカメ対応カメラの一覧を取得する
SoraCam:getSoraCamDevice APIソラカメ対応カメラの情報を取得する
SoraCam:getSoraCamDeviceExportUsage APIソラカメ対応カメラの静止画のエクスポート可能枚数や録画映像のエクスポート可能時間を取得する

  1. サンプルコードの [ステップ 3] のコードセルにマウスポインターを合わせて [▶] クリックします。

  2. 実行結果に表示された [📷 Camera List] をクリックします。

    1 行ごとに 1 台のソラカメ対応カメラの情報が、名前 / 状態 / ファームウェアバージョン / 製品名 / デバイス ID の順に表示されます。

  3. ソラカメ対応カメラを選択します。

    選択したソラカメ対応カメラの詳細情報 (JSON) と、選択したカメラのエクスポート可能時間 (JSON および 🔎 Time remaining of month = 72 hours 0 minutes 0 seconds) が表示されます。

    選択したカメラの詳細情報:

    選択したカメラのエクスポート可能時間:

    Time remaining of month が、選択したカメラの「今月の残り時間」です。72 hours 0 minutes 0 seconds と表示されている場合は、今月はあと 72 時間分の動画をエクスポートできます。このあとのステップで今月の残り時間を超えると、サンプルコードが動作しない可能性があります。必要に応じて、動画のエクスポート可能時間の上限を設定してください。詳しくは、動画のエクスポート可能時間の上限を設定する を参照してください。

ステップ 4: ストリーミング再生の開始時刻と終了時刻を設定する

このステップと次のステップでは、前のステップで選択したソラカメ対応カメラがクラウドに録画した動画を、ストリーミング再生します。Colab で動画を再生することで、クラウドに録画された動画を、API で操作できることを確認できます。

呼び出している SORACOM API

このステップでは、以下の SORACOM API を呼び出しています。

API説明
SoraCam:getSoraCamDeviceExportUsage APIソラカメ対応カメラの静止画のエクスポート可能枚数や録画映像のエクスポート可能時間を取得する

  1. サンプルコードの [ステップ 4] のコードセルにマウスポインターを合わせて [▶] クリックします。

    [Start date] などの入力欄が表示されます。

  2. 以下の項目を入力します。

    項目説明
    [Start date]開始日。例: 2023/05/02
    [Start time]開始時刻。例: 10:33:31
    [End date]終了日。例: 2023/05/02
    [End time]終了時刻。例: 10:38:31
    開始日時と終了日時を設定してください

    • 開始日時と終了日時の初期値は、どちらも実行した日時です。開始日時と終了日時を変更せずに [Time setting] をクリックすると、エラーが表示されます。

    • 開始日時から終了日時の間隔は、最大 900 秒 (15 分) です。

  3. [Time setting] をクリックします。

    最新映像をストリーミング再生することもできます

    最新映像を再生する場合は、開始日時と終了日時を設定せずに、[Real Time] をクリックします。[Start date]、[Start time]、[End date]、および [End time] は使用されません。

ステップ 5: 設定した開始時刻と終了時刻でストリーミング再生する

選択したソラカメ対応カメラの開始時刻と終了時刻の範囲の動画を、ストリーミング再生 します。指定した時間の分「動画のエクスポート可能時間」が消費されます。

呼び出している SORACOM API

このステップでは、以下の SORACOM API を呼び出しています。

API説明
SoraCam:getSoraCamDeviceStreamingVideo APIストリーミング映像 (最新映像 / 録画映像) をダウンロードするための情報を取得する
SoraCam:getSoraCamDeviceExportUsage APIソラカメ対応カメラの静止画のエクスポート可能枚数や録画映像のエクスポート可能時間を取得する

  1. サンプルコードの [ステップ 5] のコードセルにマウスポインターを合わせて [▶] クリックします。

    ストリーミング再生用の URL が発行され、動画の再生が始まります。

    最新映像をストリーミング再生することもできます

    最新映像をストリーミング再生する場合は、ℹ️ Real-time video is playing. と表示されます。

    URL には有効期限が設定されているため一定時間で再生が停止します
    • ストリーミング再生用の URL には有効期限が設定されています。そのため、有効期限が経過してから再生バーを操作すると、動画は再生されません。
    • [Reload video] をクリックすると、ストリーミング再生が再開されます。「動画のエクスポート可能時間」が消費されます。
      • 開始日時と終了日時を設定して [Time setting] をクリックした場合は、[Reload video] をクリックすると、設定した開始時間と終了時間の動画をもう一度再生します。
      • 最新映像を再生した場合は、[Reload video] をクリックすると、クリックした時点の最新の動画が再生されます。

ステップ 6: 静止画ダウンロードの開始時刻と間隔を設定する

このステップと次のステップでは、選択したソラカメ対応カメラがクラウドに録画した映像から静止画を切り出してダウンロードします。

呼び出している SORACOM API

このステップでは、以下の SORACOM API を呼び出しています。

API説明
SoraCam:getSoraCamDeviceExportUsage APIソラカメ対応カメラの静止画のエクスポート可能枚数や録画映像のエクスポート可能時間を取得する

  1. サンプルコードの [ステップ 6] のコードセルにマウスポインターを合わせて [▶] クリックします。

    [Start date] などの入力欄が表示されます。

  2. 以下の項目を入力します。

    項目説明
    [Start date]開始日。例: 2023/06/29
    [Start time]開始時刻。例: 12:28:10
    [Interval]間隔。例: -1 Hour
    単位として Minute (分) / Hour (時間) / Day (日) / Week (週) を選択する
    [Fetch Count]一度に取得する枚数。例: 4
    間隔の指定について
    • 間隔には 0 は設定できません。0 を指定して [Time setting] をクリックすると、エラーが表示されます。
    • 間隔にマイナス値を指定すると、開始日から過去に遡って静止画を取得します。

  3. [Time setting] をクリックします。

    • # interval = -1.0 と # interval_unit = Hour は静止画がダウンロードされる間隔です。-1.0 と Hour の場合は開始日から過去に向かって 1 時間の間隔でダウンロードします。
    • # list_count = 4 は、次のステップでダウンロードされる静止画ファイルの枚数です。過去に向かって 1 時間の間隔で 4 枚ダウンロードする場合は、開始日時の 3 時間前の静止画から開始日時の静止画まであわせて 4 枚がダウンロードされます。

ステップ 7: 設定した開始時刻と間隔で静止画をダウンロードする

選択したソラカメ対応カメラがクラウドへ録画した映像から、ステップ 6 で指定した内容で 静止画をダウンロード します。ダウンロード先は Colab 内です。ダウンロードする静止画の枚数分「動画のエクスポート可能時間」が消費されます。

呼び出している SORACOM API

このステップでは、以下の SORACOM API を呼び出しています。

API説明
SoraCam:exportSoraCamDeviceRecordedImage APIクラウドに保存された録画映像から静止画をエクスポートする処理を開始する
SoraCam:getSoraCamDeviceExportedImage APIクラウドに保存された録画映像から静止画をエクスポートする処理の現在の状況を取得する

  1. サンプルコードの [ステップ 7] の以下の項目を設定します。

    項目説明
    [use_wide_angle_correction]ソラカメ対応カメラのレンズによるゆがみを補正する場合は、チェックを入れます。

  2. サンプルコードの [ステップ 7] のコードセルにマウスポインターを合わせて [▶] クリックします。

    実行結果に静止画のエクスポートの状況が表示されます。

    静止画のエクスポートは実行されますが、すぐにはダウンロードできません。サンプルコードでは、ある程度の時間待つことと、エクスポートされた静止画がダウンロードできるようになったことを確認する動作を繰り返します。

    1 つの静止画がダウンロードできるようになると、静止画ファイル (jpg ファイル) が Colab 内にダウンロードされます。

    静止画を複数枚ダウンロードする場合は、静止画のダウンロードに有効期限があるため、静止画ファイルごとにエクスポートとダウンロードを繰り返します。

  3. [] をクリックします。

    「export_images」ディレクトリと、ダウンロードされた画像ファイルが表示されます。

ステップ 8: ダウンロードした静止画を表示して確認する

前のステップで Colab 内にダウンロードした静止画を表示して確認します。画像は一覧表示されます。

  1. サンプルコードの [ステップ 8] のコードセルにマウスポインターを合わせて [▶] クリックします。

    実行結果に静止画の一覧が表示されます。

    画像が正しく表示されない場合は [] をクリックして画像ファイルを直接確認してください。

ステップ 9: ダウンロードした静止画でタイムラプス動画を作成する

  1. サンプルコードの [ステップ 9] の以下の項目を設定します。

    項目説明
    [video_fps]

    作成するタイムラプス動画の FPS を選択します。

    • 0: 1 秒間にすべての静止画が再生される動画が作成されます。
    • 1: 1 秒間に 1 枚の静止画が再生される動画が作成されます。
    • 30: 1 秒間に 30 枚の静止画が再生される動画が作成されます。

  2. サンプルコードの [ステップ 9] のコードセルにマウスポインターを合わせて [▶] クリックします。

    実行結果にタイムラプス動画の作成状況が表示されます。

    作成が完了すると、タイムラプス動画ファイルが Colab 内に保存されます。

  3. [] をクリックします。

    「time_lapse_video」ディレクトリと、タイムラプス動画ファイルが表示されます。

ステップ 10: ローカル環境にダウンロードするディレクトリを選択する

これまでのステップで Colab 内に保存したファイルを、ローカル環境にダウンロードするための準備として、作成したタイムラプス動画が保存されているディレクトリを選択します。

  1. サンプルコードの [ステップ 10] のコードセルにマウスポインターを合わせて [▶] クリックします。

  2. [🗂️ Directories] をクリックして、「/content/time_lapse_video」を選択します。

    # 📄 File List (ディレクトリ内のファイル一覧) が表示されます。

ステップ 11: 選択したディレクトリをローカル環境にダウンロードする

Colab 内に保存したファイルしを zip 形式で圧縮して、ローカル環境にダウンロードします。

  1. サンプルコードの [ステップ 11] のコードセルにマウスポインターを合わせて [▶] クリックします。

    前のステップで選択したディレクトリを zip 形式で圧縮したファイルがダウンロードされます。

  2. ローカル環境にダウンロードされた zip 形式で圧縮したファイルを展開して、タイムラプス動画ファイルが再生できることを確認します。

    上記の例では、_20230629_125837_archive_.zip という zip 形式のファイルがローカルにダウンロードされます。

    Colab 内のファイルとローカル環境のファイルを比較してください

    「/content/__zip_work/」ディレクトリのすべてのファイルがローカル環境にダウンロードされていれば、実行は成功しています。

    上記の例では、mp4 ファイルが 作成されたタイムラプス動画ファイルです。

    なお、ブラウザの設定で複数ファイルのダウンロードが許可されていない場合は、上記のような表示が出ることがあります。表示内容を確認し、[許可する] をクリックして、ダウンロードを続行してください。

まとめ

SORACOM API を使って、ユーザーコンソールでは実現できない タイムラプス動画を作成する サンプルコードを Colab で体験できました。ステップごとの解説とサンプルコードを参考に、実際のユースケースでも API を活用して、新しい使いかたや自動化、省力化にチャレンジしてください。

(参考) サンプルコードを変更する場合

最後に参考として、サンプルコードを変更して実行する場合の簡単な Tips を紹介します。

サンプルコードの利用について
  • サンプルコードは、API の使いかたを紹介することを目的として提供されています。SORACOM サポートではサポートを行いません。
  • サンプルコードを実行したことによる利用者自身、もしくは第三者が被った損害に対して、直接的、間接的を問わず、株式会社ソラコムは責任を負いかねます。

任意の FPS でタイムラプス動画を作成する

サンプルコードでは、作成するタイムラプス動画の FPS を選択式にしています。FPS を大きくすると作成された動画が早送りのよう再生されたかと思います。 サンプルコードの create_time_lapse_video() を呼び出す際、引数 fps に任意の値を渡すことで、指定した FPS でタイムラプス動画を作成できます。

# Create a time-lapse video
def create_time_lapse_video(path: str, name: str, fps: int) -> None:
    print()
    print('# path = ', path)
    print('# name = ', name)

    # Get file list
    file_list = glob.glob(os.path.join(path, name), recursive=True)
    file_list.sort()

    print('# 🗃️ file list = ', file_list)
    print('# file count = ', len(file_list))

    # Automatically correct if FPS is required to be more than 1.
    if fps <= 0:
        fps = len(file_list)

    print('# fps = ', fps)
    print()

API トークンの有効期限を変更する

サンプルコードでは、API トークンの有効期限を「3600 秒 (1 時間)」に設定しています。有効期限を変更する場合には authenticate_user() を呼び出す際、引数 timeout に有効期限を設定してください。有効期限に指定できる範囲については、Auth:auth API を参照してください。

# /auth
# Authenticate API access and issue API key and API token
# https://users.soracom.io/ja-jp/tools/api/reference/#/Auth/auth
def authenticate_user(self, email: str, password: str, opid: str, name: str, mfa_code: str = None, timeout: int = 3600) -> APIResult:
    api_path = '/auth/'
    url = merge_url(self.endpoint_url, api_path)
    headers = {'Content-Type': 'application/json'}

    # authentication uses the following values
    # Root: email, password
    # SAM: opid, name, password
    data = dict()

    # prepare the value for the Root case
    if email != None and email != '':
        if password != None and password != '':
            data['email'] = email
            data['password'] = password

    # prepare the value for the SAM case
    # If both are valid, SAM is preferred
    if opid != None and opid != '':
        if name != None and name != '':
            if password != None and password != '':
                data['operatorId'] = opid
                data['userName'] = name
                data['password'] = password

    # set the API key expiration time (Default 1 hour)
    data['tokenTimeoutSeconds'] = timeout

    # MFA Authentication Code
    if mfa_code != None and mfa_code != '':
        data['mfaOTPCode'] = mfa_code

    # Send Request
    return send_post_request(url, headers=headers, data=data)
© 2015-2024 SORACOM
最終更新日: 2024-10-28
API の使いかた : 15 分を超える動画をダウンロードする
API の使いかた : イベント画像に映っている物体を検出する
会社概要 プレスルーム お問い合わせ プライバシー 商標 特定商取引法 契約約款
Facebook Twitter Speaker Deck YouTube Blog