文档
vMix API通过HTTP协议提供对常用功能的访问。
例如，下面的命令会让vMix在1秒内淡出预览到激活状态:
|
http://127.0.0.1:8088/api/?Function=Fade&Duration=1000 |
设置
API使用与标准web Interface相同的web地址，可以在“设置”中的web选项卡中进行配置。
参数
函数
指定要执行的函数。
这可以是快捷键特性提供的任何函数。
在vMix中，选择“设置”、“快捷方式”，然后单击“添加”，查看可能实现的功能列表。
“函数”下拉框中的所有函数都可以从API调用。
持续时间
如果指定的函数是一个转换，该参数可以设置为毫秒。
输入
Input可以用以下三种方式之一来指定Input:
1. 从1开始按数字。0可以用于预览，-1用于活动。
2. 的名字。(注意区分大小写，要求完整的标题名称包括空格)
3.GUID可以用来指定准确的输入。GUID可以从XML的“Key”属性中找到。
例如:
http://127.0.0.1:8088/API/?Function=Fade&Duration=1000&Input=877bb3e7-58bd-46a1-85ce-0d673aec6bf5
选择名称
当使用Title或XAML输入时，SelectedName可用于指定要修改的文本字段的名称。
例如:
http://127.0.0.1:8088/API/?Function=SetText&Input=877bb3e7-58bd-46a1-85ce-0d673aec6bf5&SelectedName=Headline&Value=Hello
使用GT标题时，名称应包含“。文本字段末尾的文本“和”。来源”在*后的图像或矩形刷图像。
作为参考，这些全名显示在vMix内建的Title Editor中。
例如:
http://127.0.0.1:8088/API/?Function=SetText&Input=877bb3e7-58bd-46a1-85ce-0d673aec6bf5&SelectedName=Headline.Text&Value=Hello
http://127.0.0.1:8088/API/?Function=SetImage&Input=877bb3e7-58bd-46a1-85ce-0d673aec6bf5&SelectedName=MyImage.Source&Value=filename.jpg
选择指数
指定要传递给输入的索引
以下输入支持SelectedIndex参数:
VideoList:从1开始播放的视频
虚拟设置:指定相机的缩放转换到
标题:指定要从0开始配置的文本项
价值
值与许多不同的API函数一起使用，包括以下函数。
有关使用值参数的函数的完整列表，请参阅快捷函数参考。
SetImage:指定在支持的XAML或Title输入的图像字段中显示的图像
SetText:指定要在上面的SelectedIndex指定的文本字段中显示的文本。
SetPosition:以毫秒为单位
SetCountdown:作为时间跨度(00:00:00)
SetFader: 0到255之间的数字
AddInput:指定Video/Image/Photos或Xaml输入文件名，格式如下:
Video|c:\filename.wmv
Image|c:\filename.jpg
...
混合
在4K和专业版中，可提供三个单独的Mix输入。
这个参数可以用来选择要使用的Mix, 0 = main mix, 1 = first Mix input, 2 = second Mix input等等。
通道
一些重放函数可以应用于特定的通道。如果此参数为空，则在重放用户界面中默认为当前选择的通道。
取值为A、B、Current或留空。
返回
如果成功，API将返回标准的200响应代码。
如果发生错误，API将返回标准的500错误代码。
信息
如果所有参数都为空，API将以XML格式返回状态信息。
以下是XML输出的示例:
<vmix>
<version>11.0.0.16</version>
<inputs>
<input key="26cae087-b7b6-4d45-98e4-de03ab4feb6b" number="1" type="Xaml" title="NewsHD.xaml" state="Paused" position="0" duration="0" muted="True" loop="False" selectedIndex="0">
NewsHD.xaml
<text index="0" name="Headline">Hello</text>
<text index="1" name="Description">Hello</text>
</input>
<input key="55cbe357-a801-4d54-8ff2-08ee68766fae" number="2" type="VirtualSet" title="LateNightNews" state="Paused" position="0" duration="0" muted="True" loop="False" selectedIndex="0">
LateNightNews
<overlay index="0" key="2fe8ff9d-e400-4504-85ab-df7c17a1edd4"/>
<overlay index="1" key="20e4ee9a-05cc-4f58-bb69-cd179e1c1958"/>
<overlay index="2" key="94b88db0-c5cd-49d8-98a2-27d83d4bf3fe"/>
</input>
</inputs>
<overlays>
<overlay number="1"/>
<overlay number="2">1</overlay>
<overlay number="3"/>
<overlay number="4"/>
<overlay number="5"/>
<overlay number="6"/>
</overlays>
<preview>1</preview>
<active>2</active>
<fadeToBlack>False</fadeToBlack>
<transitions>
<transition number="1" effect="Fade" duration="500"/>
<transition number="2" effect="Wipe" duration="500"/>
<transition number="3" effect="Fly" duration="500"/>
<transition number="4" effect="CubeZoom" duration="3000"/>
</transitions>
<recording>False</recording>
<external>False</external>
<streaming>False</streaming>
<playList>False</playList>
<multiCorder>False</multiCorder>
</vmix>
在上面的例子中，输入2是活动的，输入1当前作为叠加2运行。
新浪微博
关注@vMixchina
官方微信公众号
新浪微博
关注@vMixhd
官方微信公众号
