CaptureService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

This class is a service. It is a singleton that may be acquired with GetService.

This item is not replicated. Its interface does not cross the network boundary.

Memory Category	Instances

Tags: [NotCreatable, Service, NotReplicated]

Inherits (1)

Instance

Member index (17)

Type	Member	History
null	DeleteCapture (string capturePath)	593
Vector2	GetCaptureSizeAsync (Content captureContentId)	587
null	OnCaptureBegan ()	605
null	OnCaptureEnded ()	605
null	OnSavePromptFinished (int64 promptId, Dictionary results)	605
null	OnSharePromptFinished (int64 promptId, bool accepted)	604 603 604
null	PromptSaveCapturesToGallery (Array contentIds, Function resultCallback)	605
null	PromptShareCapture (Content contentId, string launchData, Function onAcceptedCallback, Function onDeniedCallback)	604 603 604 605
Array	RetrieveCaptures ()	583
null	SaveCaptureToExternalStorage (string capturePath)	601
null	SaveScreenshotCapture ()
	CaptureBegan ()	605
	CaptureEnded ()	605
	CaptureSaved (Dictionary captureInfo)	587 605
	OpenSaveCapturesPrompt (int64 promptId, Array contentIds)	605
	OpenShareCapturePrompt (int64 promptId, Content contentId, string capturePath, string launchData)	604 603 604 605
	UserCaptureSaved (Content captureContentId)	604 603 604
57 members inherited from Instance

Removed member index (1)

Type		Member	History
Array		RetreiveCaptures ()	583

605 Add CaptureService.OnCaptureBegan
605 Add CaptureService.OnCaptureEnded
605 Add CaptureService.OnSavePromptFinished
605 Add CaptureService.PromptSaveCapturesToGallery
605 Change Parameters of CaptureService.PromptShareCapture from (Content contentId, Dictionary launchData, Function onAcceptedCallback, Function onDeniedCallback) to (Content contentId, string launchData, Function onAcceptedCallback, Function onDeniedCallback)
605 Add CaptureService.CaptureBegan
605 Add CaptureService.CaptureEnded
605 Change Security of CaptureService.CaptureSaved from RobloxScriptSecurity to None
605 Add CaptureService.OpenSaveCapturesPrompt
605 Change Parameters of CaptureService.OpenShareCapturePrompt from (int64 promptId, Content contentId, string capturePath, Dictionary launchData) to (int64 promptId, Content contentId, string capturePath, string launchData)
604 Add CaptureService.OnSharePromptFinished
604 Add CaptureService.PromptShareCapture
604 Add CaptureService.OpenShareCapturePrompt
604 Add CaptureService.UserCaptureSaved
603 Remove CaptureService.OnSharePromptFinished
603 Remove CaptureService.PromptShareCapture
603 Remove CaptureService.OpenShareCapturePrompt
603 Remove CaptureService.UserCaptureSaved
604 Add CaptureService.OnSharePromptFinished
604 Add CaptureService.PromptShareCapture
604 Add CaptureService.OpenShareCapturePrompt
604 Add CaptureService.UserCaptureSaved
601 Add CaptureService.SaveCaptureToExternalStorage
593 Add CaptureService.DeleteCapture
587 Add CaptureService.GetCaptureSizeAsync
587 Add CaptureService.CaptureSaved
583 Remove CaptureService.RetreiveCaptures
583 Add CaptureService.RetrieveCaptures
580 Add CaptureService

Members

CaptureBegan On DevHub

Parameters	0

Name	Type	Default
No parameters.

History

605 Add CaptureService.CaptureBegan

CaptureEnded On DevHub

Parameters	0

Name	Type	Default
No parameters.

History

605 Add CaptureService.CaptureEnded

CaptureSaved On DevHub

Parameters	1

Name	Type	Default
captureInfo	Dictionary	none

History

