Component:LegacyAudioPlayer: Difference between revisions

Latest revision as of 03:43, 7 April 2025

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.

@@ Line 1: / Line 1: @@
-{{Infobox Component
+{{Legacy}}{{Infobox Component
 |Image=LegacyAudioPlayerComponent.png
 |Name=Legacy Audio Player
 }}
-{{stub}}
+The '''LegacyAudioPlayer''' component is a leftover Component from content migrated from other platforms. It should not be used, and should be replaced whenever possible.
-== Usage ==
+For a replacement see [[Audio Player]].
+== Fields ==
 {{Table ComponentFields
-|AudioClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv0=true|
+|AudioClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv0=true| The audio clip for this audio player.
-|_clipPlayer|'''[[Component:AudioClipPlayer|AudioClipPlayer]]'''|TypeAdv1=true|
+|_clipPlayer|'''[[Component:AudioClipPlayer|AudioClipPlayer]]'''|TypeAdv1=true| The audio clip player that will play the audio clip.
-|_audioOutput|'''[[Component:AudioOutput|AudioOutput]]'''|TypeAdv2=true|
+|_audioOutput|'''[[Component:AudioOutput|AudioOutput]]'''|TypeAdv2=true| The audio output for the audio clip.
-|_waveformMaterial|'''[[Component:UnlitMaterial|UnlitMaterial]]'''|TypeAdv3=true|
+|_waveformMaterial|'''[[Component:UnlitMaterial|UnlitMaterial]]'''|TypeAdv3=true| The material that is used on the ring visual.
-|_playbackMaterial|'''[[Component:UnlitMaterial|UnlitMaterial]]'''|TypeAdv4=true|
+|_playbackMaterial|'''[[Component:UnlitMaterial|UnlitMaterial]]'''|TypeAdv4=true| The material that is used for the playback visual.
-|_waveformRingMesh|'''[[Component:RingMesh|RingMesh]]'''|TypeAdv5=true|
+|_waveformRingMesh|'''[[Component:RingMesh|RingMesh]]'''|TypeAdv5=true| The mesh used for the waveform ring visual.
-|_playbackRingMesh|'''[[Component:RingMesh|RingMesh]]'''|TypeAdv6=true|
+|_playbackRingMesh|'''[[Component:RingMesh|RingMesh]]'''|TypeAdv6=true| The mesh used for the playback ring visual.
-|_playbackRingArc|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv7=true|
+|_playbackRingArc|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv7=true| The field to drive to make the visual for the playback ring.
-|_volumeRingArc|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv8=true|
+|_volumeRingArc|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv8=true| The field to drive to make the visual for the audio arc.
-|_playbackTimeText|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv9=true|
+|_playbackTimeText|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv9=true| The field to drive for the playback time text.
-|_clipLengthTimeText|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv10=true|
+|_clipLengthTimeText|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv10=true| The field to drive for the audio clip length text.
-|_iconTextureURL|{{RootFieldType|FieldDrive`1|[[Type:Uri|Uri]]}}|TypeAdv11=true|
+|_iconTextureURL|{{RootFieldType|FieldDrive`1|[[Type:Uri|Uri]]}}|TypeAdv11=true| The field to drive with the icon texture URI.
-|_stopItem|'''[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]'''|TypeAdv12=true|
+|_stopItem|'''[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]'''|TypeAdv12=true| The item that can be clicked to stop playback.
-|_loopItem|'''[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]'''|TypeAdv13=true|
+|_loopItem|'''[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]'''|TypeAdv13=true| The item that can be clicked to loop playback.
-|_spatialItem|'''[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]'''|TypeAdv14=true|
+|_spatialItem|'''[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]'''|TypeAdv14=true| The item that can be clicked to spatialize or unspatialize the audio.
-|_loopIconURL|{{RootFieldType|FieldDrive`1|[[Type:Uri|Uri]]}}|TypeAdv15=true|
+|_loopIconURL|{{RootFieldType|FieldDrive`1|[[Type:Uri|Uri]]}}|TypeAdv15=true| The field to drive with the loop icon texture URI.
-|_spatialIconURL|{{RootFieldType|FieldDrive`1|[[Type:Uri|Uri]]}}|TypeAdv16=true|
+|_spatialIconURL|{{RootFieldType|FieldDrive`1|[[Type:Uri|Uri]]}}|TypeAdv16=true| The field to drive with the spatialize icon URI.
-|_exportable|'''[[Component:AudioExportable|AudioExportable]]'''|TypeAdv17=true|
+|_exportable|'''[[Component:AudioExportable|AudioExportable]]'''|TypeAdv17=true| The audio exportable component used to handle the export behavior of this audio player.
-|_assetProxy|'''[[Component:AssetProxy`1|AssetProxy`1]]&lt;[[Type:AudioClip|AudioClip]]&gt;'''|TypeAdv18=true|
+|_assetProxy|'''[[Component:AssetProxy`1|AssetProxy`1]]&lt;[[Type:AudioClip|AudioClip]]&gt;'''|TypeAdv18=true| The asset proxy used to handle dropping this audio player into fields that accept audio clips.
 }}
 == Sync Delegates ==
 {{Table ComponentTriggers
-|StopPressed:[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|true|
+|StopPressed:[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|true| A sync delegate to call when the stop button is pressed.
-|LoopToggle:[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|true|
+|LoopToggle:[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|true| A sync delegate to call when the loop button is pressed.
-|SpatialToggle:[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|true|
+|SpatialToggle:[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|[[Type:Action`1|Action`1]]&lt;[[Component:LegacySegmentCircleMenuController#Item|LegacySegmentCircleMenuController.Item]]&gt;|true| A sync delegate to call when the spatialize button is pressed.
 }}
-== Behavior ==
+== Usage ==
+Not to be used.
 == Examples ==
+Old content migrated from other platforms.
 == See Also ==
+* [[Audio Player]]
 [[Category:Components:Uncategorized{{#translation:}}|Legacy Audio Player]]
 [[Category:Components{{#translation:}}|Legacy Audio Player]]
-[[Category:ComponentStubs]]