一般

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

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

/

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

文件

查询文件

/documents

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

/documents/(DocumentID)

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

/documents/(DocumentID)/programOut

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

文件行动

/documents/(DocumentID)/setLive

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

/documents/(DocumentID)/setOff

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

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

/documents/(DocumentID)/toggleLive

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

分层

查询图层

/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是全音量。

图层操作

/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）/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）"。

资料来源

查询来源

/documents/(DocumentID)/sources

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

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

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

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

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

参数	默认情况下	描述
格式	绘画	返回预览的格式。允许的值：png, jpeg, mjpeg, mpng
fps	10	运动图像预览的帧速率。只适用于mjpeg和mpng格式。请注意，1帧大致相当于1%的 CPU 利用。
宽度	(文件宽度)	预览的最大宽度。图像将被缩小以适应给定的宽度。
高度	(文件宽度)	预览的最大高度。图像将被缩小以适应给定的高度。

修改一个来源

要设置源的名称或输入值（只有当源有任何名称时，例如它是一个合成源），执行"拨出"的请求，并有一个 JSON 编码的对象到源端点。你不想改变的值应该被简单地排除在 JSON 你"拨出".例子：

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

*"增益 "属性在mimoLive 5.6中被添加，在早期版本中被忽略，或者如果源没有增益控制。值将被剪切到（0，2），其中0是无声的，1是默认的，2大约是音量的两倍。

来源行动

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

支持的方法："争取""帖文"
触发信号源上的"(SignalID) "所指定的信号（只有当信号源有 "输入值 "时，例如它是一个合成源）。你可以从源的 "输入值 "字段（由键的后缀"_TypeSignal "标识）获得"（SignalID）"。

过滤器

查询过滤器

/documents/（DocumentID）/sources/（SourceID）/filters

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

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

支持的方法："争取", "拨出"
返回由"(FilterID) "和"(SourceID) "指定的文档中的单个过滤器。参见 "过滤器 "数据类型，以了解更多关于返回数据的信息。

修改一个过滤器

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

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

/documents/（DocumentID）/sources/（SourceID）/filters/（FilterID）/signals/（SignalID）。

支持的方法："争取""帖文"
触发过滤器上由"（SignalID）"指定的信号。你可以从过滤器的 "input-values "字段（由键的后缀"_TypeSignal "标识）获得"（SignalID）"。

输出目的地

查询输出目的地

/documents/(DocumentID)/output-destinations

textileRef:9996801466400ba8908856:linkStartMarker:“支持的方法："争取"
可用的时间: mimoLive 4.2
列出指定文档的所有输出目的地。
关于返回的对象的信息，请参见""output-destinations "数据类型"：{TOPIC-链接+data-typesh1(}. section-output-destinations)。

/documents/（DocumentID）/output-destinations/（OutputDestinationID）。

支持的方法：“GETtextileRef:9996801466400ba8908856:linkStartMarker:”
可用的时间: mimoLive 4.2
返回由"（OutputDestinationID）"指定的输出目的地。
关于返回的对象的信息，请参见""output-destinations "数据类型"：{TOPIC-链接+data-typesh1(}. section-output-destinations)。

修改一个输出目的地

/documents/（DocumentID）/output-destinations/（OutputDestinationID）。

支持的方法："PATCH"
可用的时间: mimoLive 4.2
更新由"（OutputDestinationID）"指定的输出目的地的选定属性。
返回最新的输出目的地。

以下属性是可以修改的：

• "标题"
• "开始-显示"
• "随同演出而停止"
• "设置 "对象的内容（见 设置说明.节-个人-设置）的更多信息)

更新说明必须在 JSON:API更新格式 .crud-updating）。例子：

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

输出目的地行动

/documents/（DocumentID）/output-destinations/（OutputDestinationID）/setLive

支持的方法："争取""帖文"
可用的时间: mimoLive 4.2
导致由"(OutputDestinationID) "指定的输出目的地上线，如果它被正确配置并允许上线（例如基于mimoLive许可状态）。
如果输出目的地能够上线，将返回具有新的 "上线状态 "的输出目的地，否则将返回 "409冲突 "错误。

*因为输出目的地在直播前可能需要执行一些工作（例如，联系外部服务以创建直播流），返回的输出目的地对象可能处于 "启动 "状态，而不是 "直播 "状态。

/documents/（DocumentID）/output-destinations/（OutputDestinationID）/setOff

支持的方法："争取""帖文"
可用的时间: mimoLive 4.2
导致由"（OutputDestinationID）"指定的输出目的地停止。
如果输出目的地被允许停止，则返回输出目的地，否则返回 "409冲突 "错误。

*因为一个输出目的地可能需要在停止操作之前执行一些工作，返回的输出目的地可能处于 "关闭 "状态，而不是 "预览 "状态（这将是一个配置良好的输出目的地的默认状态）。

图层组

图层集在mimoLive 5.0中被引入，允许一次设置多个图层的实时状态，使创建轻量级的 场景 节目中的不同情况。他们只能在mimoLive中创建和管理。 API 访问被限制在获得和 回顾 (激活)层集。

查询图层集

/documents/(DocumentID)/layer-sets

textileRef:9996801466400ba8908856:linkStartMarker:“支持的方法："争取"
可用的时间: mimoLive 5.0
列出指定文档的所有图层集。
关于返回的对象的信息，见""layer-sets "数据类型"：{TOPIC-链接+data-typesh1(}. section-layer-sets)。

/documents/（DocumentID）/layer-set/（LayerSetID）。

支持的方法：“GETtextileRef:9996801466400ba8908856:linkStartMarker:”
可用的时间: mimoLive 5.0
返回由"（LayerSetID）"指定的图层集。
关于返回的对象的信息，见""layer-sets "数据类型"：{TOPIC-链接+data-typesh1(}. section-layer-sets)。

图层集操作

/documents/（DocumentID）/layer-set/（LayerSetID）/recall

支持的方法："争取""帖文"
可用的时间: mimoLive 5.0
调用（激活）由"（LayerSetID）"指定的图层集，使所有图层承担记录在图层集中的实时状态。
返回召回后的图层集，即 "active == true"。

数据存储

/documents/（DocumentID）/datastores/（StoreID）。

支持的方法："争取", "拨出", "DELETE"
mimoLive提供了将你提供的数据储存在文件文件内的能力，例如在以后的时间恢复一个状态。你可以自己选择一个 "StoreID"，但要注意没有办法列出所有与文件相关的数据存储（不过，你可以创建某种形式的 指数 存储器，用于跟踪你的其他动态命名的存储器）。

创建/更新一个数据存储

要创建或更新一个数据存储，请发送一个"拨出"请求到您选择的 "StoreID"，并在您的请求正文中提供相关数据。如果操作成功，mimoLive会以 "200 OK "状态回应。

读取一个数据存储的内容

要读取一个先前存储的数据存储，只需通过""请求即可。争取".数据将完全按照你在""中提供的内容返回。拨出"请求来存储它。如果没有找到这个文件的ID的数据存储，mimoLive将返回一个 "404 Not Found "错误。

删除一个现有的数据存储

当你不再需要一个数据存储时，要删除它，只需发出一个"DELETE"你想删除的 "StoreID" 的请求。如果数据商店一开始就不存在，mimoLive会回应 "404 Not Found "错误。