vlibras-player-webjs
Version:
Biblioteca JavaScript moderna para integração do VLibras Player com React, Vue, Angular e vanilla JS
56 lines • 1.79 kB
TypeScript
export interface VLibrasPlayerConfig {
container?: string | HTMLElement;
width?: number;
height?: string | number;
responsive?: boolean;
autoplay?: boolean;
controls?: boolean;
muted?: boolean;
debug?: boolean;
theme?: 'light' | 'dark' | 'high-contrast' | 'auto';
language?: 'pt-br' | 'en' | 'es';
enableCache?: boolean;
cacheTimeout?: number;
fallbackUrl?: string;
targetPath?: string;
errorCallback?: (error: Error) => void;
loadingCallback?: (progress: number) => void;
onReady?: () => void;
onLoad?: () => void;
onPlay?: () => void;
onPause?: () => void;
onStop?: () => void;
onError?: (error: Error) => void;
}
export interface VLibrasPlayerInstance {
translate(text: string, options?: any): void;
translateAsync(text: string, options?: any): Promise<string>;
play(gloss?: string, options?: any): void;
playAsync(gloss?: string, options?: any): Promise<any>;
pause(): void;
stop(): void;
destroy(): void;
translateAndPlay(text: string, options?: any): Promise<any>;
eventEmitter: any;
}
export interface UseVLibrasOptions extends VLibrasPlayerConfig {
autoInit?: boolean;
targetPath?: string;
}
export interface UseVLibrasReturn {
player: VLibrasPlayerInstance | null;
isLoaded: boolean;
isPlaying: boolean;
error: string | null;
translate: (text: string) => Promise<void>;
play: () => Promise<void>;
pause: () => Promise<void>;
stop: () => Promise<void>;
destroy: () => Promise<void>;
}
/**
* Hook React para gerenciar o VLibras Player
* Gerencia estado, lifecycle e fornece API simplificada
*/
export declare function useVLibras(options?: UseVLibrasOptions): UseVLibrasReturn;
//# sourceMappingURL=useVLibras.d.ts.map