Pixeljs

A simple and flexible HTML5 and JavaScript powered game engine.

View Project on GitHub Download Pixel.js (v0.9b)

Sound Class

Represents a sound file.

Inheritance Hierarchy

  • Sound

Properties

Name Description
duration The length of the media in seconds, or zero if no media data is available. If the media data is available but the length is unknown, this value is NaN. If the media is streamed and has no predefined length, the value is Inf.
loop Reflects the loop HTML attribute, indicating whether the media element should start over when it reaches the end.
muted true if the audio is muted, and false otherwise.
paused Indicates whether the media element is paused.
playbackRate The current rate at which the media is being played back. This is used to implement user controls for fast forward, slow motion, and so forth. The normal playback rate is multiplied by this value to obtain the current rate, so a value of 1.0 indicates normal speed.

If the playbackRate is negative, the media is played backwards.

The audio is muted when the media plays backwards or if the fast forward or slow motion is outside a useful range (E.g. Gecko mute the sound outside the range 0.25 and 5.0).

The pitch of the audio is corrected by default and is the same for every speed. Some navigators implement the non-standard preservespitch property to control this.

volume The audio volume, from 0.0 (silent) to 1.0 (loudest).

Methods

Name Description
load Loads the sound.
pause Pause the sound, if it is playing.
play Play the sound.
prepare Prepare the information required to load the sound.
seek Seek to the specified playback time, in seconds.

Remarks

The supported audio formats, much like the supported image formats, are determined by the executing browser. Click Here to see a complete list of the audio formats supported by various browsers.

Supported Platforms

Google Chrome, Mozilla FireFox, Internet Explorer 9+, Opera, Safari.