Class PlaySound

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

PlaySound

Inherited Members

UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)

UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)

UnityEngine.MonoBehaviour.CancelInvoke()

UnityEngine.MonoBehaviour.CancelInvoke(System.String)

UnityEngine.MonoBehaviour.IsInvoking(System.String)

UnityEngine.MonoBehaviour.IsInvoking()

UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)

UnityEngine.MonoBehaviour.StartCoroutine(System.String)

UnityEngine.MonoBehaviour.StopCoroutine(System.String)

UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)

UnityEngine.MonoBehaviour.StopAllCoroutines()

UnityEngine.MonoBehaviour.print(System.Object)

UnityEngine.MonoBehaviour.useGUILayout

UnityEngine.Behaviour.enabled

UnityEngine.Behaviour.isActiveAndEnabled

UnityEngine.Component.GetComponent(System.Type)

UnityEngine.Component.GetComponent<T>()

UnityEngine.Component.GetComponent(System.String)

UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInChildren(System.Type)

UnityEngine.Component.GetComponentInChildren<T>()

UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren(System.Type)

UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInChildren<T>()

UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentInParent(System.Type)

UnityEngine.Component.GetComponentInParent<T>()

UnityEngine.Component.GetComponentsInParent(System.Type)

UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInParent<T>()

UnityEngine.Component.GetComponents(System.Type)

UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)

UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponents<T>()

UnityEngine.Component.CompareTag(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object)

UnityEngine.Component.SendMessageUpwards(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object)

UnityEngine.Component.SendMessage(System.String)

UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object)

UnityEngine.Component.BroadcastMessage(System.String)

UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.transform

UnityEngine.Component.gameObject

UnityEngine.Component.tag

UnityEngine.Component.rigidbody

UnityEngine.Component.rigidbody2D

UnityEngine.Component.camera

UnityEngine.Component.light

UnityEngine.Component.animation

UnityEngine.Component.constantForce

UnityEngine.Component.renderer

UnityEngine.Component.audio

UnityEngine.Component.guiText

UnityEngine.Component.networkView

UnityEngine.Component.guiElement

UnityEngine.Component.guiTexture

UnityEngine.Component.collider

UnityEngine.Component.collider2D

UnityEngine.Component.hingeJoint

UnityEngine.Component.particleEmitter

UnityEngine.Component.particleSystem

UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)

UnityEngine.Object.Destroy(UnityEngine.Object)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object)

UnityEngine.Object.FindObjectsOfType(System.Type)

UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)

UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)

UnityEngine.Object.DestroyObject(UnityEngine.Object)

UnityEngine.Object.FindSceneObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.ToString()

UnityEngine.Object.GetInstanceID()

UnityEngine.Object.GetHashCode()

UnityEngine.Object.Equals(System.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Instantiate<T>(T)

UnityEngine.Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.name

UnityEngine.Object.hideFlags

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Valve.VR.InteractionSystem

Assembly: Assembly-CSharp.dll

Syntax

[RequireComponent(typeof(AudioSource))]
public class PlaySound : MonoBehaviour

Fields

delayOffsetTime

Declaration

[Header("Delay Time")]
[Tooltip("Time to offset playback of sound")]
public float delayOffsetTime

Field Value

Type	Description
System.Single

disableOnEnd

Declaration

[Tooltip("After the audio clip finishes playing, disable the game object the sound is on.")]
public bool disableOnEnd

Field Value

Type	Description
System.Boolean

looping

Declaration

[Tooltip("Loop the sound after the wave file variation has been chosen.")]
public bool looping

Field Value

Type	Description
System.Boolean

percentToNotPlay

Declaration

[Tooltip("Percent chance that the wave file will not play")]
[Range(0F, 1F)]
public float percentToNotPlay

Field Value

Type	Description
System.Single

pitchMax

Declaration

[Tooltip("Maximum pitch that will be used when randomly set.")]
[Range(-3F, 3F)]
public float pitchMax

Field Value

Type	Description
System.Single

pitchMin

Declaration

[Tooltip("Minimum pitch that will be used when randomly set.")]
[Range(-3F, 3F)]
public float pitchMin

Field Value

Type	Description
System.Single

playOnAwakeWithDelay

Declaration

[Tooltip("Start a wave file playing on awake, but after a delay.")]
public bool playOnAwakeWithDelay

Field Value

Type	Description
System.Boolean

stopOnEnd

Declaration

[Tooltip("If the sound is looping and updating it's position every frame, stop the sound at the end of the wav/clip length. ")]
public bool stopOnEnd

Field Value

Type	Description
System.Boolean

stopOnPlay

Declaration

[Tooltip("Stops the currently playing clip in the audioSource. Otherwise clips will overlap/mix.")]
public bool stopOnPlay

Field Value

Type	Description
System.Boolean

timeInitial

Declaration

[Tooltip("Inital time before the first repetion starts")]
[Range(0F, 360F)]
public float timeInitial

Field Value

Type	Description
System.Single

timeMax

Declaration

[Tooltip("Maximum pitch that will be used when randomly set.")]
[Range(0F, 360F)]
public float timeMax

Field Value

Type	Description
System.Single

timeMin

Declaration

[Tooltip("Minimum time that will pass before the sound is retriggered")]
[Range(0F, 360F)]
public float timeMin

Field Value

Type	Description
System.Single

useRandomPitch

Declaration

[Header("Random Pitch")]
[Tooltip("Use min and max random pitch levels when playing sounds.")]
public bool useRandomPitch

Field Value

Type	Description
System.Boolean

useRandomSilence

Declaration

[Header("Random Silence")]
[Tooltip("Use Retrigger Time to repeat the sound within a time range")]
public bool useRandomSilence

Field Value

Type	Description
System.Boolean

useRandomVolume

Declaration

[Header("Random Volume")]
public bool useRandomVolume

Field Value

Type	Description
System.Boolean

useRetriggerTime

Declaration

[Header("Random Time")]
[Tooltip("Use Retrigger Time to repeat the sound within a time range")]
public bool useRetriggerTime

Field Value

Type	Description
System.Boolean

volMax

Declaration

[Tooltip("Maximum volume that will be used when randomly set.")]
[Range(0F, 1F)]
public float volMax

Field Value

Type	Description
System.Single

volMin

Declaration

[Tooltip("Minimum volume that will be used when randomly set.")]
[Range(0F, 1F)]
public float volMin

Field Value

Type	Description
System.Single

waveFile

Declaration

[Tooltip("List of audio clips to play.")]
public AudioClip[] waveFile

Field Value

Type	Description
UnityEngine.AudioClip[]

Methods

Disable()

Declaration

public void Disable()

Play()

Declaration

public void Play()

PlayLooping()

Declaration

public AudioClip PlayLooping()

Returns

Type	Description
UnityEngine.AudioClip

PlayOneShotSound()

Declaration

public AudioClip PlayOneShotSound()

Returns

Type	Description
UnityEngine.AudioClip

PlayWithDelay(Single)

Declaration

public void PlayWithDelay(float delayTime)

Parameters

Type	Name	Description
System.Single	delayTime

Stop()

Declaration

public void Stop()