Getting Started

インストール

CapgoのAI-Assisted Setupを使用してプラグインをインストールできます。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-realtimekit` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

bun add @capgo/capacitor-realtimekit
bunx cap sync

インポート

import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';

APIの概要

initialize

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

import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';

await CapacitorRealtimekit.initialize();

startMeeting

AndroidおよびiOSで使用可能なビルトインUIを使用して会議を開始します。

import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';

await CapacitorRealtimekit.startMeeting({
  authToken: 'your-auth-token',
  enableAudio: true,
  enableVideo: true,
});

型の参照

StartMeetingOptions

会議の開始に必要な設定オプション

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公開されたAPIがアップストリームで変更されたときに再度同期を実行してください。

「はじめから始める」の続き

Capgoを使用している場合 はじめに ダッシュボードとAPIの作業を計画するには、APIに接続してください。 Capacitorを使用して@capgo/capacitor-realtimekitを接続します。 Capacitorのnative機能を使用するには@capgo/capacitor-realtimekitを使用します。 APIの概要 APIの実装詳細についてはAPIの概要を参照してください。 導入 実装詳細については導入を参照してください。 APIのキー APIの実装詳細についてはAPIのキーを参照してください。 デバイス デバイスの実装詳細について。