seedance-video-sdk
Version:
Seedance AI Video Generation SDK - Create professional videos from text and images using ByteDance's advanced AI technology
101 lines • 4.05 kB
TypeScript
/**
* @seedance/video-sdk
*
* Official Seedance AI Video Generation SDK
*
* Create professional videos from text and images using ByteDance's advanced AI technology.
* This SDK provides a simple and powerful interface for integrating Seedance's video generation
* capabilities into your applications.
*
* @example
* ```typescript
* import { SeedanceClient } from '@seedance/video-sdk';
*
* const client = new SeedanceClient({
* apiKey: 'your-api-key'
* });
*
* // Generate video from text
* const task = await client.generateVideo({
* prompt: 'A beautiful sunset over the ocean',
* duration: 5,
* resolution: '1080p'
* });
*
* // Wait for completion
* const completedTask = await client.waitForCompletion(task.taskId, {
* onProgress: (task) => console.log(`Progress: ${task.progress}%`)
* });
*
* console.log('Video URL:', completedTask.videoUrl);
* ```
*
* @example React Components
* ```tsx
* import { VideoPlayer, ProgressIndicator } from '@seedance/video-sdk/react';
*
* function MyComponent() {
* return (
* <div>
* <VideoPlayer
* src="https://example.com/video.mp4"
* controls
* autoplay
* />
* <ProgressIndicator
* progress={75}
* status="processing"
* estimatedTime={30}
* />
* </div>
* );
* }
* ```
*
* @author Seedance Studio
* @version 1.0.0
* @license MIT
* @homepage https://seedance.studio
* @repository https://github.com/saasfly/saasfly
*/
/// <reference types="node" />
export { SeedanceClient } from './client/SeedanceClient';
export type { SeedanceConfig, VideoGenerationRequest, VideoGenerationResponse, VideoTask, PaginatedResponse, VideoListOptions, WebhookConfig, WebhookPayload, SeedanceError, UploadResponse, QuotaInfo, UserInfo, VideoResolution, VideoStyle, AspectRatio, TaskStatus, GenerationParameters, WebhookEvent, VideoPlayerProps, VideoGeneratorProps, ProgressIndicatorProps, } from './types';
import type { SeedanceConfig, VideoGenerationRequest, VideoGenerationResponse } from './types';
import { SeedanceClient } from './client/SeedanceClient';
export { getResolutionDimensions, calculateVideoDimensions, validateVideoParams, formatFileSize, formatDuration, getStatusColor, getStatusText, estimateVideoSize, generateTaskId, isValidUrl, isValidImageFile, getFileExtension, fileToBase64, debounce, retry, ProgressTracker, } from './utils';
export { VideoPlayer } from './react/VideoPlayer';
export { ProgressIndicator } from './react/ProgressIndicator';
export declare const SDK_VERSION = "1.0.0";
export declare const DEFAULT_API_BASE_URL = "https://api.seedance.studio/v1";
export declare const SUPPORTED_IMAGE_FORMATS: string[];
export declare const MAX_FILE_SIZE: number;
export declare const MAX_VIDEO_DURATION = 30;
export declare const MIN_VIDEO_DURATION = 1;
/**
* Create a new Seedance client instance
*
* @param config - Configuration options
* @returns Configured SeedanceClient instance
*/
export declare function createClient(config: SeedanceConfig): SeedanceClient;
/**
* Quick video generation helper function
*
* @param apiKey - Your Seedance API key
* @param prompt - Text prompt for video generation
* @param options - Additional generation options
* @returns Promise resolving to video generation response
*/
export declare function generateVideo(apiKey: string, prompt: string, options?: Omit<VideoGenerationRequest, 'prompt'>): Promise<VideoGenerationResponse>;
/**
* Quick image-to-video generation helper function
*
* @param apiKey - Your Seedance API key
* @param image - Input image (File, URL, or Buffer)
* @param prompt - Text prompt describing the desired video
* @param options - Additional generation options
* @returns Promise resolving to video generation response
*/
export declare function generateVideoFromImage(apiKey: string, image: File | string | Buffer, prompt: string, options?: Omit<VideoGenerationRequest, 'prompt' | 'image'>): Promise<VideoGenerationResponse>;
//# sourceMappingURL=index.d.ts.map