StudioScreenshotCapture

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.

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.

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.

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.

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.

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.

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.

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.

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.