@klever-one/web-sdk
Version:
Web SDK for integrating real-time room management and streaming functionality into web applications
37 lines (36 loc) • 1.41 kB
TypeScript
import { KleverOneClient, KleverOneClientConfig, ClientState, ClientMetrics, Message } from '../../core';
import { ConversationEventData } from '../../core/types';
interface UseKleverOneClientProps extends KleverOneClientConfig {
}
interface UseKleverOneClientReturn {
client: KleverOneClient | null;
state: ClientState;
metrics: ClientMetrics;
conversationState: ConversationEventData;
messages: Message[];
connect: () => Promise<void>;
disconnect: () => void;
reconnect: () => Promise<void>;
sendText: (message: string) => Promise<void>;
speak: {
(input: string): void;
(input: string[]): void;
};
startRecording: () => Promise<void>;
stopRecording: () => Promise<void>;
isReady: () => boolean;
isRecording: () => boolean;
resize: (width: number, height: number) => void;
sendAvatarNum: (avatarNum: number | string) => void;
sendAvatarAppearanceChange: (avatarData: any) => void;
sendPlaceBackgroundChange: (id: string) => void;
sendVoiceSetting: (voiceId: string) => void;
sendMessage: (message: string | object | ArrayBuffer | Blob) => void;
sendDataInChunks: (params: {
payload: Uint8Array;
actionName: string;
chunkSize?: number;
}) => Promise<void>;
}
export declare function useKleverOneClient(config: UseKleverOneClientProps): UseKleverOneClientReturn;
export {};