rules

.cursor/rules/roblox/reference/engine/classes/VideoFrame.yaml

@@ -0,0 +1,375 @@
+# 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: VideoFrame
+type: class
+memory_category: Gui
+summary: |
+  A GUI object that renders a rectangle, like a `Class.Frame` does, with a
+  moving video image.
+description: |
+  A VideoFrame renders a rectangle, like a `Class.Frame` does, with a moving
+  video image. The video must be from a file uploaded to the Roblox website.
+
+  The video is scaled to fit the entirety of the rectangle, but looks best when
+  displayed at its native resolution.
+
+  ## 2D and 3D Sound
+
+  A VideoFrame placed underneath `Class.SurfaceGui` on a `Class.BasePart` will
+  emit its sound from that part's `Class.BasePart.Position`.
+
+  A VideoFrame exhibits the Doppler effect, meaning its frequency and pitch
+  varies with the relative motion of whatever part it is attached to.
+
+  The volume of the VideoFrame will be determined by the distance between the
+  client's sound listener (by default the `Class.Camera` position) and the
+  position of the VideoFrame's part.
+
+  A VideoFrame is considered **"global"** if it is not placed underneath
+  SurfaceGui on a BasePart. In this case, the sound will play at the same volume
+  throughout the entire place.
+code_samples:
+  - creating-and-playing-a-video
+inherits:
+  - GuiObject
+descendants: []
+tags: []
+deprecation_message: ''
+properties:
+  - name: VideoFrame.IsLoaded
+    summary: |
+      Indicates when the `Class.VideoFrame.Video` has loaded from Roblox servers
+      and is ready to play.
+    description: |
+      This property will be true when the `Class.VideoFrame.Video` has loaded
+      from Roblox servers and is ready to play.
+    code_samples: []
+    type: boolean
+    tags:
+      - ReadOnly
+      - NotReplicated
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Video
+    serialization:
+      can_load: false
+      can_save: false
+    capabilities:
+      - UI
+  - name: VideoFrame.Looped
+    summary: |
+      Sets whether or not the `Class.VideoFrame.Video` repeats once it has
+      finished when it is playing.
+    description: |
+      This property sets whether or not the `Class.VideoFrame.Video` repeats
+      once it has finished when it is playing.
+    code_samples: []
+    type: boolean
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Video
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - UI
+  - name: VideoFrame.Playing
+    summary: |
+      Indicates whether the `Class.VideoFrame.Video` is currently playing. It
+      can be set to start or pause playback.
+    description: |
+      This property indicates whether the `Class.VideoFrame.Video` is currently
+      playing. It can be set to start or pause playback as an alternative to the
+      `Class.VideoFrame:Play()` and `Class.VideoFrame:Pause()` functions.
+    code_samples: []
+    type: boolean
+    tags:
+      - NotReplicated
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Video
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - UI
+  - name: VideoFrame.Resolution
+    summary: |
+      Gets the original source resolution of the `Class.VideoFrame.Video` file.
+    description: |
+      This property gets the original source resolution of the
+      `Class.VideoFrame.Video` file.
+    code_samples: []
+    type: Vector2
+    tags:
+      - ReadOnly
+      - NotReplicated
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Video
+    serialization:
+      can_load: false
+      can_save: false
+    capabilities:
+      - UI
+  - name: VideoFrame.TimeLength
+    summary: |
+      Indicates the length of the `Class.VideoFrame.Video` in seconds.
+    description: |
+      This property indicates the length of the `Class.VideoFrame.Video` in
+      seconds. If the video is not loaded, this value will be 0.
+    code_samples: []
+    type: double
+    tags:
+      - ReadOnly
+      - NotReplicated
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Video
+    serialization:
+      can_load: false
+      can_save: false
+    capabilities:
+      - UI
+  - name: VideoFrame.TimePosition
+    summary: |
+      Indicates the progress in seconds of the `Class.VideoFrame.Video`.
+    description: |
+      This property indicates the progress in seconds of the
+      `Class.VideoFrame.Video`. It can be changed to move the playback position
+      of the video both before and during playback.
+    code_samples: []
+    type: double
+    tags:
+      - NotReplicated
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Video
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - UI
+  - name: VideoFrame.Video
+    summary: |
+      The content ID of the video file a `Class.VideoFrame` object is associated
+      with.
+    description: |
+      The content ID of the video file a `Class.VideoFrame` object is associated
+      with. To save resources and improve performance, set this property to `""`
+      when the `Class.VideoFrame` is not visible or in use.
+    code_samples:
+      - creating-and-playing-a-video
+    type: ContentId
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Video
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - UI
+  - name: VideoFrame.VideoContent
+    summary: ''
+    description: ''
+    code_samples: []
+    type: Content
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Video
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - UI
+  - name: VideoFrame.Volume
+    summary: |
+      Indicates how loud the `Class.VideoFrame.Video` is currently playing back.
+    description: |
+      This property determines how loud the `Class.VideoFrame.Video` plays back.
+      It can be set to a number between 0 and 100.
+    code_samples: []
+    type: float
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Video
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - UI
+methods:
+  - name: VideoFrame:Pause
+    summary: |
+      Sets `Class.VideoFrame.Playing` to `false`, pausing playback if the
+      `Class.VideoFrame.Video` is playing.
+    description: |
+      Sets `Class.VideoFrame.Playing` to `false`, pausing playback if the
+      `Class.VideoFrame.Video` is playing.
+
+      As `Class.VideoFrame.TimePosition` is not reset, when the video is resumed
+      it will continue from its previous position.
+    code_samples: []
+    parameters: []
+    returns:
+      - type: ()
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - UI
+  - name: VideoFrame:Play
+    summary: |
+      Sets `Class.VideoFrame.Playing` to `true`, playing the
+      `Class.VideoFrame.Video` from the current `Class.VideoFrame.TimePosition`.
+    description: |
+      Sets `Class.VideoFrame.Playing` to `true`, playing the
+      `Class.VideoFrame.Video` from the current `Class.VideoFrame.TimePosition`.
+      To save resources and improve performance, set the
+      `Class.VideoFrame.Video` property to `""` when the `Class.VideoFrame` is
+      not visible or in use.
+    code_samples:
+      - creating-and-playing-a-video
+    parameters: []
+    returns:
+      - type: ()
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - UI
+events:
+  - name: VideoFrame.DidLoop
+    summary: |
+      Fires whenever the `Class.VideoFrame.Video` loops.
+    description: |
+      An event that fires whenever the `Class.VideoFrame.Video` loops. Returns
+      the content ID of the video.
+    code_samples: []
+    parameters:
+      - name: video
+        type: string
+        default:
+        summary: |
+          The content ID of the video that looped.
+    tags: []
+    deprecation_message: ''
+    security: None
+    capabilities:
+      - UI
+  - name: VideoFrame.Ended
+    summary: |
+      Fires when the `Class.VideoFrame.Video` has completed playback and
+      stopped.
+    description: |
+      This event fires when the `Class.VideoFrame.Video` has completed playback
+      and stopped.
+    code_samples: []
+    parameters:
+      - name: video
+        type: string
+        default:
+        summary: |
+          The content ID of the paused that ended.
+    tags: []
+    deprecation_message: ''
+    security: None
+    capabilities:
+      - UI
+  - name: VideoFrame.Loaded
+    summary: |
+      Fires when the `Class.VideoFrame.Video` is loaded.
+    description: |
+      This event fires when the `Class.VideoFrame.Video` is loaded.
+    code_samples: []
+    parameters:
+      - name: video
+        type: string
+        default:
+        summary: |
+          The content ID of the loaded video.
+    tags: []
+    deprecation_message: ''
+    security: None
+    capabilities:
+      - UI
+  - name: VideoFrame.Paused
+    summary: |
+      This event fires whenever the `Class.VideoFrame.Video` is paused using
+      `Class.VideoFrame:Pause()` or by setting `Class.VideoFrame.Playing` to
+      false.
+    description: |
+      This event fires whenever the `Class.VideoFrame.Video` is paused using
+      `Class.VideoFrame:Pause()` or by setting `Class.VideoFrame.Playing` to
+      false.
+    code_samples: []
+    parameters:
+      - name: video
+        type: string
+        default:
+        summary: |
+          The content ID of the paused video.
+    tags: []
+    deprecation_message: ''
+    security: None
+    capabilities:
+      - UI
+  - name: VideoFrame.Played
+    summary: |
+      Fires whenever the `Class.VideoFrame.Video` is played using the
+      `Class.VideoFrame:Play()` function or by setting
+      `Class.VideoFrame.Playing` to true.
+    description: |
+      This event fires whenever the `Class.VideoFrame.Video` is played using the
+      `Class.VideoFrame:Play()` function or by setting
+      `Class.VideoFrame.Playing` to true.
+    code_samples: []
+    parameters:
+      - name: video
+        type: string
+        default:
+        summary: |
+          The content ID of the played video.
+    tags: []
+    deprecation_message: ''
+    security: None
+    capabilities:
+      - UI
+callbacks: []