Skip to main content

VideoRequest

info
  • This class can only be created on ServerScripts
  • This class is available for LocalScripts and ServerScripts

The VideoRequest object is the object used for a callback from Streaming.GetWithOptions. It contains all the data for a client to be able to download media, such as the format, DownloadURL, and more, listed below.

caution

All properties are Read-only! This is to prevent scripts from being able to override properties themselves.

Properties​

Property NameProperty TypeDescription
MediaUrlstringThe requested URL to lookup
NeedsClientFetchboolIf the client needs to fetch the DownloadURL itself
OptionsStreamDownloadOptionsOptions for the media fetch/download
DownloadUrlstringThe URL to Download the media from
IsStreamboolIf the requested media is a Stream

Methods​

Method NameReturn TypeParametersDescription
GetMediaUrlstringvoidGets the MediaUrl Property
GetNeedsClientFetchboolvoidGets the NeedsClientFetch Property
GetOptionsStreamDownloadOptionsvoidGets the Options Property
GetDownloadUrlstringvoidGets the DownloadUrl Property
IsStreamboolvoidGets the IsStream Property