Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

AudioSource.PlayOneShot

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public function PlayOneShot(clip: AudioClip, volumeScale: float = 1.0F): void;
public void PlayOneShot(AudioClip clip, float volumeScale = 1.0F);
public def PlayOneShot(clip as AudioClip, volumeScale as float = 1.0F) as void

Parameters

clip The clip being played.
volumeScale The scale of the volume (0-1).

Description

Plays an AudioClip, and scales the AudioSource volume by volumeScale.

	@script RequireComponent(AudioSource)
	// Play impact audio clip at volume 0.7
	var impact : AudioClip;
	function OnCollisionEnter () {
		audio.PlayOneShot(impact, 0.7);
	}

using UnityEngine;
using System.Collections;

[RequireComponent(typeof(AudioSource))]
public class ExampleClass : MonoBehaviour {
    public AudioClip impact;
    void OnCollisionEnter() {
        audio.PlayOneShot(impact, 0.7F);
    }
}

import UnityEngine
import System.Collections

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

	public impact as AudioClip

	def OnCollisionEnter() as void:
		audio.PlayOneShot(impact, 0.7F)

See Also: AudioSource.Play.

Copyright © 2014 Unity Technologies
LearnCommunityAsset StoreBuyDownload