sound-manager/src/Group/IGroup.ts

A full-service sound library.

import {
  IBaseNode,
} from '../Node/IBaseNode';
import {
  IPanelRegisterableNode,
} from '../Node/IPanelRegisterableNode';
import {
  ISound,
} from '../Sound/ISound';
import {
  ISoundsMap,
} from './ISoundsMap';
import {
  ITaggableNode,
} from '../Node/ITaggableNode';
import {
  NodeTypes,
} from '../enums/NodeTypes';

export interface IGroup
  extends
    IBaseNode,
    IPanelRegisterableNode,
    ITaggableNode
{
  readonly type: NodeTypes.Group;
  readonly sounds: ISoundsMap;
  deregisterIntentToAddSound(name: string): void;
  hasIntentToAddSound(name: string, groupName?: string): boolean;
  hasSound(name: string): boolean;
  getSound(name: string): ISound;
  hasSounds(names: string[]): boolean;
  getSounds(names: string[]): ISound[];
  getAllSounds(): ISound[];
  getSoundsByTag(tag: string): ISound[];
  getSoundsByTags(tags: string[], matchOneOrAll: 'one' | 'all'): ISound[];
  addSound(name: string, sound: ISound): this;
  addSounds(sounds: ISoundsMap): this;
  removeSound(names: string): this;
  removeSounds(names: string[]): this;
  removeAllSounds(): this;
  playSound(name: string): Promise<void>;
  playSounds(names: string[]): Promise<void[]>;
  playAllSounds(): Promise<void[]>;
  pauseSound(name: string): this;
  pauseSounds(names: string[]): this;
  pauseAllSounds(): this;
  registerIntentToAddSound(name: string): this;
  stopSound(name: string): this;
  stopSounds(names: string[]): this;
  stopAllSounds(): this;
  updateAllAudioElementsVolume(): this;
}