Component:VideoTextureProvider: Difference between revisions

Latest revision as of 23:36, 31 July 2024

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Component image

**Video Texture Provider** component as seen in the Scene Inspector

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled.
`Playback`	direct SyncPlayback
`URL`	Uri	The website or file source of the video. Like a youtube video or a file on a machine.
`Stream`	Bool	Whether this video should stream the data or cache it
`Volume`	Float	The volume of the video when being used as an IAudioSource
`ForcePlaybackEngine`	String
`ForceVideoStreamingServiceParsing`	Bool
`VideoTitle`	raw output of String
`CurrentPlaybackEngine`	raw output of String
`CurrentClockError`	raw output of Float
`FilterMode`	TextureFilterMode	The filtering that should be applied to the texture part of the video
`AnisotropicLevel`	Int
`WrapModeU`	TextureWrapMode	The wrapping that should be used when tiling the texture on the X axis.
`WrapModeV`	TextureWrapMode	The wrapping that should be used when tiling the texture on the Y axis.
`AudioTrackIndex`	Nullable`1<Int>
`PreferAudioOnly`	Bool
`MaxWidth`	Nullable`1<Int>
`MaxHeight`	Nullable`1<Int>

Usage

This component is often seen with Video Players, as they hold an ITexture2D and can be used by users in different ways (i.e. Multiple screens sharing one Video Player texture).

Examples

Related Components

@@ Line 11: / Line 11: @@
 == Fields ==
 {{Table ComponentFields
-|Playback|SyncPlayback|
+|Playback|{{RootFieldType|SyncPlayback}}|TypeAdv0=true|
-|URL|Uri|
+|URL|Uri| The website or file source of the video. Like a youtube video or a file on a machine.
-|Stream|Bool|
+|Stream|Bool| Whether this video should stream the data or cache it
-|Volume|Float|
+|Volume|Float| The volume of the video when being used as an [[Type:IAudioSource|IAudioSource]]
 |ForcePlaybackEngine|String|
 |ForceVideoStreamingServiceParsing|Bool|
-|CurrentPlaybackEngine|String|
+|VideoTitle|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv6=true|
-|FilterMode|TextureFilterMode|
+|CurrentPlaybackEngine|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv7=true|
+|CurrentClockError|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv8=true|
+|FilterMode|TextureFilterMode| The filtering that should be applied to the texture part of the video
 |AnisotropicLevel|Int|
-|WrapModeU|TextureWrapMode|
+|WrapModeU|TextureWrapMode| The wrapping that should be used when tiling the texture on the X axis.
-|WrapModeV|TextureWrapMode|
+|WrapModeV|TextureWrapMode| The wrapping that should be used when tiling the texture on the Y axis.
-|AudioTrackIndex|Nullable`1|TypeString11=Int?|
+|AudioTrackIndex|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv13=true|
 |PreferAudioOnly|Bool|
-|MaxWidth|Nullable`1|TypeString13=Int?|
+|MaxWidth|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv15=true|
-|MaxHeight|Nullable`1|TypeString14=Int?|
+|MaxHeight|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv16=true|
 }}
 <!--T:3-->
 == Usage ==
+This component is often seen with [[Video Player|Video Players]], as they hold an [[Type:ITexture2D|ITexture2D]] and can be used by users in different ways (i.e. Multiple screens sharing one Video Player texture).
 <!--T:4-->