Skip to content
Roblox API Reference

VideoFrame

A GUI object that renders a rectangle, like a Frame does, with a moving video image.
Memory category
Gui
Own members
26
Inherited members
156
Subclasses
0
Siblings
12

Properties95

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Inherited fromGuiBase2d17

Property categoryData

Property categoryDebugging

Property categoryLocalization

Property categorySelection

Inherited fromGuiObject39

Property categoryAppearance

Property categoryBehavior

  • Determines if descendant GuiObjects outside of the bounds of a parent GUI element should render.
    • Read capabilities: UI
  • Deprecated: This property is deprecated. Use UIDragDetector instead, as it supports more input types and can be better customized.
    Determines whether a GuiObject (and its descendants) can be dragged around the screen.
    • Deprecated
    • Read capabilities: UI

Property categoryData

Property categoryEventReplicator

Property categorySelection

Property categoryState

Defined byVideoFrame16

Property categoryVideo

    • Hidden
    • Read capabilities: Audio + InternalTest + UI
    • Write capabilities: InternalTest
  • VideoFrame.IsLoaded: boolean = false
    Indicates when the VideoFrame.Video has loaded from Roblox servers and is ready to play.
    • Read only
    • Read capabilities: Audio + UI
  • VideoFrame.Looped: boolean = false
    Sets whether or not the VideoFrame.Video repeats once it has finished when it is playing.
    • Read capabilities: Audio + UI
  • VideoFrame.MaximumResolution: Enum.VideoSampleSize = Enum.VideoSampleSize.Full
    Internal-only. Caps the resolution the video is allowed to stream at, expressed as an VideoSampleSize.
    • Hidden
    • Read capabilities: Audio + InternalTest + UI
    • Write capabilities: InternalTest
  • VideoFrame.Playing: boolean = false
    Indicates whether the VideoFrame.Video is currently playing. It can be set to start or pause playback.
    • Not replicated
    • Read capabilities: Audio + UI
  • VideoFrame.PlayingReplicating: boolean = false
    • Hidden
    • Not scriptable
    • Read capabilities: Audio + UI
  • VideoFrame.Resolution: Vector2 = Vector2.zero
    Gets the original source resolution of the VideoFrame.Video file.
    • Read only
    • Read capabilities: Audio + UI
  • VideoFrame.RollOffMaxDistance: number = 10000
    The maximum distance, in studs, a listener can be from the video's part and still hear its audio.
    • Capabilities: Audio + UI
  • VideoFrame.RollOffMinDistance: number = 1
    The minimum distance, in studs, at which the video's audio starts to attenuate.
    • Capabilities: Audio + UI
  • VideoFrame.RollOffMode: Enum.RollOffMode = Enum.RollOffMode.Inverse
    Controls how the video's audio volume attenuates with distance.
    • Capabilities: Audio + UI
  • VideoFrame.TimeLength: number = 0
    Indicates the length of the VideoFrame.Video in seconds.
    • Read only
    • Read capabilities: Audio + UI
  • VideoFrame.TimePosition: number = 0
    Indicates the progress in seconds of the VideoFrame.Video.
    • Not replicated
    • Read capabilities: Audio + UI
  • VideoFrame.TimePositionReplicating: number = 0
    • Hidden
    • Not scriptable
    • Read capabilities: Audio + UI
  • VideoFrame.Video: string = ""
    The content ID of the video file a VideoFrame object is associated with.
    • Read capabilities: Audio + UI
  • VideoFrame.VideoContent: Content
    The video content a VideoFrame is associated with, as either an asset content ID (same value as Video) or a direct reference to a VideoCapture object for local screen recordings.
    • Read capabilities: Audio + UI
  • VideoFrame.Volume: number = 1
    Indicates how loud the VideoFrame.Video is currently playing back.
    • Read capabilities: Audio + UI

Methods51

Inherited fromObject3
  • Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39
Inherited fromGuiObject6
Defined byVideoFrame3

Events36

Inherited fromObject1
Inherited fromInstance9
Inherited fromGuiBase2d1
Inherited fromGuiObject18
Defined byVideoFrame7