Search Results for

    Show / Hide Table of Contents

    Class MusicPlayer

    A Singleton audio player that can crossfade songs.

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    SingletonBehaviour
    SingletonBehaviour<MusicPlayer>
    AbstractPlayer<MusicPlayer>
    MusicPlayer
    Inherited Members
    AbstractPlayer<MusicPlayer>.mixerGroup
    AbstractPlayer<MusicPlayer>.player
    AbstractPlayer<MusicPlayer>.Play(AudioClip, float)
    AbstractPlayer<MusicPlayer>.Stop()
    SingletonBehaviour<MusicPlayer>.Instance
    SingletonBehaviour<MusicPlayer>.Initialized
    Namespace: GGL.Audio.Player
    Assembly: GGL.dll
    Syntax
    [AddComponentMenu("GG-Library/Singletons/Audio/Music Player")]
    [HelpURL("https://ggl.yoannhaffner.com/articles/audio.html#optimisation")]
    public class MusicPlayer : AbstractPlayer<MusicPlayer>

    Fields

    | Edit this page View Source

    player2

    Declaration
    [SerializeField]
    protected AudioSource player2
    Field Value
    Type Description
    AudioSource

    A Second audio player used for crossfade transition

    Methods

    | Edit this page View Source

    Play(AudioClip, float, float)

    Play an audio file on the Singleton audio player with a cross-fading.

    Declaration
    public static void Play(AudioClip clip, float volume, float crossFade)
    Parameters
    Type Name Description
    AudioClip clip

    Audio file to play.

    float volume

    Volume in range [0;1].

    float crossFade

    Cross-fading duration in seconds.

    | Edit this page View Source

    PlayClip(AudioClip, float)

    Play an audio file on the Singleton audio player with a 200ms default cross-fading (it sounds nice :3) .

    Declaration
    protected override void PlayClip(AudioClip clip, float volume = 1)
    Parameters
    Type Name Description
    AudioClip clip

    Audio file to play.

    float volume

    Volume in range [0;1].

    Overrides
    AbstractPlayer<MusicPlayer>.PlayClip(AudioClip, float)
    | Edit this page View Source

    Stop(float)

    Stop whatever is being played... with a fading.

    Declaration
    public static void Stop(float fading)
    Parameters
    Type Name Description
    float fading
    | Edit this page View Source

    StopClip()

    Stop whatever is being played with a 200ms default fading.

    Declaration
    protected override void StopClip()
    Overrides
    AbstractPlayer<MusicPlayer>.StopClip()
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX