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

スタートガイド

GitHub

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

ターミナル
bunx 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-realtimekit` plugin in my project.

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

ターミナル
bun add @capgo/capacitor-realtimekit
bunx cap sync
import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';
import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';
await CapacitorRealtimekit.initialize();
import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';
await CapacitorRealtimekit.startMeeting({
authToken: 'your-auth-token',
enableAudio: true,
enableVideo: true,
});
  • 一度だけ初期化: アプリの起動時にセットアップを実行します。
  • ネイティブ同期: 実行 bunx cap sync プラグインのアップグレード後。
  • 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

他のメソッドを使う前に、RealtimeKitプラグインを初期化します。

import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';
await CapacitorRealtimekit.initialize();

組み込みUIを使用してミーティングを開始します。 AndroidおよびiOSでのみ利用可能です。

import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';
await CapacitorRealtimekit.startMeeting({
authToken: 'your-auth-token',
enableAudio: true,
enableVideo: true,
});

ミーティングを開始するための設定オプション

export interface StartMeetingOptions {
/**
* Authentication token for the participant.
* This token is required to join the Cloudflare Calls meeting.
*
* @since 7.0.0
*/
authToken: string;
/**
* Whether to join with audio enabled.
* Default is true.
*
* @default true
* @since 7.0.0
*/
enableAudio?: boolean;
/**
* Whether to join with video enabled.
* Default is true.
*
* @default true
* @since 7.0.0
*/
enableVideo?: boolean;
}

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

Getting Startedの続きを進める

「Getting Started からの続き」セクション

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-realtimekit の使い方 @capgo/capacitor-realtimekit を使用する際のネイティブ機能については、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。