Component:VideoTextureProvider: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
Add some info
template some fields
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=VideoTextureProviderComponent.png
|Image=VideoTextureProviderComponent.png
|Name=Video Texture Provider
|Name=Video Texture Provider
}}
}}
The '''VideoTextureProvider''' component is used to display and play video. This component importantly implements both [[Type:ITexture2D|ITexture2D]] and [[Type:IAudioSource|IAudioSource]] which means it can be used as both a texture and a source of audio like a [[Component:StaticAudioClip|StaticAudioClip]]


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Playback|{{RootFieldType|SyncPlayback}}|TypeAdv0=true|
|Playback|{{RootFieldType|SyncPlayback}}|TypeAdv0=true| controls the playback of both the audio and visual elements of this component at the same time.
|URL|Uri| The website or file source of the video. Like a youtube video or a file on a machine.
|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
|Stream|Bool| Whether this video should stream the data or cache it
|Volume|Float| The volume of the video when being used as an [[Type:IAudioSource|IAudioSource]]
|Volume|Float| The volume of the video when being used as an [[Type:IAudioSource|IAudioSource]] in an audio player.
|ForcePlaybackEngine|String|
|ForcePlaybackEngine|String| The engine to use for playback like UnityPlaybackEngine or LibVLC.
|ForceVideoStreamingServiceParsing|Bool|
|ForceVideoStreamingServiceParsing|Bool| Whether to force parsing a streaming service like Twitch.
|VideoTitle|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv6=true|
|VideoTitle|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv6=true| The field to populate with the name of the video that has been loaded.
|CurrentPlaybackEngine|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv7=true|
|CurrentPlaybackEngine|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv7=true| The current engine being used for playback
|CurrentClockError|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv8=true|
|CurrentClockError|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv8=true| The amount of seconds the player may have in error due to lag or otherwise.
|FilterMode|TextureFilterMode| The filtering that should be applied to the texture part of the video
|FilterMode|TextureFilterMode| {{Template:Texture FilterMode Field}}
|AnisotropicLevel|Int|
|AnisotropicLevel|Int| {{Template:Texture AnisotropicLevel Field}}
|WrapModeU|TextureWrapMode| The wrapping that should be used when tiling the texture on the X axis.
|WrapModeU|TextureWrapMode| {{Template:Texture WrapMode Field|X}}
|WrapModeV|TextureWrapMode| The wrapping that should be used when tiling the texture on the Y axis.
|WrapModeV|TextureWrapMode| {{Template:Texture WrapMode Field|Y}}
|AudioTrackIndex|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv13=true|
|AudioTrackIndex|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv13=true| the audio track that the video player should use to play
|PreferAudioOnly|Bool|
|PreferAudioOnly|Bool| whether to parse the video source as audio only rather than video and audio. An example of an audio only is an MP3 file type.
|MaxWidth|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv15=true|
|MaxWidth|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv15=true| The max pixels on the x axis that will be rendered when using this as a texture.
|MaxHeight|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv16=true|
|MaxHeight|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv16=true| The max pixels on the y axis that will be rendered when using this as a texture.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== 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).
This component is often seen with [[Video Player|Video Players]], as they implement [[Type:ITexture2D|ITexture2D]] (meaning they are also a texture) and also implement IAudioSource (Which mean that are also like an audio clip) and can be used by users in different ways (i.e. Multiple screens and speakers sharing one Video Player texture).


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Video Texture Provider]]
[[Category:Components{{#translation:}}|Video Texture Provider]]
[[Category:Components:Assets{{#translation:}}|Video Texture Provider]]
[[Category:Components:Assets{{#translation:}}|Video Texture Provider]]

Latest revision as of 17:34, 19 November 2024

Component image 
Video Texture Provider component as seen in the Scene Inspector

The VideoTextureProvider component is used to display and play video. This component importantly implements both ITexture2D and IAudioSource which means it can be used as both a texture and a source of audio like a StaticAudioClip

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 controls the playback of both the audio and visual elements of this component at the same time.
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 in an audio player.
ForcePlaybackEngine String The engine to use for playback like UnityPlaybackEngine or LibVLC.
ForceVideoStreamingServiceParsing Bool Whether to force parsing a streaming service like Twitch.
VideoTitle raw output of String The field to populate with the name of the video that has been loaded.
CurrentPlaybackEngine raw output of String The current engine being used for playback
CurrentClockError raw output of Float The amount of seconds the player may have in error due to lag or otherwise.
FilterMode TextureFilterMode How to handle the interpolation between pixels.
AnisotropicLevel Int The levels of Anisotropic filtering distances when using Anisotropic for FilterMode
WrapModeU TextureWrapMode How to repeat or mirror the texture along the X axis. this goes into affect when X values are outside of the range [0.0 to 1.0].
WrapModeV TextureWrapMode How to repeat or mirror the texture along the Y axis. this goes into affect when Y values are outside of the range [0.0 to 1.0].
AudioTrackIndex Nullable`1<Int> the audio track that the video player should use to play
PreferAudioOnly Bool whether to parse the video source as audio only rather than video and audio. An example of an audio only is an MP3 file type.
MaxWidth Nullable`1<Int> The max pixels on the x axis that will be rendered when using this as a texture.
MaxHeight Nullable`1<Int> The max pixels on the y axis that will be rendered when using this as a texture.

Usage

This component is often seen with Video Players, as they implement ITexture2D (meaning they are also a texture) and also implement IAudioSource (Which mean that are also like an audio clip) and can be used by users in different ways (i.e. Multiple screens and speakers sharing one Video Player texture).

Examples

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


See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:VideoTextureProvider&oldid=92731"