Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2022.1.17.8543 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2022.1.17
ak.wwise.ui.captureScreen

Captures a part of the Wwise UI relative to a view.

Arguments

Name Type Description
viewName string The name of the view as displayed in Wwise UI. By default, the whole UI is captured.
viewSelectionChannel integer The selection channel of the view. Can be a value of 1, 2, 3 or 4. By default, the current selection channel of the view is detected automatically.
rect object The capture region. By default, the whole view is captured.
rect.x * integer The left position of the capture region (in pixels).
rect.y * integer The top position of the capture region (in pixels).
rect.width * integer The width of the capture region (in pixels).
rect.height * integer The height of the capture region (in pixels).

Arguments Schema

Result

Name Type Description
contentType string The underlying image data format (e.g. image/png).
contentBase64 string The encoded image data (Base64).

Result Schema

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise