Unity 6.3
0 онлайн 62 гостей 3 в системе
Вход

AudioSource

класс в UnityEngine

Наследуется от:Behaviour

Выполнено в:UnityEngine.AudioModule

Описание

Представление источников звука в 3D.

Присоедините AudioSource к GameObject для воспроизведения звуков в среде 3D. Для воспроизведения звуков 3D вам также необходимо иметь AudioListener. Обычно, вы можете найти аудио слушателя, прикрепленный к камере в вашей сцене. Если вы установите AudioSource.spatialBlend Если вы установите его на 0.0f, то Unity будет рассматривать аудиоклип как звук 2D. Если вы установите его на 1.0f, то клип будет полностью 3D. Все между ними будет смесь 2D и 3D.

Чтобы воспроизвести, приостановить и остановить один аудиоклип, используйте Play, Pause и Stop. Чтобы настроить громкость во время воспроизведения, используйте volume свойство. использование time Для воспроизведения нескольких звуков на одном AudioSource, используйте PlayOneShot. Чтобы воспроизвести клип в фиксированной точке 3D-пространства, используйте PlayClipAtPoint.

Дополнительные ресурсы: AudioListener, AudioClip, AudioRandomContainer, IAudioGenerator и AudioSource компонент.

//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 && 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 && 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; } } }

Свойства

Свойство Описание
bypassEffectsЭффекты обхода (применяются из компонентов фильтра или глобальных фильтров слушателя).
bypassListenerEffectsЕсли установлено, глобальные эффекты на AudioListener не применяются к аудиосигналу, генерируемому AudioSource. Они также не применяются, если AudioSource воспроизводится в группе микшеров.
bypassReverbZonesКогда установлено, оно не направляет сигнал из AudioSource в глобальную реверберацию, связанную с зонами реверберации.
clipПо умолчанию AudioClip для воспроизведения.
dopplerLevelУстанавливает шкалу Доплера для этого AudioSource.
gamepadSpeakerOutputTypeПолучает или устанавливает тип аудиовывода геймпада для данного источника звука.
generatorПо умолчанию IAudioGenerator, чтобы играть дальше.
generatorInstanceРуководство по текущему генератору, если он может быть управляем с помощью скрипта.
ignoreListenerPauseПозволяет воспроизводить AudioSource даже если AudioListener.pause установлено в true. Это полезно для звуков элементов меню или фоновой музыки в меню паузы.
ignoreListenerVolumeЭто делает источник звука не принимать во внимание громкость аудио слушателя.
isPlayingВозвращает, играет ли AudioSource в настоящее время AudioResource(Read Only).
isVirtualTrue, если все звуки, воспроизводимые AudioSource, такие как основной звук, начатый Play() или playOnAwake, и одиночные звуки отбрасываются аудиосистемой.
loopПроверяет, не повторяется ли аудиоклип
maxDistanceРасстояние, на котором звук либо становится неслышимым, либо прекращает ослабление, в зависимости от режима отключения.
minDistanceВ пределах Минимального расстояния AudioSource перестанет расти в громкости.
muteUn- / Mutes AudioSource. Mute устанавливает volume=0, Un-Mute восстанавливает первоначальный объем.
outputAudioMixerGroupЦелевая группа, к которой AudioSource должен направлять свой сигнал.
panStereoПоворачивает воспроизводимый звук в стерео (влево или вправо). Это применяется только к звукам, которые являются Mono или Stereo.
pitchВысота источника звука.
playOnAwakeВключите это свойство для автоматического воспроизведения источника звука, когда компонент или GameObject становится активным.
priorityУстанавливает приоритет AudioSource.
resourceПо умолчанию AudioResource для воспроизведения.
reverbZoneMixРазмер, на который сигнал из AudioSource будет смешан в глобальную реверберацию, связанную с Reverb Zones.
rolloffModeЗадает/получает как AudioSource затухает на расстоянии.
spatialBlendЗадает, насколько сильно этот AudioSource подвержен влиянию 3D расчетов пространственного распределения (уменьшение, доплер и т.д.). 0.0 делает звук полным 2D, 1.0 делает его полным 3D.
spatializeВключает или отключает пространственную локализацию.
spatializePostEffectsОпределяет, вставляется ли эффект пространственности перед или после фильтров эффектов.
spreadУказывает угол распространения (в градусах) 3D-стерео или многоканального звука в пространстве динамиков.
timeПозиция воспроизведения источника звука в секундах.
timeSamplesТекущая позиция воспроизведения AudioSource в PCM семплах.
velocityUpdateModeСледует ли обновлять источник аудиосигнала при фиксированном или динамическом обновлении.
volumeОбъем источника звука (от 0.0 до 1.0).

Открытые методы

