capacitor-plugin-stable-diffusion

only iOS and iPadOS

Install

npm install capacitor-plugin-stable-diffusion
npx cap sync

API

• addListener('downloadProgress', ...)
• addListener('downloadDidComplete', ...)
• addListener('unzipDidComplete', ...)
• addListener('generateProgress', ...)
• addListener('generateDidComplete', ...)
• download(...)
• echo(...)
• generateTextToImage(...)
• getImages(...)
• unzip(...)
• Interfaces
• Type Aliases

addListener('downloadProgress', ...)

addListener(eventName: "downloadProgress", listenerFunc: DownloadProgressListener) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ----------------------------------------------------------------------------- | | eventName | 'downloadProgress' | | listenerFunc | DownloadProgressListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('downloadDidComplete', ...)

addListener(eventName: "downloadDidComplete", listenerFunc: DownloadDidCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ----------------------------------------------------------------------------------- | | eventName | 'downloadDidComplete' | | listenerFunc | DownloadDidCompleteListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('unzipDidComplete', ...)

addListener(eventName: "unzipDidComplete", listenerFunc: UnzipDidCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ----------------------------------------------------------------------------- | | eventName | 'unzipDidComplete' | | listenerFunc | UnzipDidCompleteListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('generateProgress', ...)

addListener(eventName: "generateProgress", listenerFunc: GenerateProgressListener) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ----------------------------------------------------------------------------- | | eventName | 'generateProgress' | | listenerFunc | GenerateProgressListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('generateDidComplete', ...)

addListener(eventName: "generateDidComplete", listenerFunc: GenerateDidCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ----------------------------------------------------------------------------------- | | eventName | 'generateDidComplete' | | listenerFunc | GenerateDidCompleteListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

download(...)

download(options: DownloadOptions) => Promise<void>

| Param | Type | | ------------- | ----------------------------------------------------------- | | options | DownloadOptions |

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

Returns: Promise<{ value: string; }>

generateTextToImage(...)

generateTextToImage(options: GenerateTextToImageOptions) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------------------------------------- | | options | GenerateTextToImageOptions |

getImages(...)

getImages(options: GetImagesOptions) => Promise<GetImagesResult>

| Param | Type | | ------------- | ------------------------------------------------------------- | | options | GetImagesOptions |

Returns: Promise<GetImagesResult>

unzip(...)

unzip(options: UnzipOptions) => Promise<void>

| Param | Type | | ------------- | ----------------------------------------------------- | | options | UnzipOptions |

Interfaces

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

DownloadOptions

| Prop | Type | | ------------------- | ------------------- | | modelsDirName | string | | url | string |

GenerateTextToImageOptions

| Prop | Type | | --------------- | ------------------- | | modelPath | string | | prompt | string | | savePath | string | | seed | number |

GetImagesResult

| Prop | Type | | ------------ | ------------------------ | | images | ImageInfo[] |

GetImagesOptions

| Prop | Type | | ---------- | ------------------- | | path | string |

UnzipOptions

| Prop | Type | | ------------------- | ------------------- | | modelsDirName | string | | url | string |

Type Aliases

DownloadProgressListener

(data: { progress: number; }): void

DownloadDidCompleteListener

(data: DownloadDidCompleteResult): void

DownloadDidCompleteResult

{ error?: string; state: "completed" | "fail"; }

UnzipDidCompleteListener

(data: UnzipDidCompleteResult): void

UnzipDidCompleteResult

{ state: "completed"; }

GenerateProgressListener

(data: { progress: number; }): void

GenerateDidCompleteListener

(data: GenerateDidCompleteResult): void

GenerateDidCompleteResult

{ error?: string; filePath?: string; state: "completed" | "fail"; }

ImageInfo

{ ctime: number; exif?: Record<string, string>; mtime: number; name: string; size: number; uri: string; }

Record

Construct a type with a set of properties K of type T

{ [P in K]: T; }