discord.js v14 教程：控制语音机器人播放音频后自动断开连接-js教程-PHP中文网

discord.js v14 教程：控制语音机器人播放音频后自动断开连接

本教程将指导您如何在 discord.js v14 中实现语音机器人播放完mp3文件后自动离开语音频道。通过利用 `@discordjs/voice` 库中的 `audioplayer` 状态变化事件，特别是监听 `idle` 状态，我们可以确保在音频播放结束时，机器人能够优雅地断开与语音频道的连接，从而优化资源管理并提升用户体验。

引言：管理语音机器人生命周期

在开发 Discord 语音机器人时，一个常见的需求是让机器人在完成特定任务（例如播放完一段音频）后自动离开语音频道。这不仅能避免机器人不必要地占用语音频道资源，还能提升用户体验。在 discord.js v14 及其配套的 @discordjs/voice 库中，实现这一功能需要理解音频播放器的状态管理。

核心组件与初步设置

在 discord.js v14 中，与语音相关的操作主要由 @discordjs/voice 库处理。以下是实现语音播放和连接管理的关键组件：

joinVoiceChannel: 用于连接机器人到指定的语音频道。
createAudioPlayer: 创建一个音频播放器实例，负责管理音频的播放、暂停等操作。
createAudioResource: 将音频文件（如 MP3）转换为可供 AudioPlayer 播放的资源。
VoiceConnectionStatus: 枚举，表示语音连接的不同状态（如 Ready, Destroyed 等）。

以下是一个基本的斜杠命令结构，用于连接机器人到语音频道并播放音频：

const { SlashCommandBuilder, ChannelType } = require('discord.js');
const { getVoiceConnection, entersState, joinVoiceChannel, createAudioPlayer, createAudioResource, VoiceConnectionStatus } = require('@discordjs/voice');
const { join } = require('node:path');

module.exports = {
    data: new SlashCommandBuilder()
        .setName('playaudio')
        .setDescription('播放指定音频并自动离开。')
        .addChannelOption(option =>
            option.setName('channel')
                .setDescription('选择一个语音频道。')
                .setRequired(true)
                .addChannelTypes(ChannelType.GuildVoice)),

    async execute(interaction) {
        if (!interaction.isChatInputCommand()) return;

        const voiceChannel = interaction.options.getChannel('channel');

        if (!voiceChannel || voiceChannel.type !== ChannelType.GuildVoice) {
            return interaction.reply({ content: '请选择一个有效的语音频道。', ephemeral: true });
        }

        let voiceConnection;
        try {
            voiceConnection = joinVoiceChannel({
                channelId: voiceChannel.id,
                guildId: interaction.guild.id,
                adapterCreator: interaction.guild.voiceAdapterCreator,
                selfDeaf: false, // 根据需求设置是否自闭麦
            });

            await entersState(voiceConnection, VoiceConnectionStatus.Ready, 5000);
            console.log(`成功连接到语音频道: ${voiceChannel.name}`);

            const player = createAudioPlayer();
            // 假设音频文件位于项目的 medias/sound_effect 目录下
            const resource = createAudioResource(join(__dirname, '../../medias/sound_effect/padorupadoru.mp3'));

            voiceConnection.subscribe(player); // 将播放器连接到语音连接
            player.play(resource); // 开始播放音频

            await interaction.reply({ content: `正在 ${voiceChannel.name} 播放音频...`, ephemeral: false });

            // 错误：此处不应直接尝试断开连接，因为音频尚未播放完毕
            // if (player.pause(), () => voiceConnection.disconnect());

        } catch (error) {
            console.error("连接语音频道或播放音频时发生错误:", error);
            if (voiceConnection && voiceConnection.state.status !== VoiceConnectionStatus.Destroyed) {
                voiceConnection.destroy(); // 确保在出错时销毁连接
            }
            await interaction.reply({ content: '无法连接到语音频道或播放音频。请稍后再试。', ephemeral: true });
        }
    }
};

登录后复制

在上述代码中，直接在 player.play(resource); 之后尝试断开连接是无效的，因为它会在音频开始播放时立即执行，而不是等待播放结束。我们需要一种机制来监听音频播放的状态。

利用 AudioPlayer 状态事件实现自动断开

@discordjs/voice 库中的 AudioPlayer 实例会触发 stateChange 事件，该事件在播放器状态发生变化时被调用。AudioPlayer 具有多种状态，其中：

playing: 正在播放音频。
buffering: 正在缓冲音频数据。
paused: 音频已暂停。
idle: 音频播放已完成或已停止。

当 AudioPlayer 的状态从 playing 变为 idle 时，就意味着音频文件已经播放完毕。我们可以监听这个状态变化来触发机器人离开语音频道的逻辑。

INFINITE ALBUM

面向游戏玩家的生成式AI音乐

144

查看详情

修改后的代码片段：

在 player.play(resource); 之后，添加一个 stateChange 事件监听器：

// ... 接上文代码 ...

            voiceConnection.subscribe(player);
            player.play(resource);

            // 监听播放器状态变化，当播放完成（变为 idle 状态）时断开连接
            player.on('stateChange', (oldState, newState) => {
                console.log(`AudioPlayer state changed from ${oldState.status} to ${newState.status}`);
                if (newState.status === 'idle') {
                    console.log('音频播放完毕，机器人正在离开语音频道。');
                    voiceConnection.destroy(); // 销毁连接，释放资源
                    // 可以选择在此处发送一个交互回复，告知用户机器人已离开
                    // interaction.followUp({ content: '音频播放完毕，我已离开频道。', ephemeral: true });
                }
            });

            // 错误处理：如果播放器遇到错误
            player.on('error', error => {
                console.error(`AudioPlayer 发生错误: ${error.message}`);
                voiceConnection.destroy(); // 遇到错误也销毁连接
                interaction.followUp({ content: '播放音频时发生错误，我已离开频道。', ephemeral: true });
            });

