Mulai

Copas prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

        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.

Siap untuk dipaste

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

Impor

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

API Ringkasan

`currentOutputs`

Dapatkan rute keluaran audio aktif saat ini.

Pada platform web dan non-iOS, ini menyelesaikan ke array kosong.

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

await AudioSession.currentOutputs();

`overrideOutput`

Atur ulang rute keluaran audio saat ini.

Gunakan speaker untuk memaksa pemutaran melalui speaker bawaan, atau default untuk mengembalikan rute yang dipilih sistem.

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

await AudioSession.overrideOutput({} as OutputOverrideType);

Referensi Tipe

`AudioSessionPorts`

Rute keluaran audio yang tersedia di 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`

Tipe penggantian keluaran. default: Gunakan rute yang dipilih sistem. - speaker: Lakukan pemutaran melalui speaker bawaan.

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

`OverrideResult`

Hasil permintaan override keluaran.

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

`RouteChangeListener`

Penggunaan panggilan ketika rute audio berubah.

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

`InterruptionListener`

Penggunaan panggilan ketika sesi audio terganggu atau berakhir.

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',
}

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s src/definitions.tsRe-run sinkronisasi ketika publik API berubah di atas