Skip to content

Commit f3594c5

Browse files
update Open Source Docs from Roblox internal teams
1 parent c0bf7a5 commit f3594c5

File tree

2 files changed

+22
-58
lines changed

2 files changed

+22
-58
lines changed

content/common/navigation/engine/guides.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ navigation:
345345
path: /sound/objects
346346
- title: Groups
347347
path: /sound/groups
348-
- title: Dynamic Effects
348+
- title: Dynamic effects
349349
path: /sound/dynamic-effects
350350
- title: User interface
351351
path: /ui/

content/en-us/reference/engine/classes/CaptureService.yaml

Lines changed: 21 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ name: CaptureService
22
type: class
33
memory_category: Instances
44
summary: |
5-
A service which provides control over screenshot and video capture features.
5+
A service which provides control over screenshot capture features.
66
description: |
7-
`CaptureService` is a client-side service that allows developers to control
8-
how the screenshot and video capture feature integrates with their experiences.
9-
It can be used to include preset moments where a capture is automatically
10-
taken for a user, and that user can then save, share, or delete the capture.
7+
**CaptureService** is a client-side service that allows developers to control
8+
how the screenshot capture feature integrates with their experiences. It can
9+
be used to include preset moments where a screenshot is automatically taken
10+
for a user, and that user can then save, share, or delete the screenshot.
1111
code_samples: []
1212
inherits:
1313
- Instance
@@ -61,7 +61,7 @@ methods:
6161
summary: |
6262
Prompts the user to save specified captures to their gallery.
6363
description: |
64-
This method prompts the user to save the captures identified by the
64+
This method prompts the user to save the screenshots identified by the
6565
provided `contentIds` to their **Captures** gallery within the
6666
experience's main menu.
6767
code_samples: []
@@ -88,14 +88,14 @@ methods:
8888
writeCapabilities: []
8989
- name: CaptureService:PromptShareCapture
9090
summary: |
91-
Prompts the user to share a specified capture.
91+
Prompts the user to share a specified screenshot capture.
9292
description: |
93-
This method prompts the user to share the capture identified by the
93+
This method prompts the user to share the screenshot identified by the
9494
provided `contentId` using the native share sheet on their device.
9595
96-
The capture is shared along with an invite link to the experience
97-
when supported. Not all devices support including both a screenshot or video
98-
and an invite link.
96+
The capture image is shared along with an invite link to the experience
97+
when supported. Not all devices support including both a screenshot and
98+
invite link.
9999
100100
The `launchData` will be available in the `launchData` field for users who
101101
join through the invite link.
@@ -134,13 +134,8 @@ methods:
134134
capabilities: []
135135
writeCapabilities: []
136136
- name: CaptureService:StopVideoCapture
137-
summary: |
138-
Ends a video capture initiated by
139-
`Class.CaptureService:StartVideoCaptureAsync()|StartVideoCaptureAsync()`.
140-
description: |
141-
This method ends a video capture that was started by the
142-
`Class.CaptureService:StartVideoCaptureAsync()|StartVideoCaptureAsync()`
143-
method.
137+
summary: ''
138+
description: ''
144139
code_samples: []
145140
parameters: []
146141
returns:
@@ -175,51 +170,20 @@ methods:
175170
capabilities: []
176171
writeCapabilities: []
177172
- name: CaptureService:StartVideoCaptureAsync
178-
summary: |
179-
Initiates a video capture recording.
180-
description: |
181-
This method initiates a video capture recording. The recording will
182-
continue until the `Class.CaptureService:StopVideoCapture()|StopVideoCapture()`
183-
method is called, or when 30 seconds have passed, whichever comes first.
184-
185-
During the video recording, all user voices are muted.
186-
187-
The `onCaptureReady` callback can be used to prompt the user to save or
188-
share the video capture.
189-
190-
```lua
191-
local CaptureService = game:GetService("CaptureService")
192-
193-
local onCaptureReady = function(videoCapture, result)
194-
if result ~= Enum.VideoCaptureResult.Success or not videoCapture then
195-
print("Video recording failed to complete for reason: " .. tostring(result))
196-
else
197-
-- Prompt the user to save the video capture to their gallery
198-
CaptureService:PromptSaveCapturesToGallery({ Content.fromObject(videoCapture) })
199-
end
200-
end
201-
202-
local videoRecordingAllowedResult: Enum.VideoCaptureStartedResult = CaptureService:StartVideoCaptureAsync(onCaptureReady, {})
203-
204-
if videoRecordingAllowedResult ~= Enum.VideoCaptureStartedResult.Success then
205-
print("Video recording failed to start for reason: " .. tostring(videoRecordingAllowedResult))
206-
end
207-
```
173+
summary: ''
174+
description: ''
208175
code_samples: []
209176
parameters:
210177
- name: onCaptureReady
211178
type: Function
212179
default: ''
213-
summary: |
214-
A callback function that is called with the `Class.VideoCapture`
215-
object and the result of type `Enum.VideoCaptureResult` of the video capture
216-
once it is ready.
180+
summary: ''
217181
- name: captureParams
218182
type: Dictionary
219183
default: nil
220184
summary: ''
221185
returns:
222-
- type: VideoCaptureStartedResult
186+
- type: VideoCaptureResult
223187
summary: ''
224188
tags:
225189
- Yields
@@ -233,9 +197,9 @@ events:
233197
summary: |
234198
Fires immediately before a capture begins.
235199
description: |
236-
This event fires right before a new capture is taken. It can be
237-
used to customize the capture experience, for example by hiding
238-
certain GUI elements.
200+
This event fires right before a new screenshot capture is taken. It can be
201+
used to customize the capture experience, for example by hiding certain
202+
GUI elements.
239203
code_samples: []
240204
parameters:
241205
- name: captureType
@@ -251,7 +215,7 @@ events:
251215
summary: |
252216
Fires after a capture finishes.
253217
description: |
254-
This event fires after a new capture completes. It can be used
218+
This event fires after a new screenshot capture completes. It can be used
255219
to restore any changes made when the
256220
`Class.CaptureService.CaptureBegan|CaptureBegan` event fired.
257221
code_samples: []

0 commit comments

Comments
 (0)