VideoSampler
An object for sampling frames from video content.
This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
| Memory category | Instances |
|---|
Member index 3
| History | Member | |
|---|---|---|
| 698 | TimeLength: double | |
| 698 | VideoContent: Content | |
| 698 | GetSamplesAtTimesAsync(times: Array): Array | |
| inherited from Object | ||
| 647 | ClassName: string | |
| 647 | className: string | |
| 647 | GetPropertyChangedSignal(property: string): RBXScriptSignal | |
| 647 | IsA(className: string): bool | |
| 650 | isA(className: string): bool | |
| 647 | Changed(property: string) | |
Description
This object lets you get image frames from selected timestamps of a video. To create a VideoSampler, call VideoService:CreateVideoSamplerAsync().
History 5
- 709 Change Tags of VideoSampler from [NotCreatable] to [NotCreatable, NotReplicated]
- 698 Add GetSamplesAtTimesAsync
- 698 Add VideoContent
- 698 Add TimeLength
- 698 Add VideoSampler
Members 3
GetSamplesAtTimesAsync
| Parameters (1) | ||
|---|---|---|
| times | Array | |
| Returns (1) | ||
| Array | ||
This method allows you to get a set of image frames from a video at specified timestamps as image Content objects.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
TimeLength
| Type | Default | |
|---|---|---|
| double | __api_dump_failed_to_create_class__ | |
The length of the VideoContent in seconds.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 1
- 698 Add TimeLength
VideoContent
| Type | Default | |
|---|---|---|
| Content | ||
The asset loaded into the VideoSampler.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 1
- 698 Add VideoContent