ミモライブ
  • ユーザーマニュアル
最新版をダウンロードしてください...
無料で探索

エンドポイント

目次

❗

Claude、Codex、Github Copilot、その他のコーディングAIをお使いですか？

をご覧ください。 ミモライブAPIリファレンス. .お気に入りのAIコーディングエージェントにドロップすれば、すぐにmimoLive APIを正しく使用できます。.

一般

があります。 エーピーアイを有効にすると、"http://localhost:8989/api/v1 "で利用できる。これはベースとなる URL すべてのメソッドの前に付けなければならない URL 下記の通り。

もし、あるリソースが初回起動後に導入された場合 HTTP エーピーアイメソッドには 以降利用可能 情報を提供する。

/

サポートされている方法"ゲット"
documents "にある開いている文書のリストにリダイレクトする。

/デバイス

サポートされているメソッド： 「GET」
ホストシステム上で現在利用可能な デバイス（映像および音声）のリストを返します。各デバイスには、接続状態、タイプフラグ、および（音声デバイスの場合）利用可能な入力チャンネルが含まれます。

/デバイス/(デバイスID)

サポートされているメソッド: "GET"
"(DeviceID) "で指定されたデバイスの名前とプロパティを含む詳細を返します。

{
  "type": "devices",
  "id": "BuiltInMicrophoneDevice",
  "attributes": {
    "name": "MacBook Pro Microphone",
    "connected": true,
    "video": false,
    "audio": true,
    "device-type": "com.boinx.devicetype.avfoundation",
    "tally-state": "off",
    "input-channels": ["Ch. 1"]
  }
}

The input-channels array lists the names of all available input channels on the audio device. Use these names when setting the channel-map on a source.

ドキュメント

ドキュメントのクエリ

/ドキュメント

サポートされている方法"ゲット"
開いているドキュメントのリストを返す。返されたオブジェクトがどのような情報を含むかについては、documentsデータ型を参照してください。

/ドキュメント/(DocumentID)

サポートされている方法"ゲット”, "プット"
GETは、“(DocumentID) ”で指定された単一のドキュメントを返します。レスポンスのincludedセクションには、このドキュメントで使用されているすべての「レイヤー」オブジェクトと、このドキュメントに含まれるすべての「ソース」オブジェクトも返されます（サイドローディング）。返されるデータの詳細については、ドキュメントのデータ型を参照してください。.

PUTは、番組出力マスターボリュームや番組メタデータ（タイトル、作者、解像度、フレームレート、サンプルレートなど）といったドキュメントレベルのプロパティを更新します。変更したいフィールドだけを送信します。.

/ドキュメント/(DocumentID)/プログラムアウト

サポートされている方法"ゲット"
(DocumentID) "で指定されたドキュメントが現在生成しているプログラム出力。
ソースプレビューと同じパラメーターを取る。

ドキュメントアクション

/ドキュメント/(DocumentID)/setLive

サポートされている方法"ゲット""ポスト"
ショー/ドキュメントを開始し、関連するすべてのイベントをトリガーする。すでに実行されているドキュメントに対してこれを呼び出してもエラーにはなりません。更新されたドキュメントオブジェクトが返されます。

/ドキュメント/(DocumentID)/setOff

サポートされている方法"ゲット""ポスト"
ショー/ドキュメントを停止する。すでに停止しているショーに対してこれを呼び出してもエラーにはなりません。更新されたドキュメント・オブジェクトが返されます。

このメソッドを呼び出した後も、ドキュメントが実行され続けることを決定できるため、返されるレイヤーオブジェクトの状態は「オフ」ではなく「シャットダウン」になるかもしれません。

/ドキュメント/(DocumentID)/トグルライブ

サポートされている方法"ゲット""ポスト"
ショー／ドキュメントのライブ／オフを切り替える。

レイヤー

レイヤーの作成

POST /documents/(DocumentID)/layers

レイヤーのテンプレートから新しいレイヤーを作成し、ドキュメントのレイヤースタックに挿入します。レイヤー識別子でテンプレートを指定し、オプションでスタック内の位置、名前、初期入力値を設定します。新しく作成されたレイヤーオブジェクトを返します。

curl -X POST "http://localhost:8989/api/v1/documents/(DocumentID)/layers" \
  -H "Content-Type: application/json" \
  -d '{
    "layer-identifier": "com.boinx.mimoLive.layer.lowerthird",
    "index": 4,
    "name": "My Lower Third"
  }'

レイヤーのクエリ

GET /documents/(DocumentID)/layers

(DocumentID) "で指定されたドキュメントのレイヤーのリストを返す。返されるオブジェクトについては、layers データ型を参照してください。

/ドキュメント/(DocumentID)/レイヤー/(LayerID)

