Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AudioClip

音频剪辑资源。

export

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • 资源的基类，弱引用逻辑。

    memberof

    BaseResource

    Returns AudioClip

Properties

Optional groupID

groupID: string

Optional resourceID

resourceID: string

编辑器中使用的资源id。

memberof

BaseResource

Readonly value

value: string = ...

音频播放链接，可以用于调用wx.createInnerAudio播放音频

memberof

AudioClip

Accessors

fileSrc

  • get fileSrc(): string

  • 音频播放链接，可以用于调用wx.createInnerAudio播放音频

    memberof

    AudioClip

    Returns string

length

  • get length(): number
  • set length(val: number): void

  • 音频时长，单位秒。当preloadAudioData=false 且 audioclip被用于时间线系统时，此属性才有用。

    Returns number

  • 音频时长，单位秒。当preloadAudioData=false 且 audioclip被用于时间线系统时，此属性才有用。

    Parameters

    • val: number

    Returns void

loadType

  • 设置audioclip的加载方式。只有当preloadAudioData=true时，此属性才有效

    memberof

    AudioClip

    Returns LoadType

  • 设置audioclip的加载方式。只有当preloadAudioData=true时，此属性才有效

    Parameters

    Returns void

preloadAudioData

  • get preloadAudioData(): boolean
  • set preloadAudioData(val: boolean): void

  • 是否把音频下载到本地。
    true：当通过engine.loader.load或其他方式加载audioclip资源时，会把音频文件下载到本地。播放音频时，实际是播放一个本地音频文件。只有preloadAudioData=true时，audioclip才能用于AudioSource。
    false: 该audioclip只能使用基础音频接口wx.createInnerAudioContext播放。此时是边播放边下载。

    memberof

    AudioClip

    Returns boolean

  • 是否把音频下载到本地。
    true：当通过engine.loader.load或其他方式加载audioclip资源时，会把音频文件下载到本地。播放音频时，实际是播放一个本地音频文件。只有preloadAudioData=true时，audioclip才能用于AudioSource。
    false: 该audioclip只能使用基础音频接口wx.createInnerAudioContext播放。此时是边播放边下载。

    Parameters

    • val: boolean

    Returns void

Methods

getAudioBuffer

  • getAudioBuffer(callback: (buffer: AudioBuffer) => void): void

  • 获取音频解码后的PCM数据。当preloadAudioData=true，且文件大小<9M，才有效。否则报错

    memberof

    AudioClip

    Parameters

    • callback: (buffer: AudioBuffer) => void

      回调函数

        • (buffer: AudioBuffer): void

        • Parameters

          • buffer: AudioBuffer

            解码后的PCM数据

          Returns void

    Returns void

releaseAudioBuffer

  • releaseAudioBuffer(buffer: AudioBuffer, time?: number): void

  • 当音频解码后的PCM数据没有被引用时，主动释放。

    memberof

    AudioClip

    Parameters

    • buffer: AudioBuffer

      通过getAudioBuffer函数获取的PCM数据。

    • time: number = 30000

      多少秒后开始释放。默认30秒。

    Returns void

Generated using TypeDoc