update Open Source Docs from Roblox internal teams

Author: rbx-open-source-docs[bot]

content/common/navigation/engine/reference.yaml

@@ -3256,6 +3256,11 @@ navigation:
             type: engineapi
             source: /reference/engine/classes/TerrainWriteOperation.yaml
             ignoreTranslation: true
+          - title: VideoSampler
+            path: /reference/engine/classes/VideoSampler
+            type: engineapi
+            source: /reference/engine/classes/VideoSampler.yaml
+            ignoreTranslation: true
           - title: WebStreamClient
             path: /reference/engine/classes/WebStreamClient
             type: engineapi

content/en-us/reference/engine/STUDIO_VERSION

@@ -1,2 +1,2 @@
-0.697.0.6970925
-version-1e4ca3bb98a04c5f
+0.698.0.6980940
+version-4161ccb851314f72

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

@@ -23,8 +23,7 @@ code_samples:
 inherits:
   - Instance
 descendants: []
-tags:
-  - NotBrowsable
+tags: []
 deprecation_message: ''
 properties:
   - name: AudioSpeechToText.Enabled

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

@@ -24,6 +24,7 @@ descendants:
   - TerrainModifyOperation
   - TerrainReadOperation
   - TerrainWriteOperation
+  - VideoSampler
   - WebStreamClient
 tags:
   - NotCreatable

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

@@ -14,6 +14,7 @@ descendants: []
 tags:
   - NotCreatable
   - NotReplicated
+  - Deprecated
 deprecation_message: |
   This class is deprecated and should not be used for new work. Use
   `Class.HttpService` instead and see the
@@ -33,6 +34,7 @@ methods:
       - type: OpenCloudModel
         summary: ''
     tags:
+      - Deprecated
       - CustomLuaState
     deprecation_message: ''
     security: None
@@ -56,6 +58,7 @@ methods:
         summary: ''
     tags:
       - Yields
+      - Deprecated
     deprecation_message: ''
     security: None
     thread_safety: Unsafe

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

@@ -15,6 +15,7 @@ tags:
   - NotCreatable
   - Service
   - NotReplicated
+  - Deprecated
 deprecation_message: |
   This class is deprecated and should not be used for new work. Use
   `Class.HttpService` instead and see the
@@ -29,7 +30,8 @@ methods:
     returns:
       - type: OpenCloudApiV1
         summary: ''
-    tags: []
+    tags:
+      - Deprecated
     deprecation_message: ''
     security: None
     thread_safety: Unsafe
@@ -60,6 +62,7 @@ methods:
         summary: ''
     tags:
       - Yields
+      - Deprecated
     deprecation_message: ''
     security: None
     thread_safety: Unsafe

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

@@ -34,7 +34,8 @@ methods:
     returns:
       - type: Dictionary?
         summary: ''
-    tags: []
+    tags:
+      - CustomLuaState
     deprecation_message: ''
     security: None
     thread_safety: Unsafe
@@ -51,7 +52,8 @@ methods:
     returns:
       - type: Array
         summary: ''
-    tags: []
+    tags:
+      - CustomLuaState
     deprecation_message: ''
     security: None
     thread_safety: Unsafe
@@ -72,7 +74,8 @@ methods:
     returns:
       - type: Array
         summary: ''
-    tags: []
+    tags:
+      - CustomLuaState
     deprecation_message: ''
     security: None
     thread_safety: Unsafe

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

@@ -0,0 +1,104 @@
+# This file is automatically generated. Please don't edit it manually.
+# To submit a bug report on the content, see
+# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
+
+name: VideoSampler
+type: class
+memory_category: Instances
+summary: |
+  An object for sampling frames from video content.
+description: |
+  This object lets you get image frames from selected timestamps of a video. To
+  create a `Class.VideoSampler`, call
+  `Class.VideoService:CreateVideoSamplerAsync()`.
+code_samples: []
+inherits:
+  - Object
+descendants: []
+tags:
+  - NotCreatable
+deprecation_message: ''
+properties:
+  - name: VideoSampler.TimeLength
+    summary: |
+      The length of the `Class.VideoSampler.VideoContent|VideoContent` in
+      seconds.
+    description: |
+      The length of the `Class.VideoSampler.VideoContent|VideoContent` in
+      seconds.
+    code_samples: []
+    type: double
+    tags:
+      - ReadOnly
+      - NotReplicated
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Data
+    serialization:
+      can_load: false
+      can_save: true
+    capabilities: []
+  - name: VideoSampler.VideoContent
+    summary: |
+      The asset loaded into the `Class.VideoSampler`.
+    description: |
+      The asset loaded into the `Class.VideoSampler`.
+    code_samples: []
+    type: Content
+    tags:
+      - ReadOnly
+      - NotReplicated
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Data
+    serialization:
+      can_load: false
+      can_save: true
+    capabilities: []
+methods:
+  - name: VideoSampler:GetSamplesAtTimesAsync
+    summary: |
+      Gets image frames at the specified timestamps.
+    description: |
+      This method allows you to get a set of image frames from a video at
+      specified timestamps as image `Datatype.Content` objects.
+    code_samples: []
+    parameters:
+      - name: times
+        type: Array
+        default:
+        summary: |
+          An array of requested timestamps in seconds for which to retrieve
+          image frames. Each timestamp should be a number between `0` and
+          `Class.VideoSampler.TimeLength|TimeLength`.
+    returns:
+      - type: Array
+        summary: |
+          An array of dictionary or nil values for each requested timestamp. If
+          a requested timestamp is out of range or the `Class.VideoSampler` was
+          unable to produce a sample, the corresponding entry in the returned
+          array will be nil.
+
+          Each dictionary contains the following keys:
+
+          - `Time` (number): The timestamp of the returned image frame in
+            seconds. This value may differ slightly from the requested
+            timestamp.
+          - `Image` (`Datatype.Content`): A `Datatype.Content` with a
+            `Datatype.Content.SourceType|SourceType` of
+            `Enum.ContentSourceType.Opaque` containing the image frame at the
+            corresponding timestamp.
+    tags:
+      - Yields
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities: []
+events: []
+callbacks: []

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

@@ -17,6 +17,41 @@ tags:
   - Service
 deprecation_message: ''
 properties: []
-methods: []
+methods:
+  - name: VideoService:CreateVideoSamplerAsync
+    summary: |
+      Creates a `Class.VideoSampler` that samples frames from the provided video
+      content.
+    description: |
+      Creates a `Class.VideoSampler` that samples frames from the provided video
+      content.
+    code_samples: []
+    parameters:
+      - name: content
+        type: Content
+        default:
+        summary: |
+          The video content to sample from.
+      - name: options
+        type: Dictionary?
+        default:
+        summary: |
+          Options table for creating the `Class.VideoSampler`:
+
+          - `Size` – A `Enum.VideoSampleSize` value that determines the
+            resolution of textures produced by the `Class.VideoSampler`.
+            Defaults to `Enum.VideoSampleSize.Small`. Use the smallest
+            resolution that meets your needs to minimize memory usage and
+            improve sampling performance.
+    returns:
+      - type: VideoSampler
+        summary: |
+          The created `Class.VideoSampler`.
+    tags:
+      - Yields
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities: []
 events: []
 callbacks: []