端点

一般

ǞǞǞ API，当启用时，可在 "http://localhost:8989/api/v1"。这是基础 URL 必须在每个方法前加上 URL 下面列出的。

如果一项资源是在最初推出的 HTTP API，该方法被标记为 已有 信息。

/

支持的方法："争取"
重定向到"/documents "的开放文件列表。

/devices

支持的方法： “GET”
返回主机系统上当前可用设备（视频和音频）的列表。每个设备包括连接状态、类型标志，以及音频设备的可用输入通道。

/devices/（设备 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

支持的方法："争取"
结果是一个打开的文档列表。关于返回的对象包含哪些信息，请看文档的数据类型。

/documents/(DocumentID)

支持的方法："争取”, "拨出"
返回由"（DocumentID）"指定的单个文档。在响应的包含部分，该文档使用的所有 "层 "对象和该文档包含的所有 "源 "对象也将被返回（侧向加载）。有关返回数据的更多信息，请参见文档数据类型。

PUT 可更新文档级属性，如节目输出主卷和节目元数据（标题、作者、分辨率、帧频、采样率等）。只发送您想更改的字段。.

/documents/(DocumentID)/programOut

支持的方法："争取"
由"（DocumentID）"指定的文件当前产生的程序输出。
采取与源预览相同的参数。

文件行动

/documents/(DocumentID)/setLive

支持的方法："争取""帖文"
启动一个节目/文件并触发所有相关的事件。在一个已经运行的文档上调用这个不会导致错误。更新的文档对象将被返回。

/documents/(DocumentID)/setOff

支持的方法："争取""帖文"
停止一个节目/文件。在一个已经停止的节目上调用这个不会导致错误。更新的文档对象将被返回。

因为在你调用这个方法后，文档可以决定继续运行，返回的图层对象可能处于 "关闭 "而不是 "关闭 "状态。

/documents/(DocumentID)/toggleLive

支持的方法："争取""帖文"
将一个节目/文件在直播和关闭之间切换。

分层

创建图层

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) "指定的文档的图层列表。关于返回的对象的信息，请看图层数据类型。

/documents/（DocumentID）/layers/（LayerID）。

支持的方法："争取", "拨出"
返回由"(DocumentID) "指定的文件中由"(LayerID) "指定的单个图层。在响应的 "包含 "部分，所有与该层相关的 "变体 "对象也将被返回（侧向加载）。有关返回数据的更多信息，请参见图层数据类型。请记住，来自图层端点的 "输入值 "反映了相关 "liveVariant "变量的 "输入值"。

修改一个图层

支持的方法："争取", "拨出"
要设置层的名称、音频音量或输入值，请执行"拨出"的请求，并有一个 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会以更新的图层对象回应。请记住，并不是所有的值都可以立即应用，或可能只有在另一个渲染周期后才会有效果。

注意："音量 "属性是在mimoLive 5.6中添加的，在早期的版本中或如果该层没有音量控制，则会被忽略。值将被剪切到（0，1），其中0是无声，1是全音量。

删除图层

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

从文档中删除指定图层。成功时返回 204 无内容。如果图层是必需的演示图层，删除将被拒绝。.

图层操作

/documents/（DocumentID）/layers/（LayerID）/setLive

支持的方法："争取""帖文"
激活一个图层，当直接在图层上调用这个功能时，将使用最后选择的图层变量。在一个已经激活的图层上调用这个命令不会导致错误。更新的图层对象将被返回。

/documents/（DocumentID）/layers/（LayerID）/setOff

支持的方法："争取""帖文"
停用一个图层。在一个已经停用的图层上调用这个命令不会导致错误。更新的图层对象将被返回。

因为在你调用这个方法后，一个图层可以决定做一些动画，返回的图层对象可能处于 "关闭 "状态，而不是 "关闭"。

/documents/（DocumentID）/layers/（LayerID）/toggleLive

支持的方法："争取""帖文"
在 "直播 "和 "关闭 "之间切换一个层。

/documents/(DocumentID)/layers/(LayerID)/signal/(SignalID)

支持的方法："争取""帖文"
在当前的 "实时变量 "中，或者如果该层在 "活动变量 "中不是实时的，触发由"（SignalID）"指定的信号。你可以从图层的 "输入值 "字段（由键后缀"_TypeSignal "标识）中获得"（信号ID）"。

/documents/（DocumentID）/layers/（LayerID）/cycleThroughVariants

支持的方法："争取""帖文"
可用的时间: mimoLive 5.6
选择层"(LayerID) "的当前活动变量之后的下一个变量，作为该层的新活动变量。这可以用来选择应该上线的变量（例如下三层的变量）。 下一个.
如果该层目前是活的，调用这个端点不会干扰你的表演。该效果只在之后该层被设置为直播时显示。

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

