Class WorkspaceAudio

Fake class which should be extended to avoid inheriting static properties

Hierarchy (View Summary)

WorkspaceAudio__Class
- WorkspaceAudio

Index

Constructors

Methods

dispose load play preload

Constructors

constructor

new WorkspaceAudio(parentWorkspace: WorkspaceSvg): WorkspaceAudio
Class for loading, storing, and playing audio for a workspace.
Parameters
- parentWorkspace: WorkspaceSvg
  The parent of the workspace this audio object belongs to, or null.
Returns WorkspaceAudio
Inherited from WorkspaceAudio__Class.constructor
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:11614

Methods

dispose

dispose(): void
Dispose of this audio manager.

Returns void
Package
Inherited from WorkspaceAudio__Class.dispose
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:11620

load

load(filenames: string[], name: string): void
Load an audio file. Cache it, ready for instantaneous playing.
Parameters
- filenames: string[]
  List of file types in decreasing order of preference (i.e. increasing size). E.g. ['media/go.mp3', 'media/go.wav'] Filenames include path from Blockly's root. File extensions matter.
- name: string
  Name of sound.
Returns void
Inherited from WorkspaceAudio__Class.load
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:11629

play

play(name: string, opt_volume?: number): void
Play a named sound at specified volume. If volume is not specified, use full volume (1).
Parameters
- name: string
  Name of sound.
- Optionalopt_volume: number
  Volume of sound (0-1).
Returns void
Inherited from WorkspaceAudio__Class.play
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:11643

preload

preload(): void
Preload all the audio files so that they play quickly when asked for.

Returns void
Package
Inherited from WorkspaceAudio__Class.preload
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:11635