StudioScreenshotCapture
Represents a single screenshot captured from Studio, exposing the resulting image buffer and the parameters the capture was taken with.
| Memory category | Instances |
|---|
Member index 9
Description
Studio-only capture result that requires plugin security — not available in
published experiences. Produced by
CaptureScreenshot() and
CapturePluginGui(). It holds the encoded image data together with the region
and format used for the capture, and reports progress through
BufferStatus.
The image is populated asynchronously. BufferStatus defaults to StudioCaptureBufferStatus.NotStarted, becomes StudioCaptureBufferStatus.Pending while capturing and encoding, StudioCaptureBufferStatus.Ready once the image is available, or StudioCaptureBufferStatus.Error if capture failed. Retrieve the image with GetBuffer(), read failure details with GetErrors(), and produce a resized copy with ScaleAsync().
History 10
- 714 Add ScaleAsync
- 714 Add GetErrors
- 714 Add GetBuffer
- 714 Add UICaptureMode
- 714 Add Resolution
- 714 Add Position
- 714 Add OriginalSize
- 714 Add BufferStatus
- 714 Add BufferFormat
- 714 Add StudioScreenshotCapture
Members 9
BufferFormat
| Type | Default | |
|---|---|---|
| StudioCaptureScreenshotFormat | RGBA8 | |
The StudioCaptureScreenshotFormat the capture's image data is
encoded in, and therefore the format of the buffer returned by
GetBuffer(). Defaults to
StudioCaptureScreenshotFormat.RGBA8, in which the buffer holds four
bytes (red, green, blue, alpha) per pixel; when
StudioCaptureScreenshotFormat.PNG, the buffer holds a PNG-encoded
image. This property is read-only and reflects the Format requested when
the capture was created.
| Security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | false/true |
History 1
- 714 Add BufferFormat
BufferStatus
| Type | Default | |
|---|---|---|
| StudioCaptureBufferStatus | NotStarted | |
The StudioCaptureBufferStatus describing where the capture is in its lifecycle. Defaults to StudioCaptureBufferStatus.NotStarted, is set to StudioCaptureBufferStatus.Pending while the image is being captured and encoded, becomes StudioCaptureBufferStatus.Ready once the image data is available, and becomes StudioCaptureBufferStatus.Error if the capture fails. Only when the value is StudioCaptureBufferStatus.Ready does GetBuffer() return image data; otherwise that method raises an error. This property is read-only.
| Security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | false/true |
History 1
- 714 Add BufferStatus
GetBuffer
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| buffer | ||
Returns the captured screenshot as a buffer encoded in the capture's
BufferFormat. This method
only succeeds when
BufferStatus is
StudioCaptureBufferStatus.Ready; if the image is not yet available
or the capture failed, it raises an error instead of returning a buffer.
| Security | PluginSecurity |
|---|---|
| Thread safety | Unsafe |
GetErrors
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
Returns an array of the error messages recorded for this capture. The array is empty when no errors have occurred; when BufferStatus is StudioCaptureBufferStatus.Error, it contains one or more messages describing why the capture or scale failed.
| Security | PluginSecurity |
|---|---|
| Thread safety | Unsafe |
OriginalSize
| Type | Default | |
|---|---|---|
| Vector2 | 0, 0 | |
The pixel size of the capturable region measured from Position to the bottom-right corner of the Studio view, computed as the screen resolution minus the capture position and clamped to be non-negative. It describes the source area before any cropping or scaling, as distinct from Resolution, which is the pixel size of the encoded image. This property is read-only.
| Security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | false/true |
History 1
- 714 Add OriginalSize
Position
| Type | Default | |
|---|---|---|
| Vector2 | 0, 0 | |
The pixel offset of the top-left corner of the captured region from the
top-left of the Studio view. It reflects the Position supplied when the
capture was requested, defaulting to (0, 0) when none is given. This
property is read-only.
| Security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | false/true |
Resolution
| Type | Default | |
|---|---|---|
| Vector2 | 0, 0 | |
The width and height, in pixels, of the encoded image held by the capture. It is set once the image has been captured and encoded (when BufferStatus becomes StudioCaptureBufferStatus.Ready), and for a capture produced by ScaleAsync() it equals the requested output size. This property is read-only.
| Security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | false/true |
History 1
- 714 Add Resolution
ScaleAsync
| Parameters (2) | ||
|---|---|---|
| strategy | ResamplerMode | |
| newSize | Vector2 | |
| Returns (1) | ||
| StudioScreenshotCapture | ||
Returns a new StudioScreenshotCapture whose image is computed from
this capture, resized to newSize using the given ResamplerMode.
The original capture is not modified. ResamplerMode.Default
resamples with bilinear filtering, while ResamplerMode.Pixelated
uses nearest-neighbor (point) sampling; the scaled capture inherits this
capture's Position,
OriginalSize,
BufferFormat, and
UICaptureMode.
This method yields until the scaled image has been encoded. It errors if
newSize is not positive, or if this capture's
BufferStatus is not
StudioCaptureBufferStatus.Ready.
| Security | PluginSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 714 Add ScaleAsync
UICaptureMode
| Type | Default | |
|---|---|---|
| UICaptureMode | All | |
The UICaptureMode that determines which user interface is
composited into the captured image. Defaults to UICaptureMode.All,
meaning all UI is included, and reflects the UICaptureMode requested
when the capture was created. This property is read-only.
| Security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | false/true |
History 1
- 714 Add UICaptureMode