시작하기

복사할 수 있는 설정 명령어와 이 플러그인의 설치 단계 및 전체 마크다운 가이드를 포함합니다.

        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`

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