getSceneItemId method

Future<int> getSceneItemId({
  1. required String sceneName,
  2. required String sourceName,
  3. 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({
  required String sceneName,
  required String sourceName,
  int? searchOffset,
}) async {
  final response = await obsWebSocket.sendRequest(Request(
    'GetSceneItemId',
    requestData: {
      'sceneName': sceneName,
      'sourceName': sourceName,
      'searchOffset': searchOffset,
    }..removeWhere((key, value) => value == null),
  ));

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