getSceneItemIndex method

Future<int> getSceneItemIndex({ String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId, })

Gets the index position of a scene item in a scene.

An index of 0 is at the bottom of the source list in the UI.

Scenes and Groups

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

Implementation

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

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