Getting Started

セットアップのプロンプトをコピーして、インストールの手順とこのプラグインのフルマークダウンガイドを含む。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-realtimekit`
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/realtimekit/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.

インストール

bun add @capgo/capacitor-realtimekit
bunx cap sync

インポート

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

API の概要

`initialize`

__CAPGO_KEEP_0__ プラグインを使用する他のメソッドよりも前に、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 がアップストリームで変更された場合に再度 Sync を実行してください。

Getting Started から続けて

Getting Started を使用してダッシュボードと __CAPGO_KEEP_0__ の操作を計画している場合、接続してください。 Getting Started to plan dashboard and API operations, connect it with Using @capgo/capacitor-realtimekit for the native capability in Using @capgo/capacitor-realtimekit API 本試给 for the implementation detail in API 本試给主子 for the implementation detail in 主子 API 台给 for the implementation detail in API 台给, 和车会 for the implementation detail in 车会