Component:AudioPlayerInterface

Component image 

Audio Player Interface component as seen in the Scene Inspector

The AudioPlayerInterface component is used on AudioClip objects that are spawned in by the user to allow the engine to interface with the stored audio clip.

This is a favorite-able item like a favorite text viewer or a favorite world load indicator

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.
ItemName	IField`1<String>	The name of the audio clip.
SpawningUser	UserRef	The user that spawned this audio clip.
SpawningUserID	IField`1<String>	The field of the UserRef that stores the spawning user's id.
IsInstance	Bool	Whether this audio clip interface is a spawned interface or one being edited currently by the user. Usually set to true by the game when loaded as a user's favorite audio clip player
URL	IField`1<Uri>	The field of the URI on the Type:AudioClip this component interfaces with.
Clip	AssetRef`1<AudioClip>	The Type:AudioClip interfaced by this component.
Group	IField`1<AudioTypeGroup>	The audio group setting for this audio clip.
Volume	IField`1<Float>	The volume setting of this audio clip.
Spatialize	IField`1<Bool>	The Spatialize setting of the audio clip.
Doppler	IField`1<Float>	The Doppler setting of the audio clip.
DefaultAudioClip	AudioClip	The audio clip

Usage

This can be attached to a slot in order for the user to make own audio clip interface for when they import an audio clip. Although, it may be easier to edit the default existing audio clip player interface.

Examples

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