From e2f865939c8246abe4053d9452a97bd5e2b02fc0 Mon Sep 17 00:00:00 2001 From: Steven Goff Date: Fri, 7 Jul 2023 12:45:29 -0500 Subject: [PATCH] Update media.mdx Explain that there is a known issue of getScreenshotUrl not behaving as expected in a DX12 game. --- website/pages/docs/api/media/media.mdx | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/website/pages/docs/api/media/media.mdx b/website/pages/docs/api/media/media.mdx index 973ad82f1b4..ea1c634d790 100644 --- a/website/pages/docs/api/media/media.mdx +++ b/website/pages/docs/api/media/media.mdx @@ -199,6 +199,17 @@ overwolf.media.getScreenshotUrl( ); ``` +### Known Issues +overwolf.media.getScreenshotUrl in any DX12 game always returns the following result: +```json +{ + success: false, + status: 'error', + error: 'Capture failed' +} +``` +This is a known limitation of the current implementation. There is a workaround using overwolf.media.takeScreenshot and deleting the screenshot afterward but it's less performant. + ## shareImage(image, description, callback) #### Version added: 0.78 @@ -503,4 +514,4 @@ url | string "success": true, "url": "" } -``` \ No newline at end of file +```