# buzz

**Repository Path**: mirrors/buzz

## Basic Information

- **Project Name**: buzz
- **Description**: Buzz 是一个用于操作 HTML5 音频标签的 JavaScript library 
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/buzz
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2020-08-20
- **Last Updated**: 2026-02-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Buzz, a Javascript HTML5 Audio library
======================================

Buzz is a small but powerful Javascript library that allows you to easily take advantage of the new HTML5 audio element. It tries to degrade properly on non-modern browsers.

```javascript
var mySound = new buzz.sound("/sounds/myfile", {
    formats: [ "ogg", "mp3", "aac" ]
});

mySound.play()
    .fadeIn()
    .loop()
    .bind("timeupdate", function () {
        document.querySelector("#timer").innerHTML = buzz.toTimer(this.getTime());
    });
```

## Installation

### npm
```bash
npm install buzz
```

### CDN (UMD)
```html
<script src="https://cdn.jsdelivr.net/npm/buzz@2.0.0/dist/buzz.min.js"></script>
```

### ES Module
```javascript
import buzz from 'buzz'
```

## What's New in 2.0

🎁 **Promise Support** - All async methods now support both callbacks and Promises
🚀 **Modern JavaScript** - ES2015+ syntax (const/let, arrows, templates)
📦 **Simplified Build** - 2 files: `buzz.js` (ESM) + `buzz.min.js` (UMD)
🔷 **TypeScript** - Full type definitions included
🧪 **Better Testing** - 42 comprehensive headless tests

### Official website
http://buzz.jaysalvat.com/

### Real life demo
http://buzz.jaysalvat.com/demo/

### Documentation
http://buzz.jaysalvat.com/documentation/

Promise Support
---------------

Buzz now supports both **callback** and **Promise** patterns, maintaining full backward compatibility.

### Methods with Promise support

The following methods now return a Promise when no callback is provided:

- `fadeTo(to, [duration], [callback])`
- `fadeIn([duration], [callback])`
- `fadeOut([duration], [callback])`
- `whenReady([callback])`

### Usage Examples

#### With callbacks (backward compatible)
```javascript
var mySound = new buzz.sound("/sounds/myfile.mp3");

mySound.fadeIn(1000, function() {
    console.log('Fade in complete!');
    this.fadeOut(1000, function() {
        console.log('Fade out complete!');
    });
});
```

#### With Promises
```javascript
var mySound = new buzz.sound("/sounds/myfile.mp3");

mySound.fadeIn(1000)
    .then(() => {
        console.log('Fade in complete!');
        return mySound.fadeOut(1000);
    })
    .then(() => {
        console.log('Fade out complete!');
    });
```

#### With async/await
```javascript
var mySound = new buzz.sound("/sounds/myfile.mp3");

async function playSequence() {
    await mySound.fadeIn(1000);
    console.log('Fade in complete!');

    await mySound.fadeOut(1000);
    console.log('Fade out complete!');
}

playSequence();
```

#### whenReady with Promise
```javascript
var mySound = new buzz.sound("/sounds/myfile.mp3");

// Wait for the sound to be ready before playing
await mySound.whenReady();
mySound.play();
```

## Module Formats

Buzz 2.0 provides two build formats to support both modern and legacy usage:

### ES Module (`buzz.js`)
For modern development with npm and bundlers:
```javascript
// Import as ES Module
import buzz from 'buzz'

const mySound = new buzz.sound('/sounds/myfile.mp3')
await mySound.fadeIn(1000)
```

### UMD (`buzz.min.js`)
For CDN usage and legacy browsers:
```html
<!-- Load from CDN -->
<script src="https://cdn.jsdelivr.net/npm/buzz@2.0.0/dist/buzz.min.js"></script>

<script>
  // Global buzz object
  var mySound = new buzz.sound('/sounds/myfile.mp3')
  mySound.fadeIn(1000, function() {
    console.log('Done!')
  })
</script>
```

## TypeScript Support

Buzz 2.0 includes full TypeScript definitions:

```typescript
import buzz from 'buzz'

const sound: buzz.BuzzSound = new buzz.sound('/audio.mp3')

// Full autocomplete and type checking
await sound.fadeIn(1000)
sound.setVolume(80)
```

Contributing
------------

Please don't edit files in the `dist` subdirectory as it is generated via Grunt. You'll find source code in the `src` subdirectory!
Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**

PLEASE DO NOT use Gruntfile. I will. :)

License
-------

**The MIT License (MIT)**

Copyright (c) 2021 Jay Salvat

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.