yy-audio-player
v1.0.0
Published
音频播放工具,支持播放、暂停、切换等操作
Readme
yy-audio-player
音频播放工具,支持播放、暂停、切换等操作。
安装
npm install yy-audio-player使用
基础用法
import { createAudioPlayer } from 'yy-audio-player';
// 创建音频播放器实例
const player = createAudioPlayer({
onPlay: () => {
console.log('开始播放');
},
onPause: () => {
console.log('暂停播放');
},
onEnded: () => {
console.log('播放结束');
},
onError: (error) => {
console.error('播放错误:', error);
}
});
// 播放音频
await player.play('https://example.com/audio.mp3');
// 暂停播放
player.pause();
// 停止播放
player.stop();
// 设置音量(0-1)
player.setVolume(0.5);
// 设置播放进度(秒)
player.setCurrentTime(30);
// 销毁播放器
player.destroy();简单切换播放
import { togglePlayAudio } from 'yy-audio-player';
// 切换播放/暂停
const player = await togglePlayAudio('https://example.com/audio.mp3');在 Vue 组件中使用
<script setup>
import { onMounted, onUnmounted } from 'vue';
import { createAudioPlayer } from 'yy-audio-player';
let player = null;
onMounted(() => {
player = createAudioPlayer({
onPlay: () => {
console.log('播放中');
},
onEnded: () => {
console.log('播放完成');
}
});
});
onUnmounted(() => {
if (player) {
player.destroy();
}
});
async function handlePlay(url) {
await player.play(url);
}
</script>API
createAudioPlayer(options)
创建音频播放器实例。
参数:
options(object) - 配置选项onPlay(Function) - 播放回调onPause(Function) - 暂停回调onEnded(Function) - 播放结束回调onError(Function) - 错误回调onTimeUpdate(Function) - 时间更新回调onLoadedMetadata(Function) - 元数据加载回调
返回值:
AudioPlayer- 音频播放器实例
AudioPlayer 类
方法
play(url)- 播放音频(如果相同URL则切换播放/暂停)pause()- 暂停播放stop()- 停止播放setVolume(volume)- 设置音量(0-1)setCurrentTime(time)- 设置播放进度(秒)getCurrentTime()- 获取当前播放时间(秒)getDuration()- 获取总时长(秒)destroy()- 销毁音频对象
togglePlayAudio(url, options)
简单的播放/暂停切换函数。
参数:
url(string) - 音频URLoptions(object) - 配置选项
返回值:
Promise<AudioPlayer>- 音频播放器实例
特性
- ✅ 自动切换播放/暂停
- ✅ 事件回调支持
- ✅ 音量控制
- ✅ 进度控制
- ✅ TypeScript 支持