// ... 其余代码 ...

登录后复制

通过这种方式，机器人会等待音频播放器进入 idle 状态，然后才执行 voiceConnection.destroy() 操作，从而实现音频播放完毕后自动离开语音频道。

完整示例与注意事项

以下是整合了上述逻辑的完整斜杠命令示例：

const { SlashCommandBuilder, ChannelType } = require('discord.js');
const { getVoiceConnection, entersState, joinVoiceChannel, createAudioPlayer, createAudioResource, VoiceConnectionStatus } = require('@discordjs/voice');
const { join } = require('node:path');

module.exports = {
    data: new SlashCommandBuilder()
        .setName('playaudio')
        .setDescription('播放指定音频并自动离开。')
        .addChannelOption(option =>
            option.setName('channel')
                .setDescription('选择一个语音频道。')
                .setRequired(true)
                .addChannelTypes(ChannelType.GuildVoice)),

    async execute(interaction) {
        if (!interaction.isChatInputCommand()) return;

        const voiceChannel = interaction.options.getChannel('channel');

        // 验证选择的频道是否为有效的语音频道
        if (!voiceChannel || voiceChannel.type !== ChannelType.GuildVoice) {
            return interaction.reply({ content: '请选择一个有效的语音频道。', ephemeral: true });
        }

        let voiceConnection;
        try {
            // 尝试连接到语音频道
            voiceConnection = joinVoiceChannel({
                channelId: voiceChannel.id,
                guildId: interaction.guild.id,
                adapterCreator: interaction.guild.voiceAdapterCreator,
                selfDeaf: false, // 机器人连接时是否自闭麦，根据需求设置
            });

            // 等待语音连接准备就绪，最多等待5秒
            await entersState(voiceConnection, VoiceConnectionStatus.Ready, 5000);
            console.log(`成功连接到语音频道: ${voiceChannel.name} (${voiceChannel.guild.name})`);

            const player = createAudioPlayer();
            // 假设音频文件位于项目的 medias/sound_effect 目录下
            const resource = createAudioResource(join(__dirname, '../../medias/sound_effect/padorupadoru.mp3'));

            voiceConnection.subscribe(player); // 将播放器连接到语音连接
            player.play(resource); // 开始播放音频

            // 监听播放器状态变化
            player.on('stateChange', (oldState, newState) => {
                console.log(`AudioPlayer state changed from ${oldState.status} to ${newState.status}`);
                // 当播放器状态变为 'idle' 时，表示音频播放完毕
                if (newState.status === 'idle') {
                    console.log('音频播放完毕，机器人正在离开语音频道。');
                    voiceConnection.destroy(); // 销毁连接，释放所有相关资源
                    // 可以在此处发送一个后续回复，告知用户机器人已离开
                    // interaction.followUp({ content: '音频播放完毕，我已离开频道。', ephemeral: true });
                }
            });

            // 监听播放器错误事件，确保即使播放出错也能断开连接
            player.on('error', error => {
                console.error(`AudioPlayer 发生错误: ${error.message}`);
                voiceConnection.destroy(); // 遇到错误时也销毁连接
                interaction.followUp({ content: '播放音频时发生错误，我已离开频道。', ephemeral: true });
            });

            // 向用户发送初始回复
            await interaction.reply({ content: `正在 ${voiceChannel.name} 播放音频...`, ephemeral: false });

        } catch (error) {
            console.error("连接语音频道或播放音频时发生错误:", error);
            // 如果在连接或播放过程中发生错误，确保销毁任何已建立的连接
            if (voiceConnection && voiceConnection.state.status !== VoiceConnectionStatus.Destroyed) {
                voiceConnection.destroy();
            }
            await interaction.reply({ content: '无法连接到语音频道或播放音频。请稍后再试。', ephemeral: true });
        }
    }
};

登录后复制

注意事项：

voiceConnection.destroy() vs voiceConnection.disconnect(): 在 @discordjs/voice 库中，推荐使用 voiceConnection.destroy() 来彻底清理和销毁语音连接。它会关闭底层 WebSocket 连接，并清理所有相关的资源和事件监听器。而 disconnect() 只是断开连接，但可能不会完全清理所有资源，因此 destroy() 是更稳健的选择。
错误处理: 在连接语音频道和播放音频的过程中，应加入健壮的 try...catch 块来捕获潜在的错误。例如，机器人可能没有加入语音频道的权限，或者音频文件路径不正确。在错误发生时，确保调用 voiceConnection.destroy() 来清理资源。
异步操作: 确保所有异步操作（如 entersState 和 interaction.reply）都使用 await 关键字正确处理，以避免时序问题。
资源路径: createAudioResource 需要一个有效的音频文件路径。请确保 join(__dirname, '../../medias/sound_effect/padorupadoru.mp3') 中的路径是正确的，并且文件存在。
selfDeaf: joinVoiceChannel 选项中的 selfDeaf 决定了机器人连接时是否自动闭麦。根据您的机器人功能需求进行设置。

总结

通过监听 AudioPlayer 实例的 stateChange 事件，并特别关注其状态变为 idle 的时机，我们可以精确地判断音频播放何时结束。结合 voiceConnection.destroy() 方法，可以实现在 discord.js v14 语音机器人中，音频播放完毕后自动、优雅地离开语音频道。这种方法不仅保证了播放逻辑的完整性，也有效管理了机器人资源，提升了整体的用户体验。

以上就是discord.js v14 教程：控制语音机器人播放音频后自动断开连接的详细内容，更多请关注php中文网其它相关文章！