CaptureService

This method captures a screenshot for the user but does not immediately save it to their Captures gallery within the experience's main menu. Instead, a temporary contentId is created to identify the new capture.

Note that any screenshots taken by this method will not be accessible via ReadCapturesFromGalleryAsync() or be uploadable via UploadCaptureAsync().

The onCaptureReady callback can be used to prompt the user to save or share the screenshot:

Client-side function that checks the status of a capture upload started with StartUploadCaptureAsync(), using the returned token. Returns a tuple of the current UploadCaptureResult and, once the upload finishes successfully, the asset ID of the uploaded capture.

Poll until a terminal state. While processing, the result is UploadCaptureResult.UploadPending and the asset ID is 0. UploadCaptureResult.Success includes the final asset ID; UploadCaptureResult.CaptureModerated means moderation rejected the capture; UploadCaptureResult.UploadFailed means the upload did not complete.

This client-side function prompts a user for permission to access their local captures. Once they have accepted or rejected the prompt, it returns a boolean representing their choice. This function is a necessary prerequisite to ReadCapturesFromGalleryAsync and UploadCaptureAsync, as both of these require gallery permissions to work.

This method prompts the user to save the captures identified by the provided contentIds or Capture objects to their Captures gallery within the experience's main menu.

This method prompts the user to share the capture identified by the provided contentId or Capture object using the native share sheet on their device.

The capture is shared along with an invite link to the experience when supported. Not all devices support including both a screenshot or video and an invite link.

The launchData will be available in the launchData field for users who join through the invite link.

For users or devices who are not eligible to use share sheets, this method prompts them to download the capture instead.

This client-side function returns a paginated list of captures from the user's gallery as a CapturesPages object sorted reverse-chronologically, which can be used to iterate through the captures. The results can be filtered by capture type with the captureTypeFilters parameter. If this parameter isn't provided, the function returns all captures.

If readFromAllEligibleExperiences is true, captures from all eligible experiences will be read. If false, only those from the current experience will be read. Additionally, captures taken with CaptureScreenshot() and subsequently saved with PromptSaveCapturesToGallery() will not be returned by this method.

Client-side function that begins uploading a Capture (for example, one from ReadCapturesFromGalleryAsync()) to the asset system. Unlike UploadCaptureAsync(), which blocks until the asset is created, this returns as soon as the upload starts with a tuple of UploadCaptureResult and a token string. Use this when the user might leave before the upload finishes; a pending UploadCaptureAsync is lost if the player leaves. Pass the token to CheckUploadCaptureStatusAsync() to poll for completion and the resulting asset ID.

The user must grant gallery access through PromptCaptureGalleryPermissionAsync(); without it, the result is UploadCaptureResult.NeedPermission. The capture must be eligible and present in the gallery. Uploads are rate-limited per user and return UploadCaptureResult.UploadQuotaReached when exceeded.

This method initiates a video capture recording. The recording will continue until the StopVideoCapture() method is called, or when 30 seconds have passed, whichever comes first. During the video recording, all user voices are muted.

The onCaptureReady callback can be used to prompt the user to save or share the video capture.

The captureParams parameter is currently non-operational.

This method ends a video capture that was started by the StartVideoCaptureAsync() method.

This method initiates a screenshot capture. The onCaptureReady callback can be used to prompt the user to save or share the screenshot capture.

Use the UICaptureMode parameter in captureParams to specify whether UI elements should be in the screenshot. By default, this is set to UICaptureMode.None.

This client-side function uploads a capture, like one retrieved from ReadCapturesFromGalleryAsync, to the asset system. It returns a tuple of the result and the asset ID.

Notes:

• This function will only work properly if the Maturity and Compliance questionnaire has been filled out for the experience.
• For video capture types, there is an upload limit of 20 videos per day per user; when that limit is exceeded, the result is UploadCaptureResult.UploadQuotaReached, which lets you distinguish quota exhaustion from other failures.
• This function can take up to several minutes to finish executing, and the user will need to remain in the experience.

This event fires right before a new capture is taken. It can be used to customize the capture experience, for example by hiding certain GUI elements.

This event fires after a new capture completes. It can be used to restore any changes made when the CaptureBegan event fired.

Fires when a screenshot capture is saved to the user's gallery. Provides a captureInfo dictionary with contentId, filePath, and type. Fires only for screenshot captures, not video captures.

Deprecated; use UserCaptureSaved instead, which fires with the saved capture's contentId directly.

This event fires when the user saves a screenshot using the Roblox screenshot capture UI. It can be used for analytics or to prompt the user to share their capture.