active method

Future<SourceActiveResponse> active(
  1. String? sourceName, {
  2. String? sourceUuid,
  3. String? canvasUuid,
})

Gets the active and show state of a source.

Compatible with inputs and scenes.

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

Implementation

Future<SourceActiveResponse> active(
  String? sourceName, {
  String? sourceUuid,
  String? canvasUuid,
}) async {
  if (sourceName == null && sourceUuid == null) {
    throw ArgumentError('sourceName or sourceUuid must be provided');
  }

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

  return SourceActiveResponse.fromJson(response!.responseData!);
}