openVideoMixProjector method

Future<void> openVideoMixProjector(
  1. String videoMixType, {
  2. int? monitorIndex = -1,
  3. String? projectorGeometry,
})

Opens a projector for a specific output video mix.

Mix types:

  • OBS_WEBSOCKET_VIDEO_MIX_TYPE_PREVIEW
  • OBS_WEBSOCKET_VIDEO_MIX_TYPE_PROGRAM
  • OBS_WEBSOCKET_VIDEO_MIX_TYPE_MULTIVIEW

Note: This request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.

  • Complexity Rating: 3/5
  • Latest Supported RPC Version: 1
  • Added in v5.0.0

Implementation

Future<void> openVideoMixProjector(String videoMixType,
        {int? monitorIndex = -1, String? projectorGeometry}) async =>
    await obsWebSocket.sendRequest(Request(
      'OpenVideoMixProjector',
      requestData: {
        'videoMixType': videoMixType,
        'monitorIndex': monitorIndex,
        'projectorGeometry': projectorGeometry,
      }..removeWhere((key, value) => value == null),
    ));