メインコンテンツへスキップ

スタートガイド

GitHub

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください:

ターミナル
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.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください:

ターミナル
npm install @capgo/capacitor-audio-session
npx cap sync
import { AudioSession } from '@capgo/capacitor-audio-session';
import { AudioSession } from '@capgo/capacitor-audio-session';
await AudioSession.overrideOutput('speaker');
  • iOS のフォーカス:ルーティング API は iOS のオーディオセッションの動作を対象とします。
  • リストア:呼び出し overrideOutput('default') 通話終了後。
  • 順序:Twilio やメディアプラグインの起動前に設定してください。

現在アクティブなオーディオ出力ルートを取得します。

Web および iOS 以外のプラットフォームでは、空の配列が返されます。

import { AudioSession } from '@capgo/capacitor-audio-session';
const result = await AudioSession.currentOutputs();
console.log(result);

現在のオーディオ出力ルートを上書きします。

使用する speaker 内蔵スピーカーからの再生を強制する場合、または default システムが選択したルートに戻す場合。

import { AudioSession } from '@capgo/capacitor-audio-session';
const result = await AudioSession.overrideOutput('default');
console.log(result);

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

出力オーバーライドの種類。 - default: システムが選択したルートを使用します。 - speaker: 内蔵スピーカーでの再生を強制します。

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

出力オーバーライドリクエストの結果。

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

オーディオルートが変更されたときに呼び出されるリスナー。

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

オーディオセッションが中断または終了したときに呼び出されるリスナー。

export type InterruptionListener = (type: InterruptionTypes) => void;
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',
}
export enum InterruptionTypes {
BEGAN = 'began',
ENDED = 'ended',
}

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

「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-video-player @capgo/capacitor-video-player. の実装の詳細については