关键词

vMix控制视频制作广播自动化媒体控制远程控制

mcp-vmix 使用说明

项目简介

mcp-vmix 是一个基于 Model Context Protocol (MCP) 的服务器实现，它允许用户通过 MCP 客户端远程控制 vMix 视频制作软件。该服务器注册了一系列工具，可以执行 vMix 的各种操作，例如视频源切换、淡入淡出、录制和流媒体控制等。

主要功能点

  • 连接 vMix 实例: 允许 MCP 客户端连接到指定的 vMix 软件实例。
  • 视频切换: 支持快速切换 (Cut) 和平滑过渡 (Fade) 视频输入源。
  • 录制控制: 可以启动和停止 vMix 的录制功能。
  • 流媒体控制: 支持启动和停止 vMix 的流媒体直播功能。
  • 外部输出控制: 控制 vMix 的外部输出。
  • 多重录制器控制: 控制 vMix 的多重录制器功能。
  • 播放列表控制: 启动和停止 vMix 的播放列表。
  • 全屏控制: 切换 vMix 全屏显示。
  • 截图功能: 获取 vMix 当前输出或指定输入的截图。
  • 快捷方式 URL 生成: 生成 vMix 快捷方式 URL，方便用户通过 URL 触发 vMix 功能。
  • 添加空白输入: 向 vMix 添加空白视频输入源。
  • 场景制作: 在 vMix 中创建复杂的合成场景，支持多图层配置。

安装步骤

  1. 安装 Go 环境: 确保你的系统已安装 Go 语言环境（版本 1.16 或更高）。
  2. 获取项目代码: 使用 'go install' 命令安装 'mcp-vmix' 项目。 
    go install github.com/FlowingSPDG/mcp-vmix/cmd/main@latest
    安装成功后，'mcp-vmix' 可执行文件通常会安装在 '$GOPATH/bin' 或 '$HOME/go/bin' 目录下。

服务器配置

MCP 客户端需要配置服务器的启动命令和参数才能连接到 mcp-vmix 服务器。以下是一个示例 JSON 格式的配置信息，你需要将其配置到你的 MCP 客户端中。

{
  "serverName": "vmix-mcp-server",
  "command": "mcp-vmix",
  "transport": "stdio",
  "args": [],
  "description": "vMix MCP Server",
  "capabilities": [
    "tool_execution"
  ]
}

配置参数说明:

  • 'serverName': 服务器的名称，可以自定义。
  • 'command': 启动 mcp-vmix 服务器的命令。 如果 'mcp-vmix' 可执行文件目录已添加到系统环境变量 'PATH' 中，则可以直接使用 'mcp-vmix'。否则，需要填写 'mcp-vmix' 可执行文件的完整路径。
  • 'transport': 传输协议，这里使用 'stdio' (标准输入输出)。
  • 'args': 启动参数，mcp-vmix 服务器本身不需要额外的启动参数，因此为空数组 '[]'。
  • 'description': 服务器描述，可以自定义。
  • 'capabilities': 声明服务器能力，'tool_execution' 表示支持工具执行。

基本使用方法

  1. 启动 MCP 服务器: 在安装了 'mcp-vmix' 的环境中，打开终端或命令提示符，直接运行 'mcp-vmix' 命令即可启动服务器。服务器默认使用 Stdio 传输协议，并通过标准输入输出与 MCP 客户端通信。
  2. 配置 MCP 客户端: 在 MCP 客户端中，根据上述 “服务器配置” 章节的示例，配置 mcp-vmix 服务器的连接信息。
  3. 调用工具: 通过 MCP 客户端，可以调用 mcp-vmix 服务器注册的工具来控制 vMix。例如，要执行视频切换，可以调用 'vmix_cut' 工具，并提供 vMix 实例的 IP 地址、端口以及要切换的输入源等参数。

示例工具调用 (概念性, MCP 客户端操作):

假设要调用 'vmix_cut' 工具切换到 Input 1，你需要构造一个 MCP 请求，指定工具名称为 'vmix_cut'，并提供相应的参数，例如：

{
  "method": "Tool.Execute",
  "params": {
    "tool_name": "vmix_cut",
    "arguments": {
      "IP": "127.0.0.1",
      "Port": 8088,
      "Input": "1"
    }
  },
  "id": "some-request-id"
}

具体的工具参数和使用方法，请参考 'args.go' 文件中定义的参数结构体，以及 'mcpvmix.go' 文件中每个工具函数的描述。

注意: 使用前请确保 vMix 软件已正确安装并运行，并且 MCP 服务器能够通过配置的 IP 地址和端口访问到 vMix 实例。

信息

分类

桌面与硬件

访问项目