开始使用

复制一个包含安装步骤和该插件的完整 Markdown 指南的设置提示。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-audio-session`, `@capgo/capacitor-audiosession`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/audiosession/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

bun add @capgo/capacitor-audio-session
bunx cap sync

导入

import { AudioSession } from '@capgo/capacitor-audio-session';

API概述

`currentOutputs`

获取当前的活跃音频输出路由。

在Web和非iOS平台上，这个值会被解析为一个空数组。

import { AudioSession } from '@capgo/capacitor-audio-session';

await AudioSession.currentOutputs();

`overrideOutput`

Override the current audio output route.

使用 speaker 或 default 恢复系统选择的音频输出路由。

import { AudioSession } from '@capgo/capacitor-audio-session';

await AudioSession.overrideOutput({} as OutputOverrideType);

类型参考

`AudioSessionPorts`

复制到剪贴板

export enum AudioSessionPorts {
  AIR_PLAY = 'airplay',
  BLUETOOTH_LE = 'bluetooth-le',
  BLUETOOTH_HFP = 'bluetooth-hfp',
  BLUETOOTH_A2DP = 'bluetooth-a2dp',
  BUILT_IN_SPEAKER = 'builtin-speaker',
  BUILT_IN_RECEIVER = 'builtin-receiver',
  HDMI = 'hdmi',
  HEADPHONES = 'headphones',
  LINE_OUT = 'line-out',
}

`OutputOverrideType`

Output override type. - default：使用系统选定的路由。 - speaker：强制通过内置扬声器播放。

export type OutputOverrideType = 'default' | 'speaker';

`OverrideResult`

输出重写请求的结果。

export type OverrideResult = {
  success: boolean;
  message: string;
};

`RouteChangeListener`

音频路由发生变化时的监听器。

export type RouteChangeListener = (reason: RouteChangeReasons) => void;

`InterruptionListener`

音频会话被中断或结束时的监听器。

export type InterruptionListener = (type: InterruptionTypes) => void;

`RouteChangeReasons`

export enum RouteChangeReasons {
  NEW_DEVICE_AVAILABLE = 'new-device-available',
  OLD_DEVICE_UNAVAILABLE = 'old-device-unavailable',
  CATEGORY_CHANGE = 'category-change',
  OVERRIDE = 'override',
  WAKE_FROM_SLEEP = 'wake-from-sleep',
  NO_SUITABLE_ROUTE_FOR_CATEGORY = 'no-suitable-route-for-category',
  ROUTE_CONFIGURATION_CHANGE = 'route-config-change',
  UNKNOWN = 'unknown',
}

`InterruptionTypes`

export enum InterruptionTypes {
  BEGAN = 'began',
  ENDED = 'ended',
}

真实数据来源

本页面由插件生成 src/definitions.ts当公共API上游更改时，请重新同步