openSourceProjector method

Future<void> openSourceProjector(
  1. String? sourceName, {
  2. String? sourceUuid,
  3. String? canvasUuid,
  4. int? monitorIndex = -1,
  5. String? projectorGeometry,
})

Opens a projector for a source.

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> openSourceProjector(
  String? sourceName, {
  String? sourceUuid,
  String? canvasUuid,
  int? monitorIndex = -1,
  String? projectorGeometry,
}) async {
  if (sourceName == null && sourceUuid == null) {
    throw ArgumentError('sourceName or sourceUuid must be provided');
  }

  await obsWebSocket.sendRequest(
    Request(
      'OpenSourceProjector',
      requestData: {
        'sourceName': ?sourceName,
        'sourceUuid': ?sourceUuid,
        'canvasUuid': ?canvasUuid,
        'monitorIndex': monitorIndex,
        'projectorGeometry': projectorGeometry,
      },
    ),
  );
}