Reference API Roblox

Engine API

Website

Related

Reference API Roblox

CaptureService

Summary

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service]

Member index 26

HistoryMember
608CaptureScreenshot(onCaptureReady: Function): null
593DeleteCapture(capturePath: string): null
620DeleteCapturesAsync(pathArr: Array): int64
610GetCaptureFilePathAsync(captureContentId: Content): string
587GetCaptureSizeAsync(captureContentId: Content): Vector2
617GetCaptureStorageSizeAsync(pathArr: Array): int64
605OnCaptureBegan(): null
605OnCaptureEnded(): null
625OnCaptureShared(capturePath: string): null
605OnSavePromptFinished(promptId: int64, results: Dictionary): null
604OnSharePromptFinished(promptId: int64, accepted: bool): null
605PromptSaveCapturesToGallery(contentIds: Array, resultCallback: Function): null
605PromptShareCapture(contentId: Content, launchData: string, onAcceptedCallback: Function, onDeniedCallback: Function): null
583RetrieveCaptures(): Array
601SaveCaptureToExternalStorage(capturePath: string): null
625SaveCapturesToExternalStorageAsync(pathArr: Array): int64
580SaveScreenshotCapture(): null
605CaptureBegan()
605CaptureEnded()
605CaptureSaved(captureInfo: Dictionary)
626CaptureSavedInternal(captureInfo: Dictionary, triggerSource: string)
605OpenSaveCapturesPrompt(promptId: int64, contentIds: Array)
610OpenShareCapturePrompt(promptId: int64, contentId: Content, launchData: string)
604UserCaptureSaved(captureContentId: Content)
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 1

HistoryMember
583RetreiveCaptures(): Array

History 43

Members 26

CaptureBegan

Parameters (0)
No parameters.

History 1

CaptureEnded

Parameters (0)
No parameters.

History 1

CaptureSaved

Parameters (1)
captureInfoDictionary

History 2

CaptureSavedInternal

Parameters (2)
captureInfoDictionary
triggerSourcestring

History 2

CaptureScreenshot

Parameters (1)
onCaptureReadyFunction
Returns (1)
null

History 1

DeleteCapture

Parameters (1)
capturePathstring
Returns (1)
null

History 1

DeleteCapturesAsync

Parameters (1)
pathArrArray
Returns (1)
int64
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetCaptureFilePathAsync

Parameters (1)
captureContentIdContent
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetCaptureSizeAsync

Parameters (1)
captureContentIdContent
Returns (1)
Vector2
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetCaptureStorageSizeAsync

Parameters (1)
pathArrArray
Returns (1)
int64
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

OnCaptureBegan

Parameters (0)
No parameters.
Returns (1)
null

History 1

OnCaptureEnded

Parameters (0)
No parameters.
Returns (1)
null

History 1

OnCaptureShared

Parameters (1)
capturePathstring
Returns (1)
null

History 1

OnSavePromptFinished

Parameters (2)
promptIdint64
resultsDictionary
Returns (1)
null

History 1

OnSharePromptFinished

Parameters (2)
promptIdint64
acceptedbool
Returns (1)
null

History 3

OpenSaveCapturesPrompt

Parameters (2)
promptIdint64
contentIdsArray

History 1

OpenShareCapturePrompt

Parameters (3)
promptIdint64
contentIdContent
launchDatastring

History 5

PromptSaveCapturesToGallery

Parameters (2)
contentIdsArray
resultCallbackFunction
Returns (1)
null

History 1

PromptShareCapture

Parameters (4)
contentIdContent
launchDatastring
onAcceptedCallbackFunction
onDeniedCallbackFunction
Returns (1)
null

History 4

RetrieveCaptures

Parameters (0)
No parameters.
Returns (1)
Array

History 1

SaveCaptureToExternalStorage

Parameters (1)
capturePathstring
Returns (1)
null

History 1

SaveCapturesToExternalStorageAsync

Parameters (1)
pathArrArray
Returns (1)
int64
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

SaveScreenshotCapture

Parameters (0)
No parameters.
Returns (1)
null

History 1

UserCaptureSaved

Parameters (1)
captureContentIdContent

History 3

Removed members 1

RetreiveCaptures

Parameters (0)
No parameters.
Returns (1)
Array

History 2

Settings