605 Change Security of CaptureService.CaptureSaved from RobloxScriptSecurity to None
587 Add CaptureService.CaptureSaved

DeleteCapture On DevHub

Parameters	1

Name	Type	Default
capturePath	string	none

Return Type	null
Security	RobloxScriptSecurity

History

593 Add CaptureService.DeleteCapture

GetCaptureSizeAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
captureContentId	Content	none

Return Type	Vector2
Security	RobloxScriptSecurity

History

587 Add CaptureService.GetCaptureSizeAsync

Tags: [Yields]

OnCaptureBegan On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	RobloxScriptSecurity

History

605 Add CaptureService.OnCaptureBegan

OnCaptureEnded On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	RobloxScriptSecurity

History

605 Add CaptureService.OnCaptureEnded

OnSavePromptFinished On DevHub

Parameters	2

Name	Type	Default
promptId	int64	none
results	Dictionary	none

Return Type	null
Security	RobloxScriptSecurity

History

605 Add CaptureService.OnSavePromptFinished

OnSharePromptFinished On DevHub

Parameters	2

Name	Type	Default
promptId	int64	none
accepted	bool	none

Return Type	null
Security	RobloxScriptSecurity

History

604 Add CaptureService.OnSharePromptFinished
603 Remove CaptureService.OnSharePromptFinished
604 Add CaptureService.OnSharePromptFinished

OpenSaveCapturesPrompt On DevHub

Parameters	2

Name	Type	Default
promptId	int64	none
contentIds	Array	none

Security	RobloxScriptSecurity

History

605 Add CaptureService.OpenSaveCapturesPrompt

OpenShareCapturePrompt On DevHub

Parameters	4

Name	Type	Default
promptId	int64	none
contentId	Content	none
capturePath	string	none
launchData	string	none

Security	RobloxScriptSecurity

History

605 Change Parameters of CaptureService.OpenShareCapturePrompt from (int64 promptId, Content contentId, string capturePath, Dictionary launchData) to (int64 promptId, Content contentId, string capturePath, string launchData)
604 Add CaptureService.OpenShareCapturePrompt
603 Remove CaptureService.OpenShareCapturePrompt
604 Add CaptureService.OpenShareCapturePrompt

PromptSaveCapturesToGallery On DevHub

Parameters	2

Name	Type	Default
contentIds	Array	none
resultCallback	Function	none

Return Type	null

History

605 Add CaptureService.PromptSaveCapturesToGallery

PromptShareCapture On DevHub

Parameters	4

Name	Type	Default
contentId	Content	none
launchData	string	none
onAcceptedCallback	Function	none
onDeniedCallback	Function	none

Return Type	null

History

605 Change Parameters of CaptureService.PromptShareCapture from (Content contentId, Dictionary launchData, Function onAcceptedCallback, Function onDeniedCallback) to (Content contentId, string launchData, Function onAcceptedCallback, Function onDeniedCallback)
604 Add CaptureService.PromptShareCapture
603 Remove CaptureService.PromptShareCapture
604 Add CaptureService.PromptShareCapture

RetrieveCaptures On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Array
Security	RobloxScriptSecurity

History

583 Add CaptureService.RetrieveCaptures

SaveCaptureToExternalStorage On DevHub

Parameters	1

Name	Type	Default
capturePath	string	none

Return Type	null
Security	RobloxScriptSecurity

History

601 Add CaptureService.SaveCaptureToExternalStorage

SaveScreenshotCapture On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	RobloxScriptSecurity

UserCaptureSaved On DevHub

Parameters	1

Name	Type	Default
captureContentId	Content	none

History

604 Add CaptureService.UserCaptureSaved
603 Remove CaptureService.UserCaptureSaved
604 Add CaptureService.UserCaptureSaved

Removed members

RetreiveCaptures

Parameters	0

Name	Type	Default
No parameters.

Return Type	Array
Security	RobloxScriptSecurity

History

583 Remove CaptureService.RetreiveCaptures