はじめから始める

インストール

Capgoの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-realtimekit` plugin in my project.

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

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,
});

Type Reference

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

始めから始める

使用中の場合 はじめに APIを計画するダッシュボードとAPIの操作に接続する @capgo/capacitor-realtimekitを使用する @capgo/capacitor-realtimekitのnative機能のために APIの概要 APIの概要の実装詳細のために 導入 導入の実装詳細のために APIのキー APIのキーに関する実装詳細のために デバイス デバイスに関する実装詳細のために