Class CogsAudioPlayer

Constructors

constructor

Properties

audioClipPlayers cogsConnection eventTarget globalVolume sinkId

Methods

addEventListener createClip createPlayer dispatchEvent handleStoppedClip notifyClipStateListeners notifyStateListeners pauseAudioClip playAudioClip removeEventListener setAudioClipVolume setAudioSink setGlobalVolume stopAllAudioClips stopAudioClip updateActiveAudioClip updateAudioClipPlayer updateConfig updatedClip

Constructors

constructor

Properties

Private audioClipPlayers

audioClipPlayers: {
    [path: string]: InternalClipPlayer;
} = {}

Type declaration

  • [path: string]: InternalClipPlayer

Private cogsConnection

cogsConnection: CogsConnection<any, Record<never, never>>

Private eventTarget

eventTarget: EventTarget = ...

Private globalVolume

globalVolume: number = 1

Private sinkId

sinkId: string = ''

Methods

addEventListener

  • addEventListener<EventName>(type, listener, options?): void

  • Type Parameters

    • EventName extends keyof EventTypes

    Parameters

    • type: EventName
    • listener: ((ev) => void)
        • (ev): void

        • Parameters

          Returns void

    • Optional options: boolean | AddEventListenerOptions

    Returns void

Private createClip

  • createClip(file, config): InternalClipPlayer

  • Parameters

    • file: string
    • config: {
          ephemeral: boolean;
          preload: boolean;
      }
      • ephemeral: boolean
      • preload: boolean

    Returns InternalClipPlayer

Private createPlayer

  • createPlayer(path, config): Howl

  • Parameters

    • path: string
    • config: {
          preload: boolean;
      }
      • preload: boolean

    Returns Howl

Private dispatchEvent

Private handleStoppedClip

  • handleStoppedClip(path, playId, soundId): void

  • Parameters

    • path: string
    • playId: string
    • soundId: number

    Returns void

Private notifyClipStateListeners

  • notifyClipStateListeners(playId, file, status): void

  • Parameters

    • playId: string
    • file: string
    • status: MediaStatus

    Returns void

Private notifyStateListeners

pauseAudioClip

  • pauseAudioClip(path, __namedParameters, onlySoundId?, allowIfPauseRequested?): void

  • Parameters

    • path: string
    • __namedParameters: {
          fade?: number;
      }
      • Optional fade?: number
    • Optional onlySoundId: number
    • Optional allowIfPauseRequested: boolean

    Returns void

playAudioClip

  • playAudioClip(path, __namedParameters): void

  • Parameters

    • path: string
    • __namedParameters: {
          fade?: number;
          loop: boolean;
          playId: string;
          volume: number;
      }
      • Optional fade?: number
      • loop: boolean
      • playId: string
      • volume: number

    Returns void

removeEventListener

  • removeEventListener<EventName>(type, listener, options?): void

  • Type Parameters

    • EventName extends keyof EventTypes

    Parameters

    • type: EventName
    • listener: ((ev) => void)
        • (ev): void

        • Parameters

          Returns void

    • Optional options: boolean | EventListenerOptions

    Returns void

setAudioClipVolume

  • setAudioClipVolume(path, __namedParameters): void

  • Parameters

    • path: string
    • __namedParameters: {
          fade?: number;
          volume: number;
      }
      • Optional fade?: number
      • volume: number

    Returns void

setAudioSink

setGlobalVolume

stopAllAudioClips

  • stopAllAudioClips(options): void

  • Parameters

    • options: {
          fade?: number;
      }
      • Optional fade?: number

    Returns void

stopAudioClip

  • stopAudioClip(path, __namedParameters, onlySoundId?, allowIfStopRequested?): void

  • Parameters

    • path: string
    • __namedParameters: {
          fade?: number;
      }
      • Optional fade?: number
    • Optional onlySoundId: number
    • Optional allowIfStopRequested: boolean

    Returns void

Private updateActiveAudioClip

Private updateAudioClipPlayer

  • updateAudioClipPlayer(path, update): void

  • Parameters

    • path: string
    • update: ((player) => InternalClipPlayer)
        • (player): InternalClipPlayer

        • Parameters

          • player: InternalClipPlayer

          Returns InternalClipPlayer

    Returns void

Private updateConfig

  • updateConfig(newFiles): void

  • Parameters

    • newFiles: {
          [path: string]: Media;
      }
      • [path: string]: Media

    Returns void

Private updatedClip

  • updatedClip(clipPath, previousClip, newConfig): InternalClipPlayer

  • Parameters

    • clipPath: string
    • previousClip: InternalClipPlayer
    • newConfig: {
          ephemeral: boolean;
          preload: boolean;
      }
      • ephemeral: boolean
      • preload: boolean

    Returns InternalClipPlayer

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc