Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem KI-Tool hinzu, indem Sie die folgende Befehlszeile verwenden:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Dann verwenden Sie die folgende Anfrage:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-stream-call` plugin in my project.

Wenn Sie eine manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen Plattform-spezifischen Anweisungen befolgen:

bun add @capgo/capacitor-stream-call
bunx cap sync

Importieren

import { StreamCall } from '@capgo/capacitor-stream-call';

API Übersicht

login

Anmeldung bei Stream Video-Dienst

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.login({
  token: 'your-token',
  userId: 'user-123',
  name: 'John Doe',
  apiKey: 'your-api-key'
});

logout

Abmelden vom Stream Video-Dienst

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.logout();

call

Einen Anruf an einen anderen Benutzer starten

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.call({
  userId: 'user-456',
  type: 'video',
  ring: true
});

endCall

Den aktuellen Anruf beenden

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.endCall();

joinCall

Ein bestehender Anruf beitreten

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.joinCall({ callId: 'call001', callType: 'default' });

setMicrophoneEnabled

Mikrofon aktivieren oder deaktivieren

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.setMicrophoneEnabled({ enabled: false });

setCameraEnabled

Kamera aktivieren oder deaktivieren

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.setCameraEnabled({ enabled: false });

enableBluetooth

Bluetooth-Audio aktivieren

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.enableBluetooth();

acceptCall

Ein eingehendes Anruf annehmen

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.acceptCall();

rejectCall

Einen eingehenden Anruf ablehnen

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.rejectCall();

isCameraEnabled

Überprüfen, ob die Kamera aktiviert ist

import { StreamCall } from '@capgo/capacitor-stream-call';

const isCameraEnabled = await StreamCall.isCameraEnabled();
console.log(isCameraEnabled);

getCallStatus

Ermitteln Sie den aktuellen Anrufstatus

import { StreamCall } from '@capgo/capacitor-stream-call';

const callStatus = await StreamCall.getCallStatus();
console.log(callStatus);

getRingingCall

Ermitteln Sie den aktuellen Klingelnden Anruf

import { StreamCall } from '@capgo/capacitor-stream-call';

const ringingCall = await StreamCall.getRingingCall();
console.log(ringingCall);

toggleViews

Durchlaufen Sie die verfügbaren Videolayouts

import { StreamCall } from '@capgo/capacitor-stream-call';

const { newLayout } = await StreamCall.toggleViews();
console.log(`Layout switched to ${newLayout}`);

setSpeaker

Sprecherfunktion einschalten

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.setSpeaker({ name: 'speaker' });

switchCamera

Kamera wechseln

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.switchCamera({ camera: 'back' });

getCallInfo

Detaillierte Informationen über einen aktiven Anruf einschließlich Angaben zum Anrufer erhalten

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.getCallInfo({} as { callId: string });

setDynamicStreamVideoApikey

Setzen Sie eine dynamische Stream-Videodatei API-Schlüssel, der den statischen überschreibt

import { StreamCall } from '@capgo/capacitor-stream-call';

await StreamCall.setDynamicStreamVideoApikey({ apiKey: 'new-api-key' });

getDynamicStreamVideoApikey

Holen Sie sich den derzeit gesetzten dynamischen Stream-Videodatei API-Schlüssel

import { StreamCall } from '@capgo/capacitor-stream-call';

const result = await StreamCall.getDynamicStreamVideoApikey();
if (result.hasDynamicKey) {
  console.log('Dynamic API key:', result.apiKey);
} else {
  console.log('Using static API key from resources');
}

getCurrentUser

Holen Sie sich die Informationen des aktuellen Benutzers

import { StreamCall } from '@capgo/capacitor-stream-call';

const currentUser = await StreamCall.getCurrentUser();
console.log(currentUser);

Typenreferenz

LoginOptions

export interface LoginOptions {
  /** Stream Video API token */
  token: string;
  /** User ID for the current user */
  userId: string;
  /** Display name for the current user */
  name: string;
  /** Optional avatar URL for the current user */
  imageURL?: string;
  /** Stream Video API key */
  apiKey: string;
  /** ID of the HTML element where the video will be rendered */
  magicDivId?: string;
  pushNotificationsConfig?: PushNotificationsConfig;
}

SuccessResponse

export interface SuccessResponse {
  /** Whether the operation was successful */
  success: boolean;
  callId?: string;
}

CallOptions

export interface CallOptions {
  /** User ID of the person to call */
  userIds: string[];
  /** Type of call, defaults to 'default' */
  type?: CallType;
  /** Whether to ring the other user, defaults to true */
  ring?: boolean;
  /** Team name to call */
  team?: string;
  /** Whether to start the call with video enabled, defaults to false */
  video?: boolean;
  /** Custom data to be passed to the call */
  custom?: Record<
    string,
    | string
    | boolean
    | number
    | null
    | Record<string, string | boolean | number | null>
    | string[]
    | boolean[]
    | number[]
  >;
}

CallEvent

export interface CallEvent {
  /** ID of the call */
  callId: string;
  /** Current state of the call */
  state: CallState;
  /** User ID of the participant in the call who triggered the event */
  userId?: string;
  /** Reason for the call state change, if applicable */
  reason?: string;
  /** Information about the caller (for incoming calls) */
  caller?: CallMember;
  /** List of call members */
  members?: CallMember[];

  custom?: Record<
    string,
    | string
    | boolean
    | number
    | null
    | Record<string, string | boolean | number | null>
    | string[]
    | boolean[]
    | number[]
  >;

  count?: number;
}

IncomingCallPayload

export interface IncomingCallPayload {
  /** Full call CID (e.g. default:123) */
  cid: string;
  /** Event type (currently always "incoming") */
  type: 'incoming';
  /** Information about the caller */
  caller?: CallMember;
  /** Custom data to be passed to the call */
  custom?: Record<
    string,
    | string
    | boolean
    | number
    | null
    | Record<string, string | boolean | number | null>
    | string[]
    | boolean[]
    | number[]
  >;

  /**
   * Get the native Capacitor plugin version
   *
   * @returns {Promise<{ id: string }>} an Promise with version for this device
   * @throws An error if the something went wrong
   */
  getPluginVersion(): Promise<{ version: string }>;
}

CameraEnabledResponse

export interface CameraEnabledResponse {
  enabled: boolean;
}

StreamCallLayout

export type StreamCallLayout = 'grid' | 'spotlight' | 'dynamic' | 'fullScreen' | 'fullscreen';

DynamicApiKeyResponse

export interface DynamicApiKeyResponse {
  /** The dynamic API key if set, null if not */
  apiKey: string | null;
  /** Whether a dynamic key is currently set */
  hasDynamicKey: boolean;
}

CurrentUserResponse

export interface CurrentUserResponse {
  /** User ID of the current user */
  userId: string;
  /** Display name of the current user */
  name: string;
  /** Avatar URL of the current user */
  imageURL?: string;
  /** Whether the user is currently logged in */
  isLoggedIn: boolean;
}

PushNotificationsConfig

export interface PushNotificationsConfig {
  pushProviderName: string;
  voipProviderName: string;
}

CallType

export type CallType = 'default' | 'audio' | 'audio_room' | 'livestream' | 'development';

CallState

export type CallState =
  // User-facing states
  | 'idle'
  | 'ringing'
  | 'joining'
  | 'reconnecting'
  | 'joined'
  | 'leaving'
  | 'left'
  // Event-specific states
  | 'created'
  | 'session_started'
  | 'rejected'
  | 'participant_counts'
  | 'missed'
  | 'accepted'
  | 'ended'
  | 'camera_enabled'
  | 'camera_disabled'
  | 'speaker_enabled'
  | 'speaker_disabled'
  | 'microphone_enabled'
  | 'microphone_disabled'
  | 'outgoing_call_ended'
  | 'unknown';

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.

Weitergehen von Getting Started

Wenn Sie das verwenden Getting Started um einen Dashboard und API-Bereich zu planen, verbinden Sie es mit Mit @capgo/capacitor-stream-call für die native Fähigkeit in Mit @capgo/capacitor-stream-call für die Implementierungsdetails in API Overview für die Implementierungsdetails in API Overview Einführung für die Implementierungsdetails in Einführung API Schlüssel für die Implementierungsdetails in API Schlüssel und Geräte für die Implementierungsdetails in Geräte.