screenshot method

Future<SourceScreenshotResponse> screenshot(
  1. SourceScreenshot sourceScreenshot
)

Gets a Base64-encoded screenshot of a source.

The imageWidth and imageHeight parameters are treated as "scale to inner", meaning the smallest ratio will be used and the aspect ratio of the original resolution is kept. If imageWidth and imageHeight are not specified, the compressed image will use the full resolution of the source.

Compatible with inputs and scenes.

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

Implementation

Future<SourceScreenshotResponse> screenshot(
    SourceScreenshot sourceScreenshot) async {
  final response = await obsWebSocket.sendRequest(Request(
    'GetSourceScreenshot',
    requestData: sourceScreenshot.toJson(),
  ));

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