Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AudioClip

音频片段资源,每个片段知道自己应该如何播放、寻址等。 每当音频片段实际开始播放时,会发出 'started' 事件; 每当音频片段自然结束播放时,会发出 'ended' 事件。

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected _audio

_audio: any = null

_callbackTable

_callbackTable: any = createMap(true)

IEventTarget 实现,它们将被 applyMixins 在 EventTarget 中用相同的实现覆盖

Protected _duration

_duration: number = 0

Protected _loadMode

_loadMode: number = AudioType.UNKNOWN_AUDIO

Protected _name

_name: string

_native

_native: string = ""

用于本机资产的可序列化URL。供内部使用。

default

""

_objFlags

_objFlags: number

Protected _player

_player: AudioPlayer | null = null

_uuid

_uuid: string

内部使用。

loaded

loaded: boolean = true

该资源是否已经成功加载。

Static AudioType

AudioType: object = AudioType

Type declaration

  • DOM_AUDIO: number
  • JSB_AUDIO: number
  • UNKNOWN_AUDIO: number
  • WEB_AUDIO: number

Static PlayingState

PlayingState: object = PlayingState

Type declaration

  • INITIALIZING: number
  • PLAYING: number
  • STOPPED: number

Static preventDeferredLoadDependents

preventDeferredLoadDependents: boolean = true

Static preventPreloadNativeObject

preventPreloadNativeObject: boolean = false

禁止预加载原生对象。

property

{Boolean} preventPreloadNativeObject

default

false

static

Accessors

nativeAsset

  • get nativeAsset(): any
  • set nativeAsset(clip: any): void
  • Returns any

  • Parameters

    • clip: any

    Returns void

isValid

  • get isValid(): boolean
  • 表示该对象是否可用(被 destroy 后将不可用)。
    当一个对象的 destroy 调用以后,会在这一帧结束后才真正销毁。
    因此从下一帧开始 isValid 就会返回 false,而当前帧内 isValid 仍然会是 true。
    如果希望判断当前帧是否调用过 destroy,请使用 cc.isValid(obj, true),不过这往往是特殊的业务需求引起的,通常情况下不需要这样。

    property

    {Boolean} isValid

    default

    true

    readonly
    example
    import * as cc from 'cc';
    var node = new cc.Node();
    cc.log(node.isValid);    // true
    node.destroy();
    cc.log(node.isValid);    // true, still valid in this frame
    // after a frame...
    cc.log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

loadMode

  • get loadMode(): number
  • Returns number

name

  • get name(): string
  • set name(value: string): void
  • 该对象的名称。

    property

    {String} name

    default

    ""

    example
    obj.name = "New Obj";

    Returns string

  • Parameters

    • value: string

    Returns void

nativeUrl

  • get nativeUrl(): string
  • 返回该资源对应的目标平台资源的 URL,如果没有将返回一个空字符串。

    property

    nativeUrl

    type

    {String}

    readonly

    Returns string

state

  • get state(): number
  • Returns number

Methods

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void
  • Clear all references in the instance.

    NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

    Returns void

Private getPlayer

  • getPlayer(clip: any): any
  • Parameters

    • clip: any

    Returns any

Private setRawAsset

  • setRawAsset(filename: string, inLibrary?: boolean): void
  • 为此资源设置原始文件名。

    seealso

    nativeUrl

    Parameters

    • filename: string
    • Default value inLibrary: boolean = true

    Returns void

Optional createNode

  • 使用该资源在场景中创建一个新节点。
    如果这类资源没有相应的节点类型,该方法应该是空的。

    Parameters

    Returns void

destroy

  • destroy(): boolean
  • Returns boolean

dispatchEvent

  • dispatchEvent(event: Event): void
  • Parameters

    Returns void

emit

  • emit(key: string, ...args: any[]): void
  • Parameters

    • key: string
    • Rest ...args: any[]

    Returns void

getCurrentTime

  • getCurrentTime(): number
  • Returns number

getDuration

  • getDuration(): number
  • Returns number

getLoop

  • getLoop(): boolean
  • Returns boolean

getVolume

  • getVolume(): number
  • Returns number

hasEventListener

  • hasEventListener(key: string, callback?: Function | undefined, target?: Object | undefined): boolean
  • Parameters

    • key: string
    • Optional callback: Function | undefined
    • Optional target: Object | undefined

    Returns boolean

off

  • off(type: string, callback?: Function | undefined, target?: Object | undefined): void
  • Parameters

    • type: string
    • Optional callback: Function | undefined
    • Optional target: Object | undefined

    Returns void

on

  • on(type: string, callback: Function, target?: Object | undefined): Function | undefined
  • Parameters

    • type: string
    • callback: Function
    • Optional target: Object | undefined

    Returns Function | undefined

once

  • once(type: string, callback: Function, target?: Object | undefined): Function | undefined
  • Parameters

    • type: string
    • callback: Function
    • Optional target: Object | undefined

    Returns Function | undefined

pause

  • pause(): void
  • Returns void

play

  • play(): void
  • Returns void

playOneShot

  • playOneShot(volume: number): void
  • Parameters

    • volume: number

    Returns void

removeAll

  • removeAll(keyOrTarget?: string | Object | undefined): void
  • Parameters

    • Optional keyOrTarget: string | Object | undefined

    Returns void

setCurrentTime

  • setCurrentTime(val: number): void
  • Parameters

    • val: number

    Returns void

setLoop

  • setLoop(val: boolean): void
  • Parameters

    • val: boolean

    Returns void

setVolume

  • setVolume(val: number, immediate?: undefined | false | true): void
  • Parameters

    • val: number
    • Optional immediate: undefined | false | true

    Returns void

stop

  • stop(): void
  • Returns void

targetOff

  • targetOff(keyOrTarget?: string | Object | undefined): void
  • Parameters

    • Optional keyOrTarget: string | Object | undefined

    Returns void

toString

  • toString(): string
  • 返回对象的字符串表示形式。
    Asset 对象将会重写 Object 对象的 toString() 方法。
    当资源要表示为文本值时或在字符串连接时引用时,
    JavaScript 会自动调用 toString() 方法。

    对于原始类型的资源,它将返回this.nativeUrl
    否则,返回空字符串。
    子类可能会覆盖此方法。

    method

    toString

    Returns string

Static deferredDestroy

  • _deferredDestroy(): void

Static deserialize

  • deserialize(data: any): any
  • 应 AssetDB 要求提供这个方法。

    method

    deserialize

    Parameters

    • data: any

    Returns any

Static isRawAssetType

  • isRawAssetType(ctor: Function): boolean
  • 内部使用。

    Parameters

    • ctor: Function

    Returns boolean

Generated using TypeDoc