Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

TakeSourceScreenshot: fix docs

Browse Source
This commit is contained in:
Stéphane L 2019-04-26 21:18:20 +02:00
parent 2e3a24d32e
commit f5ae89500f
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/WSRequestHandler_Sources.cpp
View File

@ -1339,12 +1339,14 @@ HandlerResponse WSRequestHandler::HandleSetSourceFilterSettings(WSRequestHandler
}
/**
* Take a picture snapshot of a source and sends it in the response a Data URI (base64-encoded data)
* Takes a picture snapshot of a source and sends it in the response a Data URI (base64-encoded data)
* Clients can specify `width` and `height` parameters to receive scaled pictures. Aspect ratio is
* preserved if only one of these two parameters is specified.
*
* @param {String} `sourceName` Source name
* @param {String} `pictureFormat` Format of the encoded picture. Can be "png", "jpg", "jpeg" or "bmp" (or any other value supported by Qt's Image module)
* @param {int (optional)} `width` Screenshot width. Defaults to the source's base width.
* @param {int (optional)} `height` Screenshot height. Defaults to the source's base heigh.
* @param {int (optional)} `width` Screenshot width. Defaults to the source's base width.
* @param {int (optional)} `height` Screenshot height. Defaults to the source's base height.
*
* @return {String} `sourceName` Source name
* @return {String} `img` Image Data URI