播放设置

提示

• 请务必先阅读如何正确使用酒馆助手
• 点击查看对应类型定义文件(可发给 AI 或 IDE 使用, 酒馆助手界面中提供了打包下载)

你可以通过函数控制音频播放器的播放模式、音量等设置.

getAudioSettings

获取音频设置

getAudioSettings

function getAudioSettings(type: 'bgm' | 'ambient'): AudioSettings;

AudioSettings

type AudioSettings = {
  /** 是否启用 */
  enabled: boolean;
  /**
   * 当前播放模式
   * - repeat_one: 单曲循环
   * - repeat_all: 全部循环
   * - shuffle: 随机播放
   * - play_one_and_stop: 播放一首后停止
   */
  mode: 'repeat_one' | 'repeat_all' | 'shuffle' | 'play_one_and_stop';
  /** 是否静音 */
  muted: boolean;
  /** 当前音量 (0-100) */
  volume: number;
};

参数

type

• 类型: 'bgm' | 'ambient'
• 描述: 背景音乐 ('bgm') 或音效 ('ambient')

返回值

• 音频设置: AudioSettings

setAudioSettings

修改音频设置, 如果某字段不存在, 则使用原本的设置.

setAudioSettings

function setAudioSettings(type: 'bgm' | 'ambient', settings: Partial<AudioSettings>): void;

参数

type

• 类型: 'bgm' | 'ambient'
• 描述: 背景音乐 ('bgm') 或音效 ('ambient')

settings

• 类型: Partial<AudioSettings>
• 描述: 要修改的音频设置

示例

将背景音乐设置为单曲循环

setAudioSettings('bgm', { mode: 'repeat_one' });

将音效设置为静音

setAudioSettings('ambient', { muted: true });

将背景音乐音量设置为 50%

setAudioSettings('bgm', { volume: 50 });