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

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

API 개요

initialize

__initialize__는 RealtimeKit 플러그인을 사용하는 다른 메서드보다 먼저 초기화합니다.

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

await CapacitorRealtimekit.initialize();

startMeeting

__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이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속

만약에 당신이 Getting Started 계획 대시보드와 API 연산을 계획하고 싶다면 Using @capgo/capacitor-realtimekit Using @capgo/capacitor-realtimekit API 개요 for the implementation detail in API Overview, __CAPGO_KEEP_0__ 키 __CAPGO_KEEP_0__ 키 API Keys for the implementation detail in API Keys, and Devices 장치에 대한 구현 세부 정보.