Component:LegacyVideoPlayer

This article describes a feature marked as legacy—this usually means there's a newer, better alternative. Legacy features might not be removed but they will not be updated, and the team will not provide any support for them.

CollapseComponent image 

Legacy Video Player component as seen in the Scene Inspector

The Legacy Video Player component is used to construct and control legacy video players.

Fields

Fields Collapse

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. Some components stop their functionality when this field is disabled, but some don't.
StereoLayout	StereoLayout	The layout of the stereo audio for the video player.
SizeCompensation	Float2	How to compensate for video size.
videoProvider	VideoTexture	The video provider component giving the audio and visual data for the video.
_style	LegacyUIStyle	The legacy ui style component being used for this video player.
_indicatorTextureUrl	field drive of Uri	The field to drive to control the video player's texture url
_indicatorTint	field drive of ColorX	The field to drive to control the video player's indictor's tint
_colliderSize	field drive of Float3	The field to drive to control the video player's collider size
_frameWidth	field drive of Float	The field to drive to control the video player's border frame width
_frameHeight	field drive of Float	The field to drive to control the video player's border frame height
_frameMaterial	reference drive of PBS_RimMetallic	The field to drive to control the video player's frame material
_displayMaterial	UnlitMaterial	This stores the video player's display material.
_displayMaterialTexture	reference drive of AssetRef`1<ITexture2D>	The field to drive to control the video player's display material texture.
_displaySize	field drive of Float2	The field to drive to control the video player's display section size.
_mainAudioOutput	AudioOutput	This stores the video player's main audio output.
_timelineSlider	LegacySlider	This stores the video player's timeline slider.
_timelinePosition	field drive of Float3	The field to drive to control the video player's timeline playhead position.
_timelineWidth	field drive of Float	The field to drive to control the video player's timeline ui width.
_positionDrive	field drive of Float	The field to drive to control the video player's ui position.
_volumeSlider	LegacySlider	This stores the video player's volume slider.
_volumePosition	field drive of Float3	The field to drive to control the video player's volume amount.
_volumeWidth	field drive of Float	The field to drive to control the video player's volume ui width.
_volumeDrive	field drive of Float	The field to drive to control the video player's volume for the audio output component.
_buttonsWidth	field drive of Float	The field to drive to control the video player's button container widths.
_buttonsHeight	field drive of Float	The field to drive to control the video player's button container height.
_buttonsPosition	field drive of Float3	The field to drive to control the video player's button container position.
_playButtonColor	field drive of ColorX	The field to drive to control the video player's play button color.
_pauseButtonColor	field drive of ColorX	The field to drive to control the video player's pause button color.
_stopButtonColor	field drive of ColorX	The field to drive to control the video player's stop button color.
_loopButtonColor	field drive of ColorX	The field to drive to control the video player's loop button color.
_audio3DButtonColor	field drive of ColorX	The field to drive to control the video player's 3d audio button.
_exportable	VideoExportable	The component that is used to make this video player exportable.
_assetProxy	AssetProxy`1<VideoTexture>	The component that is used to allow this video to be dropped into asset fields for videos.
_referenceProxy	ReferenceProxy	The component that allows this video to be dropped into texture and audio fields or receivers.

Sync Delegates

Triggers Collapse

Method Name	Method type and Arguments.	Is the method hidden?	Description
OnIndicatorTouched:TouchEvent	TouchEvent	✓	Called when the indicator button is touched.
OnPlayTouched:TouchEvent	TouchEvent	✓	Called when the play button is touched.
OnPauseTouched:TouchEvent	TouchEvent	✓	Called when the pause button is touched.
OnStopTouched:TouchEvent	TouchEvent	✓	Called when the stop button is touched.
OnLoopTouched:TouchEvent	TouchEvent	✓	Called when the loop button is touched.
OnAudio3DTouched:TouchEvent	TouchEvent	✓	Called when the spatialize audio button is touched.
VolumeUp:Action`1<LegacySlider>	Action`1<LegacySlider>	✓	Called when the volume up button is touched.
VolumeDown:Action`1<LegacySlider>	Action`1<LegacySlider>	✓	Called when the volume down button is touched.
FastForward:Action`1<LegacySlider>	Action`1<LegacySlider>	✓	Called when the fast forward button is touched.
FastBackward:Action`1<LegacySlider>	Action`1<LegacySlider>	✓	Called when the fast backwards button is touched.

Usage

Used in legacy content. do not use in new content.

Examples

used in legacy content.

See Also

• Video Player