Getting Started

复制一个设置提示，包含安装步骤和该插件的完整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.

安装

您可以使用我们的AI辅助设置来安装插件。将Capgo技能添加到您的AI工具中，使用以下命令：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-audio-session` plugin in my project.

如果您更喜欢手动设置，请运行以下命令安装插件，并按照以下平台特定的说明进行操作:

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

导入

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

API Overview

`currentOutputs`

标题为“__CAPGO_KEEP_0__概述”

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

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

await AudioSession.currentOutputs();

`overrideOutput`

覆盖当前音频输出路由

使用 speaker 强制通过内置扬声器播放，或 default 恢复系统选择的路由

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

await AudioSession.overrideOutput({} as OutputOverrideType);

类型参考

`AudioSessionPorts`

可用的 iOS 音频输出路由

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`

输出覆盖类型： 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在上游发生变化时，请重新同步。

继续从开始

如果您正在使用 Getting Started 来规划原生媒体和界面行为，连接它与使用 @capgo/capacitor-audio-session 为原生能力在使用 @capgo/capacitor-audio-session 中使用 @capgo/capacitor-live-activities 为原生能力在使用 @capgo/capacitor-live-activities 中 @capgo/capacitor-live-activities 为 @capgo/capacitor-live-activities 实现细节使用 @capgo/capacitor-video-player 为原生能力在使用 @capgo/capacitor-video-player 中 @capgo/capacitor-视频播放器有关 @capgo/capacitor-视频播放器的实现细节。