getSceneItemId method

Future<int> getSceneItemId({
  1. String? sceneName,
  2. String? sceneUuid,
  3. String? canvasUuid,
  4. required String sourceName,
  5. int? searchOffset,
})

Searches a scene for a source, and returns its id.

Scenes and Groups

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

Implementation

Future<int> getSceneItemId({
  String? sceneName,
  String? sceneUuid,
  String? canvasUuid,
  required String sourceName,
  int? searchOffset,
}) async {
  final response = await obsWebSocket.sendRequest(
    Request(
      'GetSceneItemId',
      requestData: {
        ..._sceneData(sceneName, sceneUuid, canvasUuid),
        'sourceName': sourceName,
        'searchOffset': searchOffset,
      },
    ),
  );

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