Component:LegacyAudioPlayer

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.

Component image 

Legacy Audio Player component as seen in the Scene Inspector

The LegacyAudioPlayer component is a leftover Component from content migrated from other platforms. It should not be used, and should be replaced whenever possible.

For a replacement see Audio Player.

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. Some components stop their functionality when this field is disabled, but some don't.
AudioClip	AudioClip	The audio clip for this audio player.
_clipPlayer	AudioClipPlayer	The audio clip player that will play the audio clip.
_audioOutput	AudioOutput	The audio output for the audio clip.
_waveformMaterial	UnlitMaterial	The material that is used on the ring visual.
_playbackMaterial	UnlitMaterial	The material that is used for the playback visual.
_waveformRingMesh	RingMesh	The mesh used for the waveform ring visual.
_playbackRingMesh	RingMesh	The mesh used for the playback ring visual.
_playbackRingArc	field drive of Float	The field to drive to make the visual for the playback ring.
_volumeRingArc	field drive of Float	The field to drive to make the visual for the audio arc.
_playbackTimeText	field drive of String	The field to drive for the playback time text.
_clipLengthTimeText	field drive of String	The field to drive for the audio clip length text.
_iconTextureURL	field drive of Uri	The field to drive with the icon texture URI.
_stopItem	LegacySegmentCircleMenuController.Item	The item that can be clicked to stop playback.
_loopItem	LegacySegmentCircleMenuController.Item	The item that can be clicked to loop playback.
_spatialItem	LegacySegmentCircleMenuController.Item	The item that can be clicked to spatialize or unspatialize the audio.
_loopIconURL	field drive of Uri	The field to drive with the loop icon texture URI.
_spatialIconURL	field drive of Uri	The field to drive with the spatialize icon URI.
_exportable	AudioExportable	The audio exportable component used to handle the export behavior of this audio player.
_assetProxy	AssetProxy`1<AudioClip>	The asset proxy used to handle dropping this audio player into fields that accept audio clips.

Sync Delegates

Triggers

Method Name	Method type and Arguments.	Is the method hidden?	Description
StopPressed:Action`1<LegacySegmentCircleMenuController.Item>	Action`1<LegacySegmentCircleMenuController.Item>	✓	A sync delegate to call when the stop button is pressed.
LoopToggle:Action`1<LegacySegmentCircleMenuController.Item>	Action`1<LegacySegmentCircleMenuController.Item>	✓	A sync delegate to call when the loop button is pressed.
SpatialToggle:Action`1<LegacySegmentCircleMenuController.Item>	Action`1<LegacySegmentCircleMenuController.Item>	✓	A sync delegate to call when the spatialize button is pressed.

Usage

Not to be used.

Examples

Old content migrated from other platforms.

See Also

• Audio Player