Метод Описание
DisableGamepadOutputОтключает аудиовыход на геймпад для этого источника звука.
GetAmbisonicDecoderFloatЧтение заданных пользователем параметров эффекта амбизонического декодера, который прикреплен к AudioSource.
GetCustomCurveПолучить текущую настраиваемую кривую для заданной AudioSourceCurveType.
GetOutputDataОбеспечивает блок выходных данных источника, который в данный момент воспроизводится.
GetSpatializerFloatЧтение определенного пользователем параметра настраиваемого эффекта spatializer, который прикреплен к AudioSource.
GetSpectrumDataОбеспечивает блок аудиочастот (спектральные данные) AudioSource, который в настоящее время воспроизводится.
PauseПриостанавливает воспроизведение клипа.
PlayПроигрывание клипа.
PlayDelayedВоспроизведение клипа с задержкой, указанной в секундах. Пользователям рекомендуется использовать эту функцию вместо старой функции Play(delay), которая принимала в качестве аргумента задержку, указанную в семплах, относительно базовой частоты 44.1 kHz.
PlayOneShotВоспроизведение AudioClip и масштабирование AudioSource на volumeScale.
PlayOnGamepadВключите источник звука для воспроизведения через определенный геймпад.
PlayScheduledВоспроизведение клипа в определенное время на абсолютной временной шкале, из которой читает AudioSettings.dspTime.
SetAmbisonicDecoderFloatУстанавливает определенный пользователем параметр пользовательского амбизонического эффекта декодера, который прикреплен к AudioSource.
SetCustomCurveУстанавливает пользовательскую кривую для данной AudioSourceCurveType.
SetScheduledEndTimeИзменяет время окончания звука, который уже был запланирован для воспроизведения. Обратите внимание, что в зависимости от времени не все запросы на перепланировку могут быть выполнены.
SetScheduledStartTimeИзменяет время, в которое будет воспроизводиться звук, который уже был запланирован для воспроизведения.
SetSpatializerFloatУстанавливает определенный пользователем параметр настраиваемого эффекта пространственности, который прикреплен к AudioSource.
StopПрекращает воспроизведение клипа.
UnPauseВозобновить приостановленное воспроизведение этого AudioSource.

Статические методы

Метод Описание
GamepadSpeakerSupportsOutputTypeПроверьте, поддерживает ли платформа тип аудиовывода на геймпадах.
PlayClipAtPointИграет AudioClip в заданной позиции в мировом пространстве.
Унаследованные члены 4

Свойства

СвойствоОписание
enabledTrue, если это Поведение включено, в противном случае false.
isActiveAndEnabledПроверяет, включён ли компонент, прикреплен ли он к GameObject, который активен в иерархии, и вызван ли OnEnable компонента.
gameObjectGameObject, к которому прикреплен данный компонент. Компонент всегда прикрепляется к игровому объекту.
tagТег этого игрового объекта.
transformTransform прикреплен к этому GameObject.
transformHandleTransformHandle этого GameObject.
hideFlagsДолжен ли объект быть скрытым, сохраняться с Scene или изменяться пользователем?
nameИмя объекта.

Открытые методы

МетодОписание
BroadcastMessageВызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте или любом из его дочерей.
CompareTagПроверяет тег GameObject на соответствие определенному тегу.
GetComponentПолучает ссылку на компонент типа T на том же GameObject, что и указанный компонент.
GetComponentInChildrenПолучает ссылку на компонент типа T на том же GameObject, что и указанный компонент, или на любого ребенка GameObject.
GetComponentIndexПолучает индекс компонента на его родительском GameObject.
GetComponentInParentПолучает ссылку на компонент типа T на том же GameObject, что и указанный компонент, или на любой родитель GameObject.
GetComponentsПолучает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент.
GetComponentsInChildrenПолучает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент, и на любого ребенка GameObject.
GetComponentsInParentПолучает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент, и любой родитель GameObject.
SendMessageВызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте.
SendMessageUpwardsВызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте и на каждом предшественнике поведения.
TryGetComponentПолучает компонент указанного типа, если он существует.
GetInstanceIDПолучает экземпляр ID объекта.
ToStringВозвращает имя объекта.

Статические методы

МетодОписание
DestroyУдаляет GameObject, компонент или ресурс.
DestroyImmediateНемедленно уничтожает указанный объект. Используйте с осторожностью и только в режиме редактирования.
DontDestroyOnLoadНе уничтожать целевой Объект при загрузке нового Scene.
FindAnyObjectByTypeПолучает любой активный загруженный объект типа Type.
FindFirstObjectByTypeПолучает первый активный загруженный объект типа Type.
FindObjectsByTypeПолучает список всех загруженных объектов типа Type.
InstantiateКлонирует исходный объект и возвращает клон.
InstantiateAsyncЗахватывает моментальный снимок первоначального объекта (который должен быть связан с каким-либо GameObject) и возвращает AsyncInstantiateOperation.

Операторы

ОператорОписание
boolСуществует ли объект?
оператор!=Сравнивает, если два объекта ссылаются на разные объекты.
оператор ==Сравнение двух ссылок на объекты для определения того, относятся ли они к одному и тому же объекту.