createSceneItem method

Future<int> createSceneItem({ String? sceneName, String? sceneUuid, String? canvasUuid, String? sourceName, String? sourceUuid, bool? sceneItemEnabled, })

Creates a new scene item using a source.

Scenes only

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

Implementation

Future<int> createSceneItem({
  String? sceneName,
  String? sceneUuid,
  String? canvasUuid,
  String? sourceName,
  String? sourceUuid,
  bool? sceneItemEnabled,
}) async {
  if (sceneName == null && sceneUuid == null) {
    throw ArgumentError('sceneName or sceneUuid must be provided');
  }
  if (sourceName == null && sourceUuid == null) {
    throw ArgumentError('sourceName or sourceUuid must be provided');
  }

  final response = await obsWebSocket.sendRequest(
    Request(
      'CreateSceneItem',
      requestData: {
        'sceneName': ?sceneName,
        'sceneUuid': ?sceneUuid,
        'canvasUuid': ?canvasUuid,
        'sourceName': ?sourceName,
        'sourceUuid': ?sourceUuid,
        'sceneItemEnabled': ?sceneItemEnabled,
      },
    ),
  );

  return IntegerResponse.fromJson(response!.responseData!).itemId;
}