docs.unity3d.com
    Show / Hide Table of Contents

    Class LocalizeAudioClipEvent

    Component that can be used to Localize an AudioClip asset. Provides an update event OnUpdateAsset that can be used to automatically update the clip whenever the SelectedLocale or AssetReference changes.

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    LocalizedMonoBehaviour
    LocalizedAssetBehaviour<AudioClip, LocalizedAudioClip>
    LocalizedAssetEvent<AudioClip, LocalizedAudioClip, UnityEventAudioClip>
    LocalizeAudioClipEvent
    Inherited Members
    LocalizedAssetEvent<AudioClip, LocalizedAudioClip, UnityEventAudioClip>.OnUpdateAsset
    LocalizedAssetEvent<AudioClip, LocalizedAudioClip, UnityEventAudioClip>.UpdateAsset(AudioClip)
    LocalizedAssetBehaviour<AudioClip, LocalizedAudioClip>.AssetReference
    LocalizedAssetBehaviour<AudioClip, LocalizedAudioClip>.UpdateAsset(AudioClip)
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    MonoBehaviour.CancelInvoke(String)
    MonoBehaviour.IsInvoking(String)
    MonoBehaviour.StartCoroutine(String)
    MonoBehaviour.StartCoroutine(String, Object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(String)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(Object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(String)
    Component.SendMessageUpwards(String, Object, SendMessageOptions)
    Component.SendMessageUpwards(String, Object)
    Component.SendMessageUpwards(String)
    Component.SendMessageUpwards(String, SendMessageOptions)
    Component.SendMessage(String, Object)
    Component.SendMessage(String)
    Component.SendMessage(String, Object, SendMessageOptions)
    Component.SendMessage(String, SendMessageOptions)
    Component.BroadcastMessage(String, Object, SendMessageOptions)
    Component.BroadcastMessage(String, Object)
    Component.BroadcastMessage(String)
    Component.BroadcastMessage(String, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Component.rigidbody
    Component.rigidbody2D
    Component.camera
    Component.light
    Component.animation
    Component.constantForce
    Component.renderer
    Component.audio
    Component.networkView
    Component.collider
    Component.collider2D
    Component.hingeJoint
    Component.particleSystem
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.name
    Object.hideFlags
    Namespace: UnityEngine.Localization.Components
    Syntax
    [AddComponentMenu("Localization/Asset/Localize Audio Clip Event")]
    public class LocalizeAudioClipEvent : LocalizedAssetEvent<AudioClip, LocalizedAudioClip, UnityEventAudioClip>
    Remarks

    This component can also be added through the Localize menu item in the Audio Source context menu. Adding it this way will also automatically configure the Update Asset events to update the Audio Source.

    Examples

    This example shows how a Localized Audio Control panel could be created. The example show how it is possible to switch between different Localized Audio clips.

    #if MODULE_AUDIO
    
    using UnityEngine;
    using UnityEngine.Localization;
    using UnityEngine.Localization.Components;
    
    public class LocalizedAudioChanger : MonoBehaviour
    {
    public LocalizeAudioClipEvent localizeAudioClipEvent;
    public LocalizedAudioClip[] clips;
    public AudioSource audioSource;
    int currentClip = 0;
    
    private void Start()
    {
        // Start playing the first AudioClip.
        ChangeAudio(clips[currentClip]);
    }
    
    private void OnGUI()
    {
        GUILayout.BeginHorizontal();
    
        if (GUILayout.Button("Previous"))
        {
            if (currentClip == 0)
                currentClip = clips.Length - 1;
            else
                currentClip--;
            ChangeAudio(clips[currentClip]);
        }
    
        // Show the current clip that is playing
        GUILayout.Label(audioSource.clip?.name);
    
        if (GUILayout.Button("Next"))
        {
            if (currentClip == clips.Length - 1)
                currentClip = 0;
            else
                currentClip++;
            ChangeAudio(clips[currentClip]);
        }
    
        GUILayout.EndHorizontal();
    }
    
    void ChangeAudio(LocalizedAudioClip clip)
    {
        // When we assign a new AssetReference the system will automatically load the new Audio clip and then call the AssetChanged event.
        localizeAudioClipEvent.AssetReference = clip;
    }
    }
    
    #endif
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023