Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PlaylistSound

The client-side PlaylistSound document which extends the common BasePlaylistSound model. Each PlaylistSound belongs to the sounds collection of a Playlist document.

mixes

ClientDocumentMixin

see

Playlist The Playlist document which contains PlaylistSound embedded documents

see

PlaylistSoundConfig The PlaylistSound configuration application

see

Sound The Sound API which manages web audio playback

Hierarchy

  • any
    • PlaylistSound

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • data: any
    • context: any

    Returns PlaylistSound

Properties

sound

sound: Sound

The Sound which manages playback for this playlist sound

debounceVolume

debounceVolume: Function

A debounced function, accepting a single volume parameter to adjust the volume of this sound

param volume

The desired volume level

playing

playing: boolean

Static VOLUME_DEBOUNCE_MS

VOLUME_DEBOUNCE_MS: number = 100

The debounce tolerance for processing rapid volume changes into database updates in milliseconds

Accessors

effectiveVolume

  • get effectiveVolume(): number

  • The effective volume at which this playlist sound is played, incorporating the global playlist volume setting.

    Returns number

fadeDuration

  • get fadeDuration(): number

  • Determine the fade duration for this PlaylistSound based on its own configuration and that of its parent.

    Returns number

Methods

sync

  • sync(): number | void | Promise<void> | Promise<Sound>

  • Synchronize playback for this particular PlaylistSound instance

    Returns number | void | Promise<void> | Promise<Sound>

toAnchor

  • toAnchor(__namedParameters?: { classes: any[] }): any
  • inheritdoc

    Parameters

    • __namedParameters: { classes: any[] } = {}
      • classes: any[]

    Returns any

_onClickDocumentLink

  • _onClickDocumentLink(event: any): any
  • inheritdoc

    Parameters

    • event: any

    Returns any

_onCreate

  • _onCreate(data: any, options: any, userId: any): void
  • override

    Parameters

    • data: any
    • options: any
    • userId: any

    Returns void

_onUpdate

  • _onUpdate(changed: any, options: any, userId: any): void
  • override

    Parameters

    • changed: any
    • options: any
    • userId: any

    Returns void

_onDelete

  • _onDelete(options: any, userId: any): void
  • override

    Parameters

    • options: any
    • userId: any

    Returns void

Private _createSound

  • Create a Sound used to play this PlaylistSound document

    Returns Sound

Private _onEnd

  • _onEnd(): Promise<any>

  • Special handling that occurs when a PlaylistSound reaches the natural conclusion of its playback.

    Returns Promise<any>

Private _onStart

  • _onStart(): Promise<any>

  • Special handling that occurs when playback of a PlaylistSound is started.

    Returns Promise<any>

Private _onStop

  • _onStop(): Promise<void>

  • Special handling that occurs when a PlaylistSound is manually stopped before its natural conclusion.

    Returns Promise<void>

Private _fadeIn

  • _fadeIn(sound: Sound): void

  • Handle fading in the volume for this sound when it begins to play (or loop)

    Parameters

    • sound: Sound

      The sound fading-in

    Returns void

Private _fadeOut

  • _fadeOut(sound: Sound): void

  • Handle fading out the volume for this sound when it begins to play (or loop)

    Parameters

    • sound: Sound

      The sound fading-out

    Returns void