AudioSource

class in UnityEngine

/

Hereda de:Behaviour

Cambiar al Manual

Descripción

Una representación de fuentes de audio en 3D.

An AudioSource is attached to a GameObject for playing back sounds in a 3D environment. In order to play 3D sounds you also need to have a AudioListener. The audio listener is normally attached to the camera you want to use. Whether sounds are played in 3D or 2D is determined by AudioImporter settings.

You can play a single audio clip using Play, Pause and Stop. You can also adjust its volume while playing using the volume property, or seek using time. Multiple sounds can be played on one AudioSource using PlayOneShot. You can play a clip at a static position in 3D space using PlayClipAtPoint.

See Also: AudioListener, AudioClip, AudioSource component.

//This script allows you to toggle music to play and stop.
//Assign an AudioSource to a GameObject and attach an Audio Clip in the Audio Source. Attach this script to the GameObject.

using UnityEngine;

public class Example : MonoBehaviour { AudioSource m_MyAudioSource;

//Play the music bool m_Play; //Detect when you use the toggle, ensures music isn’t played multiple times bool m_ToggleChange;

void Start() { //Fetch the AudioSource from the GameObject m_MyAudioSource = GetComponent<AudioSource>(); //Ensure the toggle is set to true for the music to play at start-up m_Play = true; }

void Update() { //Check to see if you just set the toggle to positive if (m_Play == true &amp;&amp; m_ToggleChange == true) { //Play the audio you attach to the AudioSource component m_MyAudioSource.Play(); //Ensure audio doesn’t play more than once m_ToggleChange = false; } //Check if you just set the toggle to false if (m_Play == false &amp;&amp; m_ToggleChange == true) { //Stop the audio m_MyAudioSource.Stop(); //Ensure audio doesn’t play more than once m_ToggleChange = false; } }

void OnGUI() { //Switch this toggle to activate and deactivate the parent GameObject m_Play = GUI.Toggle(new Rect(10, 10, 100, 30), m_Play, "Play Music");

//Detect if there is a change with the toggle if (GUI.changed) { //Change to true to show that there was just a change in the toggle state m_ToggleChange = true; } } }

Variables

bypassEffectsEfectos Bypass (Aplicado de componentes filter o filtros listener globales).
bypassListenerEffectsCuando los efectos globales establecidos en el AudioListener no se aplicarán a la señal de audio generada por AudioSource. No se aplica si AudioSource se está reproduciendo en un grupo de mezcladores.
bypassReverbZonesCuando establecer (set) no encamina la señal de un AudioSource a la reverberación global asociada con las zonas de reverberación.
clipEl AudioClip por defecto a reproducir.
dopplerLevelEstablece la escala Doppler para este AudioSource.
ignoreListenerPausePermite que AudioSource se reproduzca aunque AudioListener.pause esté establecido en true. Esto es útil para los sonidos de los elementos del menú o la música de fondo en los menús de pausa.
ignoreListenerVolumeEsto haced que el audio source no tome en cuenta el volumen del audio listener.
isPlayingEstá clip reproduciéndose ahora (Lectura Solamente)?
isVirtualTrue si todos los sonidos reproducidos por el AudioSource (sonido principal reproducido por Play() o playOnAwake al igual que one-shots) se eliminan del sistema de audio.
loopEstá el clip de audio en un bucle?
maxDistance(Logarithmic rolloff) MaxDistance es la distancia que un sonido para de atenuarse.
minDistanceDentro de la distancia Min el AudioSource parará de crecer en volumen.
muteUn- / Mutes el AudioSource. Mute establece el volume=0, Un-Mute recupera el volumen original.
outputAudioMixerGroupEl grupo objetivo al cual el AudioSource debería dirigir su señal.
panStereoReproduce un sonido en estéreo (izquierda o derecha). Esto sólo se aplica a los sonidos que son Mono o estéreo.
pitchEl tono del audio source.
playOnAwakeSi se establece en true, el audio source comenzará automáticamente a reproducirse despierto.
priorityEstablece la prioridad del AudioSource.
reverbZoneMixLa cantidad por la cual la señal de AudioSource se mezclará en la reverberación global asociada con las zonas de reverberación.
rolloffModeSets/Gets cómo el AudioSource se atenúa sobre la distancia.
spatialBlendEstablece la cantidad que este AudioSource se ve afectado por cálculos de espacialización 3D (atenuación, Doppler, etc). 0.0 hace el sonido completamente 2D, 1.0 lo hace en 3D completo.
spatializeHabilita o desactiva la espacialización.
spatializePostEffectsDetermines if the spatializer effect is inserted before or after the effect filters.
spreadEstable el ángulo spread (propagación) (en grados) de un estéreo 3d o sonido multi-canal en el espacio speaker.
timePosición de reproducción en segundos.
timeSamplesPosición de reproducción en muestras PCM.
velocityUpdateModeSi la fuente de audio debe actualizarse en la actualización fija o dinámica.
volumeEl volumen del audio source (0.0 a 1.0).

Funciones Públicas

DisableDualShock4OutputDisables playing of audio source though any enabled DUALSHOCK™4 controller.
GetAmbisonicDecoderFloatReads a user-defined parameter of a custom ambisonic decoder effect that is attached to an AudioSource.
GetCustomCurveObtiene la curva personalizada actual para el dado AudioSourceCurveType.
GetOutputDataProporciona un bloque de los datos de salida de la fuente que se está reproduciendo.
GetSpatializerFloatLee un parámetro definido por el usuario de un efecto espacial personalizado que se adjunta a una AudioSource.
GetSpectrumDataProporciona un bloque de los datos del espectro actual del audio source.
PausePausa de reproducir el clip.
PlayPlays the clip.
PlayDelayedReproduce el clip con un retraso especificado en segundos. Se aconseja a los usuarios utilizar esta función en lugar de la antigua función Play(delay) que tomó un retraso especificado en las muestras en relación con una tasa de referencia de 44,1 kHz como argumento.
PlayOnDualShock4Enable playing of audio source though a specfic DUALSHOCK™4 controller.
PlayOneShotReproduce un AudioClip, y escala el volumen del AudioSource por volumeScale.
PlayScheduledReproduce el clip en un tiempo especifico en la linea de tiempo absoluta que AudioSettings.dspTime lee de.
SetAmbisonicDecoderFloatSets a user-defined parameter of a custom ambisonic decoder effect that is attached to an AudioSource.
SetCustomCurveEstablece la curva personalizada para el AudioSourceCurveType dado.
SetScheduledEndTimeCambia el tiempo en la que finalizará un sonido que ya está programado para reproducirse. Observe que, dependiendo del momento, no se pueden cumplir todas las solicitudes de re-programación.
SetScheduledStartTimeCambia la hora en la que se iniciará un sonido que ya ha sido programado para reproducir.
SetSpatializerFloatEstablece un parámetro definido por el usuario de un efecto espacializador personalizado que está adjunto a un AudioSource.
StopPara de reproducer el clip.
UnPauseRepara la reproducción en pausa de este AudioSource.

Funciones Estáticas

PlayClipAtPointReproduce un AudioClip en una posición dada en el espacio del mundo.

Miembros heredados

Variables

enabledEnabled Behaviours are Updated, disabled Behaviours are not.
isActiveAndEnabledHas the Behaviour had active and enabled called?
gameObjectEl game object que tiene este componente adjunto. Un componente siempre está adjunto a un game object.
tagEl tag de este game object.
transformThe Transform attached to this GameObject.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameEl nombre del objeto.

Funciones Públicas

BroadcastMessageLlama al método denominado methodName de todos los MonoBehaviour en este game objecto en cualquiera de sus hijos.
CompareTag¿Este game object está etiquetado con tag?
GetComponentDevuelve un componente de tipo type si el game object tiene a alguno adjuntado, o null si no lo tiene.
GetComponentInChildrenRetorna el componente de tipo type en el GameObject o cualquiera de sus hijos utilizando depth first search (busqueda de profundidad).
GetComponentInParentRetorna el componente de tipo type en el GameObject o cualquiera de sus padres.
GetComponentsRetorna todos los componentes de tipo type en el GameObject.
GetComponentsInChildrenRetorna todos los componentes de tipo type en el GameObject o cualquiera de sus hijo.
GetComponentsInParentRetorna todos los componentes de tipo type en el GameObject o cualquiera de sus padres.
SendMessageLlama al método denominado methodName en cada MonoBehaviour de este game object.
SendMessageUpwardsLlama al método denominado methodName en todos los MonoBehaviour de este juego y en todos los ancestros del behaviour.
GetInstanceIDDevuelve el id de la instancia del objeto.
ToStringReturns the name of the GameObject.

Funciones Estáticas

DestroyElimina un gameobject, componente o asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeDevuelve el primer objeto activo cargado de tipo type.
FindObjectsOfTypeDevuelve una lista de todos los objetos activos cargados de tipo type.
InstantiateClona el objeto original y devuelve el clon.

Operadores

bool¿Existe el objeto?
operator !=Compare si dos objetos se refieren a un objeto diferente.
operator ==Compara dos referencias de objeto para ver si se refieren al mismo objeto.