サポートされている方法"ゲット", "プット"
(DocumentID) "で指定されたドキュメント内の、"(LayerID) "で指定された単一のレイヤーを返します。レスポンスの "included" セクションでは、このレイヤーに関連するすべての "variant" オブジェクトも返されます (サイドローディング)。返されるデータの詳細については、レイヤーのデータタイプを参照してください。レイヤーのエンドポイントからの "input-value" は、関連する "liveVariant" variant の "input-value" を反映することに注意してください。

レイヤーの変更

サポートされている方法"ゲット", "プット"
レイヤー名、オーディオ・ボリューム、入力値を設定するには、".プット「リクエストを JSON エンコードされたオブジェクトをレイヤーのエンドポイントに渡す。あるいは、"ゲット「リクエストに JSON データを URL を"?update="というキーで指定する。この場合 JSON データは URL エンコードされている。

変更したくない値は、単に JSON データ例

{
    "name": "New name of the Layer",
    "volume": 0.5,
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

値を更新した後、mimoLiveは更新されたレイヤーオブジェクトで応答します。すべての値が即座に適用されるわけではないこと、または別のレンダリングサイクルの後にのみ効果を発揮する可能性があることに留意してください。

注意："volume "属性はmimoLive 5.6で追加されたもので、以前のバージョンやレイヤーにボリュームコントロールがない場合は無視されます。値は(0, 1)にクリップされ、0は無音、1はフルボリュームです。

レイヤーの削除

DELETE /documents/(DocumentID)/layers/(LayerID)

指定されたレイヤーをドキュメントから削除します。成功した場合は 204 No Content を返します。レイヤーが必須のデモレイヤーである場合、削除は拒否されます。.

レイヤーアクション

/ドキュメント/(DocumentID)/レイヤー/(LayerID)/setLive

サポートされている方法"ゲット""ポスト"
レイヤーをアクティブにします。レイヤー上で直接これを呼ぶと、最後に選択されたレイヤーの variant が使われます。すでにアクティブなレイヤに対してこれをコールしてもエラーにはなりません。更新されたレイヤーオブジェクトが返されます。

/ドキュメント/(DocumentID)/レイヤー/(LayerID)/setOff

サポートされている方法"ゲット""ポスト"
レイヤーを非アクティブにします。すでに非アクティブ化されているレイヤーに対してこの処理を呼び出してもエラーにはなりません。更新されたレイヤーオブジェクトが返されます。

このメソッドを呼び出した後、レイヤーはアニメーションを実行することができるので、返されるレイヤーオブジェクトの状態は「オフ」ではなく「シャットダウン」になるかもしれません。

/ドキュメント/(DocumentID)/レイヤー/(LayerID)/トグルライブ

サポートされている方法"ゲット""ポスト"
レイヤーを「ライブ」と「オフ」に切り替える。

/ドキュメント/(DocumentID)/レイヤー/(LayerID)/シグナル/(SignalID)

サポートされている方法"ゲット""ポスト"
現在の "live-variant"、またはレイヤーが "active-variant "でライブでない場合、"(SignalID) "で指定されたシグナルをトリガーする。(SignalID) "は、レイヤーの "input-values "フィールド(キーの接尾辞"_TypeSignal "で識別)から取得できる。

/ドキュメント/(DocumentID)/レイヤー/(LayerID)/cycleThroughVariants

サポートされている方法"ゲット""ポスト"
利用可能なバージョン: mimoLive 5.6
レイヤ "(LayerID)" の現在アクティブな variant の次の variant を、レイヤの新しいアクティブな variant として選択します。これは、(例えば Lower Third レイヤの) 活性化する variant を選択するのに使えます。 次のページ.
このエンドポイントを呼び出しても、レイヤーが現在ライブであれば、ショーの邪魔にはなりません。エフェクトが表示されるのは、その後レイヤーがライブに設定されたときだけです。

/documents/(DocumentID)/layers/(LayerID)/cycleThroughVariantsBackwards

サポートされているメソッド: "GET" "POST"
previous variant を選択します (/cycleThroughVariants の逆)。レイヤまたは選択された variant がライブに設定されたときに効果が現れます。

/documents/(DocumentID)/layers/(LayerID)/setLiveFirstVariant

サポートされるメソッド: "GET" "POST"
レイヤーの最初のバリアントをアクティブにし、レイヤーをライブに設定します。

/documents/(DocumentID)/layers/(LayerID)/setLiveLastVariant

サポートされるメソッド: "GET" "POST"
last バリアントレイヤーをアクティブにし、レイヤーをライブに設定します。

/ドキュメント/(DocumentID)/レイヤ/(LayerID)/入力/(SourceInputKey)/メディアコントロール/(MediaControlCommand)

サポートされるメソッド: "GET" "POST"
指定されたレイヤの入力"(SourceInputKey) "にバインドされたメディアにメディアコントロールコマンドを送信します。入力のソースが、どのコマンドをサポートしているか報告していることに注意してください; /documents/(DocumentID)/sources/(SourceID)を参照してください。

メディア・コントロール・コマンド商品説明
プレーメディア再生を開始します。
ポーズポジションをリセットせずに再生を一時停止します。
ストップ再生を停止し、メディアの位置を最初に戻します。
リバースメディアを逆方向に再生します。
巻き返し通常は通常よりも速い速度で、再生を後方に進めます。
早送り再生を早送りします。
スキップスタートメディアの冒頭にジャンプします。
スキップトエンドメディアの最後にジャンプ。
スキップバック10秒間隔で後方にスキップします。
スキップヘッド10秒間隔でスキップします。
記録メディア入力の記録を開始します。
シャッフルメディアアイテムのランダム再生順を切り替えます。
繰り返し現在のメディアを繰り返します。

バリエーション

バリアントのクエリ

/ドキュメント/(DocumentID)/レイヤー/(LayerID)/バリアント

サポートされている方法"ゲット"
(LayerID) "で指定されたレイヤーと、"(DocumentID) "で指定されたドキュメントの variants のリストを返す。返されるオブジェクトについての情報は "variants" データ型を参照。

/ドキュメント/(DocumentID)/レイヤー/(LayerID)/バリアント/(VariantID)

サポートされている方法"ゲット", "プット"
(DocumentID) "で指定されたドキュメント内の、"(VariantID) "と"(LayerID) "で指定された variant を返します。返されるデータの詳細については "variants" データ型を参照してください。

バリアントの変更

バリアントの名前や入力値を設定するには、"プット「リクエストを JSON エンコードされたオブジェクトを variant エンドポイントに送ります。変更したくない値は、単に JSON あなた "プット".例

{
    "name": "New name of the Variant",
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

値を更新した後、mimoLive は更新された variant オブジェクトで応答します。すべての値が即座に適用されるわけではないこと、または別のレンダリングサイクルの後にしか効果がないかもしれないことに注意してください。

バリアントアクション

/ドキュメント/(DocumentID)/レイヤー/(LayerID)/バリアント/(VariantID)/セットライブ

サポートされている方法"ゲット""ポスト"
所有するレイヤがライブでなければ、それもライブに切り替わります。すでにアクティブな variant に対してこれをコールしてもエラーにはなりません。更新された variant オブジェクトが返されます。

/ドキュメント/(DocumentID)/レイヤー/(LayerID)/バリアント/(VariantID)/setOff

サポートされている方法"ゲット""ポスト"
バリアントを無効にします。これは所有レイヤもオフにします。

/ドキュメント/(DocumentID)/レイヤー/(LayerID)/バリアント/(VariantID)/トグルライブ

サポートされている方法"ゲット""ポスト"
バリアントをライブとオフの間で切り替える。

/ドキュメント/(DocumentID)/レイヤー/(LayerID)/バリアント/(VariantID)/シグナル/(SignalID)

サポートされている方法"ゲット""ポスト"
(SignalID) "で指定されたシグナルを variant にトリガします。(SignalID) "はレイヤの "input-values "フィールド(キーの接尾辞"_TypeSignal "で識別される)から得ることができる。

情報源

ソースの作成

POST /documents/(DocumentID)/sources

指定されたソース タイプからドキュメント内に新しいソースを作成します。source-type （com.boinx.mimoLive.sources.deviceVideoSource など）でタイプを指定し、オプションで表示名と HTTP API 経由で更新可能なすべてのパラメータを指定します。新しく作成されたソース オブジェクトを返します。.

curl -X POST "http://localhost:8989/api/v1/documents/(DocumentID)/sources" \
  -H "Content-Type: application/json" \
  -d '{
    "source-type": "com.boinx.mimoLive.sources.deviceVideoSource",
    "name": "Main Camera"
  }'

Valid source type identifiers:
ソース・タイプの識別子ソース
com.boinx.mimoLive.sources.webBrowserSourceウェブブラウザ
com.boinx.mimoLive.sources.screenCaptureSource画面キャプチャ
com.boinx.mimoLive.sources.ffmpegSourceNDI/ビデオキャプチャー
com.boinx.mimoLive.sources.webRTCSourceミモコール
com.boinx.mimoLive.sources.windowCaptureSourceウインドウキャプチャー
com.boinx.mimoLive.sources.deviceAudioSourceオーディオ機器
com.boinx.mimoLive.sources.deviceVideoSource映像・音声機器（カメラ）
com.boinx.mimoLive.sources.lastRecordingSource最後のレコーディング
com.boinx.mimoLive.sources.zoomparticipantズーム参加者
その他多数

ソースへの問い合わせ

/ドキュメント/(DocumentID)/ソース

サポートされている方法"ゲット"
(DocumentID) "で指定されたドキュメントのソースのリストを返す。返されるオブジェクトについては、"sources layer" データ型を参照してください。

/ドキュメント/(DocumentID)/ソース/(SourceID)

サポートされている方法"ゲット", "プット"
(DocumentID) "で指定されたドキュメント内の、"(SourceID) "で指定された単一のソースを返します。レスポンスの包含セクションでは、このソースに関連するすべての "filter" オブジェクトも返されます (サイドロード)。返されるデータの詳細については、"sources" データ型を参照してください。

/ドキュメント/(DocumentID)/ソース/(SourceID)/プレビュー

サポートされている方法"ゲット"
(DocumentID) "で指定されたドキュメント内の、"(SourceID) "で指定されたソースのグラフィカル・プレビューを返します。このエンドポイントは、以下のパラメータをサポートしています：

パラメータデフォルト商品説明
形式pngプレビューを返すフォーマット。許可される値: png, jpeg, mjpeg, mpng
fps10動画プレビューのフレームレート。mjpegとmpngフォーマットにのみ適用されます。1fpsは、おおよそ以下の1%に相当することに注意してください。 CPU 利用する。
幅(文書幅）プレビューの最大幅。指定した幅に収まるように画像が縮小されます。
高さ(文書幅）プレビューの最大高さ。指定した高さに収まるように画像が縮小されます。

/ドキュメント/(DocumentID)/ソース/(SourceID)/メディアコントロール/(MediaControlCommand)

サポートされるメソッド: "GET" "POST"
メディア対応ソース (メディアファイル/プレイリストなど) の再生を制御します。サポートされるコマンドは、ソースの種類によって異なります。documents/(DocumentID)/layers/(LayerID)/inputs/(SourceInputKey)/mediacontrol/(MediaControlCommand) を参照してください。

/ドキュメント/(DocumentID)/ソース/(SourceID)/openwebbrowser

サポートされるメソッド: "GET"
Web Browser Captureソースの場合、このアクションは対応するWebブラウザウィンドウを開きます。

注意: このエンドポイントは後方互換性のために残されています。新しい統合では、代わりに一般的なアクションエンドポイントを使用してください：/documents/(DocumentID)/sources/(SourceID)/actions/openwebbrowserを使用してください。

ソースの変更

ソースの名前や入力値を設定するには（コンポジション・ソースなど、ソースに名前がある場合のみ）、".プット「リクエストを JSON エンコードされたオブジェクトをソース・エンドポイントに渡します。変更したくない値は、単純に JSON あなた "プット".例

{
    "name": "New name of the Source",
    "gain": 1.25,
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

gain (数値) 属性は、ソースにゲインコントロールがない場合は無視されます。値は(0, 2)にクリップされ、0は無音、1はデフォルト、2は音量を約2倍にします。.

channel-map (配列) - どのデバイスの入力チャンネルをオーディオソースの左チャンネルと右チャンネルにマッピングするかを設定します。各エントリは

  • A 列 - デバイスの 入力チャンネル (例. "「第3章")
  • アン 整数 - ゼロベースのチャンネル・インデックス (例えば. 2 第3チャンネル用)

デバイスにチャンネル名が見つからない場合、アップデートは無視されます。.

# Set left channel to "Ch. 3" and right channel to "Ch. 4" (by name):
curl -X PUT "http://127.0.0.1:8989/api/v1/documents/{docID}/sources/{sourceID}" \
  -H "Content-Type: application/json" \
  -d '{"channel-map": ["Ch. 3", "Ch. 4"]}'

# Same thing using zero-based indices:
curl -X PUT "http://127.0.0.1:8989/api/v1/documents/{docID}/sources/{sourceID}" \
  -H "Content-Type: application/json" \
  -d '{"channel-map": [2, 3]}'


The video-device-id (string) and video-device-name (string) attributes select the video device of a camera/device source, by its unique identifier or by its display name respectively. The available identifiers and names are listed by the GET /api/v1/devices endpoint. Pass the special value none (case-insensitive) for either attribute to detach the video device, which is the equivalent of choosing "No Video Device" in the user interface. An unknown identifier or name leaves the current device unchanged.

The audio-device-id (string) and audio-device-name (string) attributes work the same way for the audio device of the source. Pass none to detach the audio device, equivalent to "No Audio Device" in the user interface.

Detach the video device:

curl -X PUT "http://127.0.0.1:8989/api/v1/documents/(DocumentID)/sources/(SourceID)" \
     -d '{"video-device-id": "none"}'

オーディオデバイスを取り外してください：

curl -X PUT "http://127.0.0.1:8989/api/v1/documents/(DocumentID)/sources/(SourceID)" \
     -d '{"audio-device-id": "none"}'

識別子または名前を指定して、特定のデバイスを再度選択してください：

curl -X PUT "http://127.0.0.1:8989/api/v1/documents/(DocumentID)/sources/(SourceID)" \
     -d '{"video-device-name": "Logitech StreamCam"}'

mimoCall ソース・プロパティ

利用可能なバージョン: mimoLive 6.18

mimoCall ソース（com.boinx.mimoLive.sources.webRTCSource）は、GET 経由で読み取り、PUT/PATCH 経由で変更できる追加属性を公開します：

属性タイプ商品説明
ビデオコーデック列ビデオコーデックの設定： ”「オート”, ”h264”または ”「vp9”.
プリファーズ・ハイクオリティ・オーディオブーリアンステレオを有効にし、高音質のための帯域幅を確保
パートナーズオブジェクトmimoCallパートナーが見るビデオ（下記参照）。.
パートナー・ヒアオブジェクトmimoCall パートナーが聞く音声（下記参照）。.
使用可能なアクションアレイアクション・エンドポイント経由でトリガーできるアクション（例えば. [再接続］).

partner-sees オブジェクト形式：。

タイプJSON商品説明
プログラム出力{“タイプ”：「プログラム出力｝パートナーはプログラムの出力を見ます。.
ビデオソース{“type”：「source“, ”source-id“：”(ソースID)“}。パートナーは特定のビデオソースを見ます。.
上層{“type”：“above-layer”, “layer-index”：3}パートナーは、指定されたインデックスの上のレイヤスタックを見ます。.
なし{タイプなし｝パートナーにビデオは送信されません。.

partner-hears オブジェクト形式:。

タイプJSON商品説明
ミックスマイナス{タイプ「ミックスマイナス｝プログラムミックスからパートナー自身のオーディオを除いたもの（デフォルト）。.
マスター・ミックス{“タイプ”：「マスターミックス｝フル・マスター・オーディオ・ミックス。.
カスタムミックス{“type”：“custom-mix”, “mix-name”：「オーディオミックス2｝名前入りのカスタムオーディオミックス。.
ソロ・ソース{“type”：“solo-source”, “source-id”：“(ソースID)”}。単一ソースからのオーディオのみ。.

例 - コーデックを変更し、パートナーが何を見るか：

curl -X PATCH “http://localhost:8989/api/v1/documents/(DocumentID)/sources/(SourceID)” \
  -H “Content-Type: application/json” \
  -d '{“video-codec”: “h264”, “partner-sees”: {“type”: “program-output”}}'

ソースの削除

DELETE /documents/(DocumentID)/sources/(SourceID)

指定されたソースをドキュメントから削除します。成功すると、204 No Content を返します。.

ソース・アクション

/ドキュメント/(DocumentID)/ソース/(SourceID)/シグナル/(SignalID)

サポートされている方法"ゲット""ポスト"
ソース上で"(SignalID) "で指定されたシグナルをトリガーします（ソースが "input-values "を持つ場合のみ、例えばコンポジション・ソース）。(SignalID) "は、ソースの "input-values "フィールド（キーの接尾辞"_TypeSignal "で識別）から取得できます。

/ドキュメント/(DocumentID)/ソース/(SourceID)/アクション/(ActionName)

サポートされるメソッド: “GET”
利用可能なバージョン: mimoLive 6.18

ソースに対して指定されたアクションをトリガします。使用可能なアクションはソース・タイプによって異なり、各ソース・オブジェクトの available-actions 属性にリストされます。成功した場合は更新されたソース・オブジェクトを返し、アクションがサポートされていない場合または失敗した場合は “409 Conflict” を返します。.

例

curl “http://localhost:8989/api/v1/documents/(DocumentID)/sources/(SourceID)/actions/reconnect”

ソースタイプ別に利用可能なアクション:。

ソース・タイプアクション名商品説明
ミモコール (com.boinx.mimoLive.sources.webRTCSource)再接続mimoCallパートナーとの接続を切断し、再接続します。.
ウェブブラウザcom.boinx.mimoLive.sources.webBrowserSource)オープンウェブブラウザ対応するウェブブラウザウィンドウを開きます。.

フィルター

クエリ・フィルター

/ドキュメント/(DocumentID)/ソース/(SourceID)/フィルター

サポートされている方法"ゲット"
(SourceID) "で指定されたソースと、"(DocumentID) "で指定されたドキュメントのフィルタのリストを返す。返されるオブジェクトの詳細については、"filters" データ型を参照してください。

/ドキュメント/(DocumentID)/ソース/(SourceID)/フィルター/(FilterID)

サポートされている方法"ゲット", "プット"
(DocumentID) "で指定されたドキュメント内の、"(FilterID) "と"(SourceID) "で指定された単一のフィルタを返す。返されるデータの詳細については、"filters" データ型を参照してください。

フィルタの修正

入力値を設定するには、"プット「リクエストを JSON エンコードされたオブジェクトをフィルタエンドポイントに渡す必要があります。変更したくない値は、単に JSON あなた "プット".例

{
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

/ドキュメント/(DocumentID)/ソース/(SourceID)/フィルター/(FilterID)/シグナル/(SignalID)

サポートされている方法"ゲット""ポスト"
フィルタの"(SignalID) "で指定されたシグナルをトリガする。(SignalID) "は、フィルタの "input-values "フィールド(キーの接尾辞"_TypeSignal "で識別)から取得できる。

出力先

出力先の作成

POST /documents/(DocumentID)/output-destinations

ドキュメント内に新しい出力先を作成します。output-destination-type でタイプを指定し、オプションで index で位置を、HTTP API で更新できるパラメータを設定します。新しく作成した出力先オブジェクトを返します。.

出力先識別子出力先
com.boinx.mimoLive.outputDestination.liveStreamingライブストリーミング（RTMPなど）
com.boinx.mimoLive.outputDestination.fileRecordingファイル記録
com.boinx.mimoLive.outputDestination.blackmagicDesignプレイアウト（Blackmagic SDI/HDMI）
com.boinx.mimoLive.outputDestination.ndiNDI出力
com.boinx.mimoLive.outputDestination.fullscreenフルスクリーン出力
com.boinx.mimoLive.outputDestination.virtualCameraバーチャルカメラ
com.boinx.mimoLive.outputDestination.mimoCallミモコール
com.boinx.mimoLive.outputDestination.audioMonitorオーディオ・モニター
com.boinx.mimoLive.outputDestination.imageSequenceイメージライター
com.boinx.mimoLive.outputDestination.fileUploaderファイルアップローダー
curl -X POST "http://localhost:8989/api/v1/documents/(DocumentID)/output-destinations" \
  -H "Content-Type: application/json" \
  -d '{
    "output-destination-type": "com.boinx.mimoLive.outputDestination.fileRecording",
    "index": 0
  }'

出力先を問い合わせる

/ドキュメント/(DocumentID)/出力先

サポートされている方法"ゲット"
指定した文書のすべての出力先を一覧表示します。
返されるオブジェクトに関する情報は、""output-destinations""データタイプ":{TOPIC-を参照のこと。リンク+出力先セクション）。

/documents/(DocumentID)/output-destinations/(OutputDestinationID)

サポートされているメソッド"GET"
(OutputDestinationID)」で指定された出力先を返します。
返されるオブジェクトに関する情報は、""output-destinations""データタイプ":{TOPIC-を参照のこと。リンク+出力先セクション）。

出力先の変更

/documents/(DocumentID)/output-destinations/(OutputDestinationID)

サポートされているメソッド"PUT"、"パッチ"
(OutputDestinationID) "で指定された出力先の選択されたプロパティを更新する。
更新された出力先を返します。

以下のプロパティは変更可能である：

  • "タイトル"
  • "スタートウィズショー"
  • "ストップ・ウィズ・ショー"
  • settings "オブジェクトの内容 ( 設定の説明詳しくはsection-individual-settingsを参照)。

更新の説明は JSONAPI更新フォーマット .crud-updating）。例

{
  "data": {
    "type": "output-destinations",
    "id": "4FF003EA-D071-43FD-845F-DCD4A25DFA00",
    "attributes": {
      "title": "Our Recording",
      "starts-with-show": true,
      "settings": {
        "location": "~/Movies"
      }
    }
  }
}

出力先アクション

/ドキュメント/(DocumentID)/出力先/(OutputDestinationID)/setLive

サポートされている方法"ゲット""ポスト"
(OutputDestinationID) "で指定された出力先が適切に設定され、ライブが許可されている場合（例えば、mimoLiveライセンス状態に基づく）、ライブを開始します。
出力先がライブに移行できれば、新しい「ライブ状態」の出力先が返され、そうでなければ「409 Conflict」エラーが返される。

出力先がライブになる前に何らかの作業を行う必要がある場合があるため（例えば、ライブストリームを作成するために外部サービスに問い合わせる）、返される出力先オブジェクトの状態は「ライブ」ではなく「スタートアップ」になる場合がある。

/ドキュメント/(DocumentID)/出力先/(OutputDestinationID)/setOff

サポートされている方法"ゲット""ポスト"
(OutputDestinationID)」で指定された出力先を停止させる。
出力先が停止を許可されている場合、出力先が返され、そうでない場合は「409 Conflict」エラーが返される。

出力先が操作を停止する前に何らかの作業を行う必要があるため、返される出力先の状態は「プレビュー」ではなく「シャットダウン」になる可能性がある（これは適切に設定された出力先のデフォルトである）。

レイヤーセット

レイヤーセットはmimoLive 5.0で導入され、一度に複数のレイヤーのライブ状態を設定することができ、ショーのさまざまな状況に合わせて軽量のシーンを作成することができます。.

レイヤーセットの作成

POST /documents/(DocumentID)/layer-sets

ドキュメントに新しいレイヤーセットを作成します。レイヤー セットは、レイヤー セットを呼び出したときに 1 つまたは複数のレイヤーに適用されるアクションの保存されたコレクションです。各レイヤーにアクションを指定します：「ライブ」（ライブにする、オプションで特定のバリアント付き）、「オフ」（グレースフルスイッチオフ）、または「フォースオフ」（即時スイッチオフ）。また、recall-on-show-start と recall-on-show-end を設定して、ショーの開始時や終了時にレイヤーセットを自動的に呼び出すこともできます。新しく作成されたレイヤーセットオブジェクトを返します。.

curl -X POST "http://localhost:8989/api/v1/documents/(DocumentID)/layer-sets" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "attributes": {
        "name": "Interview Scene",
        "recall-on-show-start": false,
        "recall-on-show-end": false,
        "layers": [
          {
            "layer-id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "action": "live",
            "variant": "edit-variant"
          },
          {
            "layer-id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
            "action": "off"
          },
          {
            "layer-id": "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
            "action": "force-off"
          }
        ]
      }
    }
  }'

レイヤーセットを照会する

/ドキュメント/(DocumentID)/レイヤーセット

サポートされている方法"ゲット"
指定されたドキュメントのすべてのレイヤーセットを一覧表示します。
返されるオブジェクトについては、“layer-sets ”データ型を参照してください。.

/ドキュメント/(DocumentID)/レイヤーセット/(LayerSetID)

サポートされているメソッド"GET"
(LayerSetID)」で指定されたレイヤーセットを返します。
返されるオブジェクトについての情報は、""レイヤーセット""データ型":{TOPIC-":{TOPIC-":{TOPIC-":{TOPIC-":{TOPIC-」を参照のこと。リンク+セクションレイヤーセット）。

レイヤーセットの変更

/ドキュメント/(DocumentID)/レイヤーセット/(LayerSetID)

サポートされているメソッド"PUT"、"パッチ"

既存のレイヤーセットを更新します。名前を変更したり、自動呼び出しの動作を変更したり、レイヤー アクション エントリを置き換えたりできます。変更したい属性のみを含めます。更新されたレイヤーセットオブジェクトを返します。

curl -X PUT "http://localhost:8989/api/v1/documents/(DocumentID)/layer-sets/(LayerSetID)" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "attributes": {
        "name": "Wide Shot Scene",
        "layers": [
          {
            "layer-id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "action": "live",
            "variant": "VVVVVVVV-VVVV-VVVV-VVVV-VVVVVVVVVVVV"
          },
          {
            "layer-id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
            "action": "force-off"
          }
        ]
      }
    }
  }'

レイヤーセットの削除

DELETE /documents/(DocumentID)/layer-sets/(LayerSetID)

指定 し た レ イ ヤーセ ッ ト を文書か ら 恒久的に削除 し ます。成功すると 204 No Content を返します。.

レイヤーセットアクション

/ドキュメント/(DocumentID)/レイヤーセット/(LayerSetID)/リコール

サポートされている方法"ゲット""ポスト"
(LayerSetID) "で指定されたレイヤーセットを呼び出し(アクティブ化)、すべてのレイヤーがそのレイヤーセットに記録されたライブ状態になります。
リコール後、つまり "active == true "で設定されたレイヤーを返します。

データストア

/ドキュメント/(DocumentID)/データストア/(StoreID)

サポートされている方法"ゲット", "プット", "削除"
mimoLiveは、後で状態を復元するためなどに、ドキュメントファイル内に提供されたデータを保存する機能を提供します。StoreID "は自由に選択できますが、ドキュメントに関連するすべてのデータストアをリストアップする方法はありませんのでご注意ください。 インデックス ストアは、動的に命名された他のストアを追跡する)。

データストアの作成/更新

データストアを作成または更新するには、"プット"リクエストの本文に関連するデータとともに、選択した "StoreID "にリクエストしてください。操作が成功した場合、mimoLiveは "200 OK "ステータスで応答します。

データストアの内容を読み込む

以前に保存されたデータストアを読み込むには、単純に "ゲット".で指定したとおりのデータが返される。プット"リクエストで保存します。そのIDを持つデータストアがこのドキュメントに見つからなかった場合、mimoLiveは "404 Not Found "エラーを返します。

既存のデータストアを削除する

不要になったデータストアを削除するには、".削除"リクエストを削除したい "StoreID "に送信します。データストアが最初から存在しない場合、mimoLiveは "404 Not Found "エラーで応答します。

ズーム・ミーティング

これらのエンドポイントは、mimoLiveの組み込みZoomクライアント統合を制御します。

/ズーム/結合

サポートするメソッド: "GET" "POST"
Zoom ミーティングに参加します。典型的なパラメータ（POSTの場合はJSONボディとして、GETの場合は?param=valueとして送信します）：

パラメータバリュータイプ商品説明
ミーティングIDストリングZoomミーティング番号（mimoLiveデモミーティングに参加する場合は「Demo-Meeting-ID」を使用してください。）
パスコード文字列、オプション会議のパスコード
ウェビナートークン文字列、オプションウェビナーに参加するには、ウェビナートークンを提供する必要があります。
表示名ストリング, 任意ミーティングに登場する名前
ズームアカウント名ストリングmimoLive Zoomアカウント設定で表示されるZoomアカウント名
バーチャルカメラ文字列、オプションtrue “に設定すると、mimoLiveは番組をビデオフィードとしてZoomに送信します。

接続の進行状況または成功を示すステータスオブジェクトを返します。

/ズーム/リーブ

サポートされているメソッド: "GET" "POST"
現在参加している会議から離脱します。ステータスオブジェクトを返します。

/ズーム/終了

サポートされているメソッド: "GET" "POST"
現在のZoomミーティングの終了/終了を試みます(ホストのみのアクション)。会議が終了した場合は成功を、クライアントの権限が不足している場合は競合を返します。

/ズーム/参加者

サポートされているメソッド: "GET" "POST"
参加している会議の現在の参加者リスト(名前、ID、基本状態)を返します。

バリューキーバリュータイプ商品説明
名称ストリングズーム参加者名
id整数ズーム参加者のユーザーID
ユーザーロールストリング
ホストブールユーザが会議の主催者である場合はtrue
isCoHostブールユーザーが会議の共同主催者である場合はtrue
isVideoOnブールユーザーがビデオを有効にしている場合はtrue
isAudioOnブールユーザーがオーディオを有効にしている場合はtrue
イズトーキングブールユーザーが現在話している場合はtrue
isRaisingHandブールユーザーが現在手を上げている場合はtrue

/ズーム/ミーティングアクション

会議スコープのアクションを実行します。actionとオプションの引数をJSONボディまたはクエリー文字列で指定します。

パラメータバリュータイプ商品説明
命令ストリング以下のリストからのコマンド
ユーザーID文字列、オプションユーザーIDが必要なコマンドもあります。
スクリーンタイプ文字列、オプションいくつかのコマンドはscreentypeを必要とします。
コマンド商品説明
リクエスト録音許可現地での録画許可のリクエストを送信します。
ミュートビデオユーザのビデオをミュートします。(useridパラメータが必要)
アンミュートビデオユーザのビデオのミュートを解除します。(useridパラメータが必要)
ミュートオーディオユーザの音声をミュートします。(useridパラメータが必要)
ミュート解除ユーザの音声のミュートを解除します。(useridパラメータが必要です）
enableUnmuteBySelfホスト/コホストに限り、ミュート時にユーザーがミュートを解除できる機能を有効にします。
disableUnmuteBySelfホスト/コホストにのみ利用可能な、ミュート時にユーザーがミュートを解除できない機能を無効にします。
ミュートオール会議の参加者全員をミュートします。ホスト/共同ホストのみ使用可能です。
ミュート解除会議参加者全員のミュートを解除します。
ロックミーティングホスト/共同ホストのみ利用可能な会議をロックします。ロックされると、新しい参加者は参加できなくなります。
アンロックミーティングホスト/共同ホストのみが利用可能な会議のロックを解除します。
ロワーオールハンド参加者全員の手を下ろし、司会者・共同司会者のみが利用できます。
シェアフィットウィンドウモードウィンドウに合わせて表示サイズを調整してください。
ポーズシェアポーズ共有。
レジュメシェア履歴書の共有
ジョインボイップVoIPで会議に参加。
リーブボイップ会議からVoIPを切断します。
参加者のチャット許可ユーザー同士がチャットできる機能を有効にします。
参加者のチャット拒否ユーザー同士のチャット機能を無効にしてください。
参加者の共有ユーザーが画面を共有できる機能を有効にします。
参加者の共有禁止ユーザーが画面を共有できる機能を無効にします。
ビデオの開始を許可する参加者ユーザーがビデオを開始できる機能を有効にします。
参加者に動画を開始させないようにします。ユーザーがビデオを開始できる機能を無効にします。
参加者がホワイトボードを共有できるようにします。ユーザーがホワイトボードを共有できる機能を有効にします。
参加者にホワイトボードの共有を許可しないようにします。ユーザーがホワイトボードを共有できる機能を無効にします。
enableAutoAllowLocalRecordingRequestユーザーからの録画リクエストを自動的に受け付ける機能を有効にします。
disableAutoAllowLocalRecordingRequestユーザーからの録画リクエストを自動的に受け付ける機能を無効にします。
参加者の名前変更許可ユーザーが自分で名前を変更できる機能を有効にします。
参加者の名前を変更しないようにします。ユーザーが自分で名前を変更できる機能を無効にします。
ショー参加者プロフィール写真参加者のプロフィール写真を表示するオプションをオンにしてください。
参加者プロフィール写真の非表示参加者のプロフィール写真を表示するオプションをオフにしてください。

使用例

mimoLive HTTP APIのこれらのエンドポイントは、様々な方法で利用することができます。詳しくはAPI使用例セクションをご参照ください。

ご意見・ご感想

ミモライブのこの機能を使ってみて、どのように評価されますか？

ユーザーマニュアル最近の更新