支持的方法： "GET" "POST"
选择上一个变体（/cycleThroughVariants的反向），而不影响当前的实时状态。当图层或所选变体设置为实时时，效果将变得可见。

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

支持的方法： "GET" "POST"
激活层的第一个变量并设置层的实时状态。

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

支持的方法： "GET" "POST"
激活层的最后变量并设置层的实时状态。

/documents/(DocumentID)/layers/(LayerID)/inputs/(SourceInputKey)/mediacontrol/(MediaControlCommand)

支持的方法： "GET" "POST"
向绑定到指定层的"(SourceInputKey) "输入的媒体发送媒体控制命令。请注意，输入的源会报告其支持哪些命令；请参阅/documents/(DocumentID)/sources/(SourceID)。

变体

查询变体

/documents/（DocumentID）/layers/（LayerID）/variants

支持的方法："争取"
返回由"(LayerID) "指定的层和由"(DocumentID) "指定的文档的变体列表。关于返回的对象的信息，见 "variants "数据类型。

/documents/（DocumentID）/layers/（LayerID）/variants/（VariantID）。

支持的方法："争取", "拨出"
返回由"(DocumentID) "指定的文件中由"(VariantID) "和"(LayerID) "指定的单一变体。有关返回数据的更多信息，请参见 "variants "数据类型。

修改一个变体

要设置变体的名称或输入值，请执行"拨出"的请求，并有一个 JSON 编码的对象到变体端点。你不想改变的值应该被简单地排除在 JSON 你"拨出".例子：

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

更新数值后，mimoLive会以更新的变体对象回应。请记住，并不是所有的值都可以立即应用，或可能只有在另一个渲染周期后才会有效果。

变体行动

/documents/（DocumentID）/layers/（LayerID）/variants/（VariantID）/setLive

支持的方法："争取""帖文"
激活一个变体，如果拥有的层不是实时的，它也会被切换为实时的。在一个已经激活的变体上调用这个命令不会导致错误。更新的变体对象将被返回。

/documents/（DocumentID）/layers/（LayerID）/variants/（VariantID）/setOff

支持的方法："争取""帖文"
停用一个变体。这也将导致拥有的层被关闭。

/documents/（DocumentID）/layers/（LayerID）/variants/（VariantID）/toggleLive

支持的方法："争取""帖文"
在活体和非活体之间切换一个变体。

/documents/(DocumentID)/layers/(LayerID)/variants/(VariantID)/signals/(SignalID)

支持的方法："争取""帖文"
触发变量上由"（SignalID）"指定的信号。你可以从层的 "输入值 "字段（由键的后缀"_TypeSignal "标识）获得"（SignalID）"。

资料来源

创建资源

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:

查询来源

/documents/(DocumentID)/sources

支持的方法："争取"
返回由"(DocumentID) "指定的文档的来源列表。关于返回的对象的信息，见 "sources layer "数据类型。

/documents/（DocumentID）/sources/（SourceID）。

支持的方法："争取", "拨出"
在"(DocumentID) "指定的文档中返回由"(SourceID) "指定的单个源。在响应的包含部分，所有与该源相关的 "过滤器 "对象也将被返回（侧向加载）。有关返回数据的更多信息，请参见 "来源 "数据类型。

/documents/（DocumentID）/sources/（SourceID）/preview

支持的方法："争取"
返回"(SourceID) "所指定的源在"(DocumentID) "所指定的文档中的图形预览。该端点支持以下参数：

/documents/(DocumentID)/sources/(SourceID)/mediacontrol/(MediaControlCommand)

支持的方法： "GET" "POST"
控制媒体功能源（如媒体文件/播放列表）的播放。支持的命令取决于源类型。请参阅 /documents/(DocumentID)/layers/(LayerID)/inputs/(SourceInputKey)/mediacontrol/(MediaControlCommand) 。

/documents/(DocumentID)/sources/(SourceID)/openwebbrowser

支持的方法： "GET"
如果源是网络浏览器捕获源，此操作将打开相应的网络浏览器窗口。

注意：保留此端点是为了向后兼容。新集成应使用通用操作端点：/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"
    }
}

如果音源没有增益控制，增益（数字）属性将被忽略。该值将被削为 (0，2)，其中 0 为静音，1 为默认值，2 约为音量的两倍。.

channel-map （数组） - 设置哪些设备输入通道映射到音源的左右声道。每个条目可以是

• A 字符串 - 设备的 输入通道 例如. "第 3 章")
• 一个 整数 - 基于零的频道索引（例如. 2 为第三个通道）

如果在设备上找不到任何通道名，更新将被静默忽略。.

# 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 修改的附加属性：

partner-sees 对象格式：</strong

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”}}'

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

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

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
  }'

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

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"
          }
        ]
      }
    }
  }'

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"
          }
        ]
      }
    }
  }'