logoWindUI Shiny

Background Video

Window background video configuration and runtime methods.

Background Video

Background video is configured on Window and can be changed at runtime.

Create with Video Background

local Window = WindUI:CreateWindow({
    Title = "Background Media",
    Folder = "WindUI-BG",
    BackgroundVideo = "1234567890",
})

Accepted video formats:

  1. number (converted to rbxassetid://...)
  2. numeric string ("1234567890")
  3. full rbxassetid://...
  4. "video:<source>"
  5. URL (http/https, with executor file API support recommended)

Runtime Methods

MethodSignatureReturnsDescription
SetBackgroundVideoWindow:SetBackgroundVideo(video)booleanSwitches to video background
SetBackgroundImageWindow:SetBackgroundImage(image)booleanSwitches to image background
SetBackgroundImageTransparencyWindow:SetBackgroundImageTransparency(v)nilSets image transparency
SetBackgroundTransparencyWindow:SetBackgroundTransparency(v)nilSets global window transparency state

Full Example (Background Video Methods)

Window:SetBackgroundVideo("1234567890")
Window:SetBackgroundVideo("video:rbxassetid://1234567890")

Window:SetBackgroundImage("rbxassetid://987654321")
Window:SetBackgroundImageTransparency(0.35)

Window:SetBackgroundTransparency(0.2)

On this page