Soracom

Users

ドキュメント
Home ドキュメント Soracom Cloud Camera Services API の使いかた

API の使いかたについて

ソラカメ対応カメラでクラウドに 録画した映像SORACOM API (以下、API) を使って操作できます。

ここでは、ブラウザで Python を実行できる Colaboratory(以下、Colab) を使って、API の利用を体験できます。ソラコムが提供するサンプルコード は、Colab ノートブック (Jupyter Notebook) 形式です。

サンプルコードを実行する前に、以下のステップに沿ってソラカメ対応カメラが操作できることを確認し、Colab の利用準備を行ってください。サンプルコードの内容や詳細は、サンプルコードの GitHub リポジトリ を参照してください。

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

ステップ 1: サンプルコードを実行できる条件を確認する

サンプルコードを実行するには、以下の条件を満たす必要があります。

  • ソラカメ対応カメラでクラウドへの録画ができていること。
  • クラウド上に録画データがあること。
  • SORACOM API を利用する権限があること。
  • ソラカメ対応カメラごとに設定されている動画のエクスポート可能時間が残っていること。(動画のエクスポート可能時間を消費する API を利用する場合)

具体的には、ユーザーコンソールに ルートユーザーまたは SAM ユーザー でログインして、ソラカメ対応カメラが操作できることを確認します。

  1. ユーザーコンソールにルートユーザーまたは SAM ユーザーでログイン します。

    サンプルコードを実行するときにも、ルートユーザーまたは SAM ユーザーのログイン情報が必要です。サンプルコードを実行するときに入力するログイン情報を使って、ユーザーコンソールにログインしてください。

  2. ユーザーコンソールで ストリーミング再生 / 動画ダウンロード / 静止画ダウンロードができる ことを確認します。

    ユーザーコンソールで操作できない場合

    SAM ユーザーでログインして上記の操作を実行したときに、権限に関するメッセージが表示された場合は、SAM ユーザーの権限 が足りない可能性があります。権限について、ルートユーザーに確認してください。

  3. [デバイス管理] → 利用するソラカメ対応カメラ → [デバイス情報] タブの順にクリックして、動画のエクスポート可能時間[月あたりの動画のエクスポート可能時間][今月の消費時間]、および [今月の残り時間] を確認します。

    特に [今月の残り時間] が 00:00:00 になると、一部の操作が制限されます。

動画のエクスポート可能時間の消費時間が 72 時間を超えると課金が発生します

サンプルコードを実行した結果、[今月の消費時間] が 72 時間を超えると課金が発生します。料金について詳しくは、Soracom Cloud Camera Services ソラカメの 料金について を参照してください。

ステップ 2: Colab の利用準備をする

Colab を使うために、Google アカウントでログインします。

  1. Colab にアクセスして [ログイン] をクリックし、Google アカウントのメールアドレスとパスワードを入力して、Google アカウントにログインします。

  2. 「Colaboratory へようこそ」 をクリックします

    「Colaboratory へようこそ」というノートブックが表示されます。

    • 上記の画面を誤って閉じてしまった場合は、[ファイル][ノートブックを開く] の順にクリックすると、再表示できます。

    • 「Colaboratory へようこそ」が表示されない場合は、https://colab.research.google.com/notebooks/intro.ipynb にアクセスします。

  3. 「はじめに」のコードセルにマウスポインターを合わせて [▶] をクリックします。

    正しく実行できると、ノートブックにリソースが割り当てられ、実行結果 (86400) がコードセルの下に表示されます。

  4. [RAM ディスク] をクリックします。

    割り当てられたリソース (システム RAM とディスク) が表示されます。

    実行結果とリソースが確認できれば、Colab の利用準備は完了です。

ステップ 3: 実行するサンプルコードを Colab で開く

ソラコムが提供するサンプルコードを Colab で開く手順を説明します。

  1. 体験する内容を GitHub リポジトリ「コンテンツ」 で確認します。

    • ガイドページ: コンテンツの体験方法を説明したページへのリンクです。
    • サンプルコード: Colab で開く Jupyter Notebook (ipynb) があるフォルダへのリンクです。
    • : サンプルコードを Colab で開くボタンです。
  2. 体験する内容のガイドページか、サンプルコードにある Open In Colab Icon アイコンをクリックします。

    Colab で体験するノートブック (ipynb) が表示されれば準備は完了です。

    Colab からノートブック (ipynb) ファイルを開けます。

    1. [ファイル][ノートブックを開く] の順にクリックします。

    2. [GitHub] をクリックして、サンプルコードの GitHub リポジトリ URL https://github.com/soracom-labs/sora-cam-api-examples/ を入力して [] アイコンをクリックします。

    3. 体験するノートブック (ipynb) ファイル、画像の場合は object-detection-with-event-image/api-examples-object-detection-with-event-image.ipynb[] アイコンをクリックして、ノートブックを開きます。

ステップ 4: 実際に API を使ったサンプルコードを実行する

準備がすべて終了したら、体験するサンプルコードのガイドページを参照し、ガイドページに沿って体験してください。

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

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

(参考) Colab 以外で実行する場合

最後に参考として、Colab 以外で実行する場合の簡単な Tips を紹介します。

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

GitHub の soracom-labs / sora-cam-python-client を利用する

サンプルコードは、Colab 固有の表記をしている部分があります。これはたとえば、クラウド環境の FaaS で実行する場合には不要な部分です。 一方で、すべてを作っていくのも手間がかかる作業となるため、既存のツールを利用して短縮するのもひとつの手段です。

sora-cam-python-client を使うことで、ソラカメ API の呼び出し部分を作り込みすることなく、API を利用したシステムの開発を始められます。