Capture
A class which defines a piece of content, such as a screenshot or video, taken in-experience.
| Memory category | Instances |
|---|
Member index 6
| History | Member | |
|---|---|---|
| 731 | CaptureTime: DateTime | |
| 731 | CaptureType: CaptureType | |
| 731 | FilePathString: string | |
| 731 | LocalId: string | |
| 731 | SourcePlaceId: int64 | |
| 731 | SourceUniverseId: int64 | |
| inherited from Object | ||
| 731 | ClassName: string | |
| 731 | className: string | |
| 647 | GetPropertyChangedSignal(property: string): RBXScriptSignal | |
| 647 | IsA(className: string): bool | |
| 731 | isA(className: string): bool | |
| 647 | Changed(property: string) | |
Description
Represents a single piece of content — a screenshot or a video — captured within an experience. A Capture records metadata about that content, including when it was taken (Capture.CaptureTime), what kind of content it is (Capture.CaptureType), the place and experience it originated from (Capture.SourcePlaceId and Capture.SourceUniverseId), and where its underlying file is stored (Capture.LocalId and Capture.FilePathString).
History 19
- 731 Change Default of SourceUniverseId from to __api_dump_failed_to_create_class__
- 731 Change Default of SourcePlaceId from to __api_dump_failed_to_create_class__
- 731 Change Default of LocalId from to __api_dump_failed_to_create_class__
- 731 Change Default of FilePathString from to __api_dump_failed_to_create_class__
- 731 Change Default of CaptureType from to __api_dump_failed_to_create_class__
- 731 Change Default of CaptureTime from to
- 726 Change Default of SourceUniverseId from __api_dump_failed_to_create_class__ to
- 726 Change Default of SourcePlaceId from __api_dump_failed_to_create_class__ to
- 726 Change Default of LocalId from __api_dump_failed_to_create_class__ to
- 726 Change Default of FilePathString from __api_dump_failed_to_create_class__ to
- 726 Change Default of CaptureType from __api_dump_failed_to_create_class__ to
- 726 Change Default of CaptureTime from to
- 687 Add FilePathString
- 684 Add SourceUniverseId
- 684 Add SourcePlaceId
- 684 Add LocalId
- 684 Add CaptureType
- 684 Add CaptureTime
- 662 Add Capture
Members 6
CaptureTime
| Type | Default | |
|---|---|---|
| DateTime | ||
The date and time at which the capture was taken, as a DateTime. It defaults to the moment the Capture is created. This property is read-only.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 3
- 731 Change Default of CaptureTime from to
- 726 Change Default of CaptureTime from to
- 684 Add CaptureTime
CaptureType
| Type | Default | |
|---|---|---|
| CaptureType | __api_dump_failed_to_create_class__ | |
Indicates the kind of content the capture holds, as an CaptureType value. Defaults to CaptureType.Screenshot. This property is read-only.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 3
- 731 Change Default of CaptureType from to __api_dump_failed_to_create_class__
- 726 Change Default of CaptureType from __api_dump_failed_to_create_class__ to
- 684 Add CaptureType
FilePathString
| Type | Default | |
|---|---|---|
| string | __api_dump_failed_to_create_class__ | |
The path to the capture's file on the local filesystem, returned as a string. It resolves to the file backing the capture in local capture storage, or an empty string when no file is associated with the capture. This property is read-only.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | false/true |
History 3
- 731 Change Default of FilePathString from to __api_dump_failed_to_create_class__
- 726 Change Default of FilePathString from __api_dump_failed_to_create_class__ to
- 687 Add FilePathString
LocalId
| Type | Default | |
|---|---|---|
| string | __api_dump_failed_to_create_class__ | |
A local identifier for the capture's stored file, in the form
rbxtemp://<key>. It is empty until the capture has been saved to local
capture storage, after which it references the stored file by key. This
property is read-only.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
SourcePlaceId
| Type | Default | |
|---|---|---|
| int64 | __api_dump_failed_to_create_class__ | |
The PlaceId of the place in which the capture
was taken. Defaults to 0 when the source place is unknown or unset. This
property is read-only.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 3
- 731 Change Default of SourcePlaceId from to __api_dump_failed_to_create_class__
- 726 Change Default of SourcePlaceId from __api_dump_failed_to_create_class__ to
- 684 Add SourcePlaceId
SourceUniverseId
| Type | Default | |
|---|---|---|
| int64 | __api_dump_failed_to_create_class__ | |
The universe (experience) ID of the experience in which the capture was
taken. Defaults to 0 when the source universe is unknown or unset. This
property is read-only.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 3
- 731 Change Default of SourceUniverseId from to __api_dump_failed_to_create_class__
- 726 Change Default of SourceUniverseId from __api_dump_failed_to_create_class__ to
- 684 Add SourceUniverseId