Clip <Metadata>

Index

Constructors

• constructor

Properties

• adapter
• buffered
• context
• ended
• length
• loader
• loop
• metadata
• playing
• url

Accessors

• _chunks
• canplaythrough
• currentTime
• duration
• loaded
• paused
• stuck
• volume

Methods

• _disconnectAllAndReplaceAudioContext
• buffer
• clone
• connect
• disconnect
• dispose
• fade
• off
• on
• once
• pause
• play

Constructors

constructor

• new Clip<Metadata>(__namedParameters: { adapter: IAdapter<Metadata>; context?: IAudioContext; loop?: boolean; url: string; volume?: number }): default<Metadata>

• Type parameters

  • Metadata

  Parameters

  • __namedParameters: { adapter: IAdapter<Metadata>; context?: IAudioContext; loop?: boolean; url: string; volume?: number }

  Returns default<Metadata>

Properties

readonlyadapter

adapter: IAdapter<Metadata>

buffered

buffered: number = 0

context

context: IAudioContext

ended

ended: boolean = false

length

length: number = 0

loader

loader: Loader

loop

loop: boolean

metadata

metadata: Metadata = null

playing

playing: boolean = false

url

url: string

Accessors

public_chunks

• get _chunks(): default<Metadata>[]
• set _chunks(value: default<Metadata>[]): void

• Returns default<Metadata>[]

• Parameters

  • value: default<Metadata>[]

  Returns void

publiccanplaythrough

• get canplaythrough(): boolean
• set canplaythrough(value: boolean): void

• Returns boolean

• Parameters

  • value: boolean

  Returns void

currentTime

• get currentTime(): number
• set currentTime(currentTime: number): void

• Returns number

• Parameters

  • currentTime: number

  Returns void

duration

• get duration(): number

• Returns number

publicloaded

• get loaded(): boolean
• set loaded(value: boolean): void

• Returns boolean

• Parameters

  • value: boolean

  Returns void

paused

• get paused(): boolean

• Returns boolean

publicstuck

• get stuck(): boolean

• Returns boolean

volume

• get volume(): number
• set volume(volume: number): void

• Returns number

• Parameters

  • volume: number

  Returns void

Methods

_disconnectAllAndReplaceAudioContext

• _disconnectAllAndReplaceAudioContext(newAudioContext: IAudioContext): void

• Parameters

  • newAudioContext: IAudioContext

  Returns void

buffer

• buffer(bufferToCompletion?: boolean): Promise<void>

• Parameters

  • bufferToCompletion: boolean = false

  Returns Promise<void>

clone

• clone(): default<Metadata>

• Returns default<Metadata>

connect

• connect(destination: IAudioNode<IAudioContext, {}>, output?: number, input?: number): default<Metadata>

• Parameters

  • destination: IAudioNode<IAudioContext, {}>

  • optionaloutput: number

  • optionalinput: number

  Returns default<Metadata>

disconnect

• disconnect(destination: IAudioNode<IAudioContext, {}>, output?: number, input?: number): void

• Parameters

  • destination: IAudioNode<IAudioContext, {}>

  • optionaloutput: number

  • optionalinput: number

  Returns void

dispose

• dispose(): void

• Returns void

fade

• fade(startVolume: number, endVolume: number, duration: number): void

• Parameters

  • startVolume: number

  • endVolume: number

  • duration: number

  Returns void

off

• off(eventName: string, cb: (data?: any) => void): void

• Parameters

  • eventName: string

  • cb: (data?: any) => void

  Returns void

on

• on(eventName: string, cb: (data?: any) => void): { cancel: () => void }

• Parameters

  • eventName: string

  • cb: (data?: any) => void

  Returns { cancel: () => void }

  • cancel: () => void

    • • (): void

      • Returns void

once

• once(eventName: string, cb: (data?: any) => void): { cancel: () => void }

• Parameters

  • eventName: string

  • cb: (data?: any) => void

  Returns { cancel: () => void }

  • cancel: () => void

    • • (): void

      • Returns void

pause

• pause(): default<Metadata>

• Returns default<Metadata>

play

• play(): Promise<unknown>

• Returns Promise<unknown>