====== Audio Source (UnityComponent) ======

This component is used to play sounds on VCI.

  * [[https://docs.unity3d.com/2018.3/Documentation/Manual/class-AudioSource.html | Audio Source (Unity manual)]]
  * [[en:vci:script:reference:exportassets:audio|assets.audio (ExportAudio) (Control audio)]]

Support for MP3 import/export has been added from VCI v0.24 A MP3 exported from UniVCI v0.24 will not be converted into the WAV file. It will be exported as-is in the format of MP3.

==== Summary of Physic Material in VCI ====

  * All file formats supported by Unity can be used.
  * Clips in AudioSource components attached to GameObjects under VCIObject will be exported with VCI file.
  * The audio will be saved as WAV or MP3 format in .vci file
  * If the AudioClip is in either WAV or MP3 from the beginning, the data will be written in VCI without conversion.
  * If the AudioClip is in other formats (like ogg), the AudioClip will be converted into WAV.
  * **Properties in Audio Source will not be saved in VCI.** **

==== Supported file format ====

  * 44100Hz 8Bit 1ch
  * 44100Hz 8Bit 2ch
  * 44100Hz 16Bit 1ch
  * 44100Hz 16Bit 2ch
  * 44100Hz 24Bit 1ch
  * 44100Hz 24Bit 2ch
  * 48000Hz 8Bit 1ch
  * 48000Hz 8Bit 2ch
  * 48000Hz 16Bit 1ch
  * 48000Hz 16Bit 2ch
  * 48000Hz 24Bit 1ch
  * 48000Hz 24Bit 2ch

==== Properties ====

  * **Properties in Audio Source will not be saved in VCI.** **
  * **The default value will be applied. **

^ Property ^ Default setting ^ Feature ^
| Audio Clip | The clip you specified | An audio clip to play |
| Output |  | The sound is output through an AudioListener or an AudioMixier. |
| Mute | Disabled | When enabled, the audio will be played, but it will be muted. |
| Play On Awake | Disabled | When enabled, the audio is played simultaneously as the object is spawned. |
| Loop | Disabled | When enabled, the AudioClip will be looped. |
| Priority | 128 | Set the priority of the Audio Source. |
| Volume | 1 | Loudness of the audio. |
| Pitch	 | 1 | Play speed of the audio. 1 is the normal play speed. |
| Stereo Pan | 0 | Sets the place of the 2D sound in a stereo field. |
| 3D Sound Settings | Not supported | Make the audio sound like as if it's in a 3D space.\\ ** Not supported in VCI** |

==== MP3 or WAV: which to choose? ====

While MP3 can shrink the file size compared to WAV, it takes longer for VirtualCast to load MP3 than WAV. Also, be aware of the fact: the longer the length, the more RAM it consumes.

==== VCI examples ====

  * [[en:vci:sample:audio:tutorial | Play sound in VCI]]