一般

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

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

/

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

ドキュメント

ドキュメントのクエリ

/ドキュメント

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

/ドキュメント/(DocumentID)

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

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

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

ドキュメントアクション

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

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

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

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

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

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

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

レイヤー

レイヤーのクエリ

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

サポートされている方法"ゲット"
(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はフルボリュームです。

レイヤーアクション

/ドキュメント/(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 を選択するのに使えます。 次のページ.
このエンドポイントを呼び出しても、レイヤーが現在ライブであれば、ショーの邪魔にはなりません。エフェクトが表示されるのは、その後レイヤーがライブに設定されたときだけです。

バリエーション

バリアットのクエリ

/ドキュメント/(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 "で識別される)から得ることができる。

情報源

ソースへの問い合わせ

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

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

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

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

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

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

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

ソースの変更

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

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

gain "属性はmimoLive 5.6で追加され、以前のバージョンやソースにゲインコントロールがない場合は無視されます。値は(0, 2)にクリップされ、0は無音、1はデフォルト、2は音量を約2倍にします。

ソース・アクション

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

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

フィルター

クエリ・フィルター

/ドキュメント/(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 "で識別)から取得できる。

出力先

出力先を問い合わせる

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

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

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

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

出力先の変更

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

サポートされている方法"パッチ"
発売日：ミモライブ4.2
(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

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

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

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

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

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

レイヤーセット

レイヤーセットはmimoLive 5.0で導入され、一度に複数のレイヤーのライブ状態を設定することができ、軽量なレイヤーセットを作成することができます。 シーン をショーの様々なシチュエーションで使用することができます。これらはmimoLiveでのみ作成・管理できます。 エーピーアイ を取得するためにアクセスが制限されている。 想起 (活性化）層セット。

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

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

textileRef:9996801466400ba8908856:linkStartMarker:“サポートされている方法"ゲット"
発売日：ミモライブ5.0
指定されたドキュメントのすべてのレイヤーセットを一覧表示します。
返されるオブジェクトについての情報は、""レイヤーセット""データ型":{TOPIC-":{TOPIC-":{TOPIC-":{TOPIC-":{TOPIC-」を参照のこと。リンク+セクションレイヤーセット）。

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

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

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

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

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

データストア

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

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

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

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

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

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

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

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

使用例

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