> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services/rtsp-simulator.md).

# RTSP シミュレーター

アップロードした動画ファイルをループする RTSP ソースとしてストリーミングし、カメラなしで推論パイプラインをテストします。

RTSP Simulatorは、アップロードした動画ファイルをライブRTSPストリームに変換するエッジコンテナサービスです。物理カメラを設置する前にデバイス上で推論パイプラインを構築してテストしたり、既知のクリップをWorkflowに対して再生したりするために使用します。

次の形式の `.mp4` ファイルをWebインターフェースまたはREST APIからアップロードするか、Deployment Managerからアップロードします。サービスはファイルをRTSP互換形式にトランスコードし、停止するまで連続ループで配信します。

{% hint style="info" %}
RTSP SimulatorはEnterpriseのお客様のみご利用いただけます。 [詳しくはRoboflowの営業チームに](https://roboflow.com/sales) お問い合わせください。
{% endhint %}

## 接続情報

次の `<device-ip>` を、Deployment Managerのデバイスページに表示されているIPアドレスに置き換えてください。

<table data-search="false"><thead><tr><th>用途</th><th>アドレス</th></tr></thead><tbody><tr><td>RTSPストリーム</td><td><code>rtsp://&#x3C;device-ip>:8554/stream</code></td></tr><tr><td>Web UI、REST API、Swaggerドキュメント</td><td><code>http://&#x3C;device-ip>:8080</code></td></tr></tbody></table>

<table data-search="false"><thead><tr><th>ポート</th><th>プロトコル</th><th>用途</th></tr></thead><tbody><tr><td>8080</td><td>HTTP</td><td>Web UI、REST API、Swaggerドキュメント（ <code>/docs</code></td></tr><tr><td>8554</td><td>RTSP（TCP）</td><td>動画ストリームの出力。UDPトランスポートは無効です。UDPを優先するクライアントは、TCPインターリーブ方式に切り替えて接続します。</td></tr></tbody></table>

複数のクライアントが同時にストリームを読み取ることができます。

## 動画形式

Web UI、CLI、APIで受け付けるのは `.mp4` ファイルのみです。アップロードしたファイルは、あらゆるRTSPクライアントでストリームを再生できるよう自動的にトランスコードされます。

* コーデック：H.264、Baselineプロファイル
* ピクセル形式：yuv420p
* 音声：削除（動画のみ）
* 最大ファイルサイズ：デフォルトで5 GB

## Roboflowの動画を使用する

デバイスのローカルネットワークにアクセスできない場合は、Deployment Managerから動画を設定します。デバイスが動画をダウンロードしてストリーミングします。

{% stepper %}
{% step %}

## ［Settings］を開く

デバイスの［Configuration］タブで、RTSP Simulatorカードの［Configure］（歯車アイコン）を選択します。
{% endstep %}

{% step %}

## アップロード

［Video source］で［Roboflow video］を選択し、［Upload Video］を選択して、 `.mp4` または `.mov` ファイルを選択します。動画はWorkspaceのAsset Libraryに保存されます。
{% endstep %}

{% step %}

## 保存

必要に応じて変換とストリーミングの設定を変更します。サイトからRoboflowへの接続にSecure Gatewayを使用している場合は、［Secure Gateway (optional)］にそのアドレスを入力します。ウィンドウ内の［Save Configuration］を選択し、次に［Configuration］タブの［Save Configuration］を選択します。デバイスに新しい設定が適用されると、RTSP Simulatorサービスが再起動し、動画をダウンロードしてストリーミングを開始します。
{% endstep %}
{% endstepper %}

動画を設定し、Streamの配信先をシミュレーターに一度に指定するには、 [［Add Stream］フォームからテスト動画を](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/stream-a-test-video.md) ストリーミングします。デバイスにシミュレーターがない場合は、これによってシミュレーターも追加されます。

カードには動画名、RTSP URL、ダウンロードとストリーミングの状態が表示されます。Roboflowの動画が設定されている間は、ローカルWeb UIに「Roboflowから管理」と表示され、ローカルWeb UIとCLIの操作がロックされます。また、 `/upload`, `/play`, `/stop`, `/delete`、および `POST /stream-settings` は次を返します `409`。ローカルアップロードに戻すには、「ローカルアップロード」を選択して保存します。

## Webインターフェースの使用

ブラウザで `http://<device-ip>:8080` を開きます。

{% stepper %}
{% step %}

## アップロード

拡張子が `.mp4` のファイルをページにドラッグします。ファイルがアップロードされ、ストリーミング形式に変換されます。
{% endstep %}

{% step %}

## 再生

「再生」を選択すると、ストリーミングが開始されます。動画は無期限にループ再生され、RTSPサーバーに配信されます。
{% endstep %}

{% step %}

## 接続

推論パイプライン、Deployment Managerのストリーム、または任意のRTSPクライアントの接続先を次のアドレスに設定します： `rtsp://<device-ip>:8554/stream`.
{% endstep %}

{% step %}

## 停止

「停止」を選択すると、ストリームが終了し、アップロードされた動画が削除されます。
{% endstep %}
{% endstepper %}

デプロイでシミュレートされたストリームを使用するには、カメラと同じ方法でデバイスにストリームソースとして追加します。以下を参照してください： [ストリームの追加](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/add-a-stream.md).

## CLIの使用

ヘッドレス環境やSSHのみでアクセスする場合は、 `rtsp-cli` ツールを使用すると、デバイス上で対話型のターミナルインターフェースを利用できます。

```bash
docker exec -it rtsp-simulator rtsp-cli
```

Web UIを使用せずに動画をインポートするには、まず入力ディレクトリに動画をコピーし、CLIを起動して次のキーを押します： `I`.

```bash
scp video.mp4 user@<device-ip>:/var/lib/rfdm/rtsp-simulator/data/input/
```

<table data-search="false"><thead><tr><th>キー</th><th>コマンド</th><th>説明</th></tr></thead><tbody><tr><td><code>I</code></td><td>インポート</td><td>次のディレクトリから動画を選択して変換： <code>/data/input/</code></td></tr><tr><td><code>P</code></td><td>再生</td><td>RTSPストリーミングを開始</td></tr><tr><td><code>S</code></td><td>停止</td><td>ストリーミングを停止し、変換済みファイルを削除</td></tr><tr><td><code>D</code></td><td>削除</td><td>動画ファイルを削除</td></tr><tr><td><code>C</code></td><td>設定</td><td>ストリーム設定（ビットレート、バッファ、遅延）を調整</td></tr><tr><td><code>R</code></td><td>更新</td><td>ステータス表示を更新</td></tr><tr><td><code>Q</code></td><td>終了</td><td>CLIを終了</td></tr></tbody></table>

## ストリームのテスト

任意のRTSPプレーヤーで接続し、ストリームが配信されていることを確認します。

{% tabs %}
{% tab title="VLC" %}

```bash
vlc rtsp://<device-ip>:8554/stream
```

{% endtab %}

{% tab title="ffplay" %}
ストリームはTCPのみで配信されるため、ffplayが最初にUDPを試すのではなく、TCPトランスポートを強制してください。

```bash
ffplay -rtsp_transport tcp rtsp://<device-ip>:8554/stream
```

{% endtab %}
{% endtabs %}

## HTTP API

すべてのエンドポイントはJSONを返します。対話型のSwaggerドキュメントは `http://<device-ip>:8080/docs`で提供されています。すべてのデバイス上のサービスAPIに共通するルールについては、 [サービス](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services.md#using-the-apis) を参照してください。

{% hint style="warning" %}
このAPIには認証がなく、実行中のストリームの停止やアップロード済み動画の削除が可能です。ポート8080にアクセスできる相手は誰でも、これらの操作を実行できます。
{% endhint %}

### 一般的なフロー

動画を `/upload`でアップロードし、 `/play`でストリームを開始し、 `/status`で確認して、 `/stop`.

{% hint style="warning" %}
で停止します。 `rtsp_url` は、 `/play` および `/status` が返すURLで、常に `localhost`を指定しています。これは、サービスが自身の視点からURLを返すためです。このURLをそのまま使用できるのは、デバイス上で動作するクライアントだけです。それ以外の場合は、デバイスのアドレスに置き換えてください。 `rtsp://<device-ip>:8554/stream`.

ポートは `RTSP_PORT`で指定され、デフォルトは `8554` ですが、デバイスごとに設定できます。デフォルト値を前提とせず、 `rtsp_port` を `/info` から取得してください。
{% endhint %}

`/stop` は、ディスク容量を確保するために元のファイルと変換済みファイルの両方も削除します。そのため、次に `/play`.

### アップロード

を実行する前に、再度アップロードする必要があります。対象は `.mp4` が受け付けられ、アップロード開始前に実行中のストリームが停止されます。省略可能な `settings` 部分は、トランスコード時に適用される変換設定を含むJSON文字列です。設定は変換後のファイルに反映されるため、後から変更するには再アップロードが必要です。

{% openapi src="/files/1b5e8ca9ba76ea921d2ed73ce91075adad63bc9c" path="/upload" method="post" %}
[edge-rtsp-simulator.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-1608d6873191fab7e4d614a21aa77a56bab11279%2Fedge-rtsp-simulator.yaml?alt=media)
{% endopenapi %}

### ストリーミング

{% openapi src="/files/1b5e8ca9ba76ea921d2ed73ce91075adad63bc9c" path="/play" method="post" %}
[edge-rtsp-simulator.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-1608d6873191fab7e4d614a21aa77a56bab11279%2Fedge-rtsp-simulator.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/1b5e8ca9ba76ea921d2ed73ce91075adad63bc9c" path="/stop" method="post" %}
[edge-rtsp-simulator.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-1608d6873191fab7e4d614a21aa77a56bab11279%2Fedge-rtsp-simulator.yaml?alt=media)
{% endopenapi %}

`/delete` は、ストリームが実行中でなくても動画ファイルを削除します。実行中の場合は、まずストリームを停止します。

{% openapi src="/files/1b5e8ca9ba76ea921d2ed73ce91075adad63bc9c" path="/delete" method="post" %}
[edge-rtsp-simulator.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-1608d6873191fab7e4d614a21aa77a56bab11279%2Fedge-rtsp-simulator.yaml?alt=media)
{% endopenapi %}

### ステータス

`streaming` は、 `components.mediamtx.healthy` （ストリーミングサーバー）と `components.ffmpeg_process.running` （トランスコードおよび配信プロセス）が両方とも true の場合に true になります。 `components.stream` の項目は、この判定条件には含まれません。 `components.stream.source_ready` は起動中に一時的に false になることがありますが、 `streaming` がすでに true になっていても正常です。詳細な状態を確認すると、ストリームの障害箇所をすばやく特定できます。何かを再起動する前に、 `components` を確認して、どの部分が正常でないかを把握してください。

{% openapi src="/files/1b5e8ca9ba76ea921d2ed73ce91075adad63bc9c" path="/status" method="get" %}
[edge-rtsp-simulator.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-1608d6873191fab7e4d614a21aa77a56bab11279%2Fedge-rtsp-simulator.yaml?alt=media)
{% endopenapi %}

`/info` には、空きディスク容量や最大アップロードサイズなど、サービスの稼働時の上限が報告されます。大容量ファイルを送信する前に確認しておくとよいでしょう。

{% openapi src="/files/1b5e8ca9ba76ea921d2ed73ce91075adad63bc9c" path="/info" method="get" %}
[edge-rtsp-simulator.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-1608d6873191fab7e4d614a21aa77a56bab11279%2Fedge-rtsp-simulator.yaml?alt=media)
{% endopenapi %}

### ストリーム設定エンドポイント

再生設定はアップロード設定とは異なり、ストリーミング時に適用されます。再アップロードせずにセッション間で変更できます。設定の更新は、次回の `/play`で有効になり、現在実行中のストリームには適用されません。

{% openapi src="/files/1b5e8ca9ba76ea921d2ed73ce91075adad63bc9c" path="/stream-settings" method="get" %}
[edge-rtsp-simulator.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-1608d6873191fab7e4d614a21aa77a56bab11279%2Fedge-rtsp-simulator.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/1b5e8ca9ba76ea921d2ed73ce91075adad63bc9c" path="/stream-settings" method="post" %}
[edge-rtsp-simulator.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-1608d6873191fab7e4d614a21aa77a56bab11279%2Fedge-rtsp-simulator.yaml?alt=media)
{% endopenapi %}

## 構成

### 環境変数

デバイスの「Configuration」タブで、サービスにこれらの値を設定します。詳しくは、 [デバイス構成の更新](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/update-device-configuration.md).

<table data-search="false"><thead><tr><th>変数</th><th>デフォルト</th><th>説明</th></tr></thead><tbody><tr><td><code>MAX_FILE_SIZE</code></td><td><code>5368709120</code></td><td>最大アップロードサイズ（バイト単位、5 GB）</td></tr><tr><td><code>RTSP_PORT</code></td><td><code>8554</code></td><td>RTSPサーバーのポート</td></tr><tr><td><code>WEB_PORT</code></td><td><code>8080</code></td><td>Web UIとAPIのポート</td></tr><tr><td><code>LOG_LEVEL</code></td><td><code>INFO</code></td><td>ログの詳細度： <code>DEBUG</code>, <code>INFO</code>, <code>WARNING</code>、または <code>ERROR</code></td></tr></tbody></table>

### アップロード設定

これらの設定は変換時に適用されるため、変更するには動画の再アップロードが必要です。

<table data-search="false"><thead><tr><th>設定</th><th>デフォルト</th><th>説明</th></tr></thead><tbody><tr><td><code>target_fps</code></td><td>元の設定</td><td>目標フレームレート（1～120）。元の設定を維持するには省略します</td></tr><tr><td><code>crf_quality</code></td><td><code>23</code></td><td>品質レベル（0～51、18は高、23は中、28は低）</td></tr><tr><td><code>max_width</code></td><td>元の設定</td><td>ダウンスケーリング時の最大幅（320～7680）。元の設定を維持するには省略します</td></tr></tbody></table>

### ストリーム設定

これらの設定は再生時に適用され、ストリーミングセッションの間に CLI の設定メニューまたは `/stream-settings` エンドポイントから変更できます。

<table data-search="false"><thead><tr><th>設定</th><th>デフォルト</th><th>説明</th></tr></thead><tbody><tr><td><code>max_bitrate_kbps</code></td><td><code>5000</code></td><td>最大ビットレート（kbps、100～100,000）</td></tr><tr><td><code>buffer_size_kb</code></td><td><code>3000</code></td><td>バッファサイズ（KB、100～50,000）</td></tr><tr><td><code>max_delay_ms</code></td><td><code>500</code></td><td>最大遅延時間（ミリ秒、50～5,000）</td></tr></tbody></table>
