Exapmle of AudioMgr

Since Cocos Creator 3.x removed the v2.x cc.audioEngine related API, only AudioSource can be used to control audio playback.

However, in actual project development, we still need an audio playback manager that can be conveniently called anytime and anywhere, which can refer to or directly use the following code.

  1. //AudioMgr.ts
  2. import { Node, AudioSource, AudioClip, resources, director } from 'cc';
  3. /**
  4.  * @en
  5.  * this is a sington class for audio play, can be easily called from anywhere in you project.
  6.  * @zh
  7.  * 这是一个用于播放音频的单件类，可以很方便地在项目的任何地方调用。
  8.  */ 
  9. export class AudioMgr {
  10.     private static _inst: AudioMgr;
  11.     public static get inst(): AudioMgr {
  12.         if (this._inst == null) {
  13.             this._inst = new AudioMgr();
  14.         }
  15.         return this._inst;
  16.     }
  18.     private _audioSource: AudioSource;
  19.     constructor() {
  20.         //@en create a node as audioMgr
  21.         //@zh 创建一个节点作为 audioMgr
  22.         let audioMgr = new Node();
  23.         audioMgr.name = '__audioMgr__';
  25.         //@en add to the scene.
  26.         //@zh 添加节点到场景
  27.         director.getScene().addChild(audioMgr);
  29.         //@en make it as a persistent node, so it won't be destroied when scene change.
  30.         //@zh 标记为常驻节点，这样场景切换的时候就不会被销毁了
  31.         director.addPersistRootNode(audioMgr);
  33.         //@en add AudioSource componrnt to play audios.
  34.         //@zh 添加 AudioSource 组件，用于播放音频。
  35.         this._audioSource = audioMgr.addComponent(AudioSource);
  36.     }
  38.     public get audioSource() {
  39.         return this._audioSource;
  40.     }
  42.     /**
  43.      * @en
  44.      * play short audio, such as strikes,explosions
  45.      * @zh
  46.      * 播放短音频,比如 打击音效，爆炸音效等
  47.      * @param sound clip or url for the audio
  48.      * @param volume 
  49.      */
  50.     playOneShot(sound: AudioClip | string, volume: number = 1.0) {
  51.         if (sound instanceof AudioClip) {
  52.             this._audioSource.playOneShot(sound, volume);
  53.         }
  54.         else {
  55.             resources.load(sound, (err, clip: AudioClip) => {
  56.                 if (err) {
  57.                     console.log(err);
  58.                 }
  59.                 else {
  60.                     this._audioSource.playOneShot(clip, volume);
  61.                 }
  62.             });
  63.         }
  64.     }
  66.     /**
  67.      * @en
  68.      * play long audio, such as the bg music
  69.      * @zh
  70.      * 播放长音频，比如 背景音乐
  71.      * @param sound clip or url for the sound
  72.      * @param volume 
  73.      */
  74.     play(sound: AudioClip | string, volume: number = 1.0) {
  75.         if (sound instanceof AudioClip) {
  76.             this._audioSource.clip = sound;
  77.             this._audioSource.play();
  78.             this.audioSource.volume = volume;
  79.         }
  80.         else {
  81.             resources.load(sound, (err, clip: AudioClip) => {
  82.                 if (err) {
  83.                     console.log(err);
  84.                 }
  85.                 else {
  86.                     this._audioSource.clip = clip;
  87.                     this._audioSource.play();
  88.                     this.audioSource.volume = volume;
  89.                 }
  90.             });
  91.         }
  92.     }
  94.     /**
  95.      * stop the audio play
  96.      */
  97.     stop() {
  98.         this._audioSource.stop();
  99.     }
  101.     /**
  102.      * pause the audio play
  103.      */
  104.     pause() {
  105.         this._audioSource.pause();
  106.     }
  108.     /**
  109.      * resume the audio play
  110.      */
  111.     resume(){
  112.         this._audioSource.play();
  113.     }
  114. }