Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Playlist

The client-side Playlist document which extends the common BasePlaylist model.

mixes

ClientDocumentMixin

see

Playlists The world-level collection of Playlist documents

see

PlaylistSound The PlaylistSound embedded document within a parent Playlist

see

PlaylistConfig The Playlist configuration application

Hierarchy

  • any
    • Playlist

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns Playlist

Properties

_playbackOrder

_playbackOrder: string[]

Playlists may have a playback order which defines the sequence of Playlist Sounds

playing

playing: any

Accessors

playbackOrder

  • get playbackOrder(): string[]

  • The order in which sounds within this playlist will be played (if sequential or shuffled) Uses a stored seed for randomization to guarantee that all clients generate the same random order.

    Returns string[]

visible

  • get visible(): any
  • inheritdoc

    Returns any

Methods

prepareDerivedData

  • prepareDerivedData(): void
  • inheritdoc

    Returns void

playAll

  • Begin simultaneous playback for all sounds in the Playlist.

    Returns Promise<Playlist>

    The updated Playlist document

playNext

  • playNext(soundId: string, [options={}]?: { direction: number }): Promise<Playlist>

  • Play the next Sound within the sequential or shuffled Playlist.

    Parameters

    • soundId: string
    • [options={}]: { direction: number } = {}

      Additional options which configure the next track

      • direction: number

    Returns Promise<Playlist>

    The updated Playlist document

playSound

  • Begin playback of a specific Sound within this Playlist. Determine which other sounds should remain playing, if any.

    Parameters

    Returns Promise<Playlist>

    The updated Playlist

stopSound

  • Stop playback of a specific Sound within this Playlist. Determine which other sounds should remain playing, if any.

    Parameters

    Returns Promise<Playlist>

    The updated Playlist

stopAll

  • End playback for any/all currently playing sounds within the Playlist.

    Returns Promise<Playlist>

    The updated Playlist document

cycleMode

  • Cycle the playlist mode

    Returns Promise<Playlist>

    A promise which resolves to the updated Playlist instance

toAnchor

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

    Parameters

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

    Returns any

_onClickDocumentLink

  • _onClickDocumentLink(event: any): Promise<Playlist>
  • inheritdoc

    Parameters

    • event: any

    Returns Promise<Playlist>

_preUpdate

  • _preUpdate(changed: any, options: any, user: any): Promise<any>
  • inheritdoc

    Parameters

    • changed: any
    • options: any
    • user: any

    Returns Promise<any>

_onUpdate

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

    Parameters

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

    Returns void

_onDelete

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

    Parameters

    • options: any
    • userId: any

    Returns void

_onCreateEmbeddedDocuments

  • _onCreateEmbeddedDocuments(embeddedName: any, documents: any, createData: any, options: any, userId: any): void
  • inheritdoc

    Parameters

    • embeddedName: any
    • documents: any
    • createData: any
    • options: any
    • userId: any

    Returns void

_onUpdateEmbeddedDocuments

  • _onUpdateEmbeddedDocuments(embeddedName: any, documents: any, changes: any, options: any, userId: any): void
  • inheritdoc

    Parameters

    • embeddedName: any
    • documents: any
    • changes: any
    • options: any
    • userId: any

    Returns void

_onDeleteEmbeddedDocuments

  • _onDeleteEmbeddedDocuments(embeddedName: any, documents: any, ids: any, options: any, userId: any): void
  • inheritdoc

    Parameters

    • embeddedName: any
    • documents: any
    • ids: any
    • options: any
    • userId: any

    Returns void

toCompendium

  • toCompendium(pack: any, options?: {}): any
  • inheritdoc

    Parameters

    • pack: any
    • options: {} = {}

      Returns any

    Private _getNextSound

    • _getNextSound(soundId: any): any

    • Get the next sound in the cached playback order. For internal use.

      Parameters

      • soundId: any

      Returns any

    Private _getPreviousSound

    • _getPreviousSound(soundId: any): any

    • Get the previous sound in the cached playback order. For internal use.

      Parameters

      • soundId: any

      Returns any

    Private _sortSounds

    • _sortSounds(a: any, b: any): any

    • Define the sorting order for the Sounds within this Playlist. For internal use.

      Parameters

      • a: any
      • b: any

      Returns any

    Private _onSoundEnd

    • Handle callback logic when an individual sound within the Playlist concludes playback naturally

      Parameters

      Returns Promise<any>

    Private _onSoundStart

    • Handle callback logic when playback for an individual sound within the Playlist is started. Schedule auto-preload of next track

      Parameters

      Returns Promise<void>

    Private _updateContentLinkPlaying

    • _updateContentLinkPlaying(changed: any): void

    • Update the playing status of this Playlist in content links.

      Parameters

      • changed: any

        The data changes.

      Returns void

    Static Protected _getSoundContentLinks