@hanhokim/capacitor-device-media

Device medias from capacitor. For internal project usage

Install

npm install @hanhokim/capacitor-device-media
npx cap sync

API

• echo(...)
• getThumbnails(...)
• getMedia(...)
• getAlbums()
• addListener('mediaDidChanged', ...)
• Interfaces

echo(...)

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

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

Returns: Promise<{ value: string; }>

getThumbnails(...)

getThumbnails(options?: ThumbnailFetchOptions | undefined) => Promise<ThumbnailResponse | undefined>

| Param | Type | | ------------- | ----------------------------------------------------------------------- | | options | ThumbnailFetchOptions |

Returns: Promise<ThumbnailResponse>

getMedia(...)

getMedia(options?: MediaFetchOptions | undefined) => Promise<MediaResponse | undefined>

| Param | Type | | ------------- | --------------------------------------------------------------- | | options | MediaFetchOptions |

Returns: Promise<MediaResponse>

getAlbums()

getAlbums() => Promise<MediaAlbumResponse | undefined>

Returns: Promise<MediaAlbumResponse>

addListener('mediaDidChanged', ...)

addListener(eventName: 'mediaDidChanged', listenerFunc: (event: any) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | ------------------------------------ | | eventName | 'mediaDidChanged' | | listenerFunc | (event: any) => void |

Returns: Promise<PluginListenerHandle>

Interfaces

ThumbnailResponse

| Prop | Type | | ------------ | ------------------------- | | medias | MediaAsset[] |

MediaAsset

| Prop | Type | Description | | --------------------- | ----------------------------------------------- | ------------------------------------------ | | identifier | string | Platform-specific identifier | | data | MediaData | Data for a media : url or base64 | | mediaType | string | Data for a mediaType : image or video | | mediaSubtype | string | Data for a mediaSubtype such as png, mp4 | | fileSize | number | Data for a filesize as Byte | | creationDate | string | ISO date string for creation date of asset | | fullWidth | number | Full width of original asset | | fullHeight | number | Full height of original asset | | thumbnailWidth | number | Width of thumbnail preview | | thumbnailHeight | number | Height of thumbnail preview | | duration | any | Duration of media |

MediaData

| Prop | Type | | ------------ | ------------------- | | base64 | string | | url | string |

ThumbnailFetchOptions

| Prop | Type | Description | | ---------------------- | ------------------- | --------------------------------------------------------------------- | | quantity | number | The number of photos to fetch, sorted by last created date descending | | thumbnailWidth | number | The width of thumbnail to return | | thumbnailHeight | number | The height of thumbnail to return | | thumbnailQuality | number | The quality of thumbnail to return as JPEG (0-100) | | types | string | Which types of assets to return (photos or videos or all) | | albumIdentifier | string | Which album identifier to query in (get identifier with getAlbums()) | | start | number | The start index of photos to fetch (for pagination) |

MediaResponse

| Prop | Type | | ------------ | ------------------------- | | medias | MediaAsset[] |

MediaFetchOptions

| Prop | Type | Description | | --------------------- | ------------------- | ------------------------------------------------ | | mediaIdentifier | string | Which media to query (only using for getMedia()) |

MediaAlbumResponse

| Prop | Type | | ------------ | ------------------------- | | albums | MediaAlbum[] |

MediaAlbum

| Prop | Type | | ---------------- | ------------------------------------------------------------------ | | identifier | string | | title | string | | count | { total?: number; photos?: number; videos?: number; } | | thumbnail | { base64?: string; base64Raw?: string; } | | type | 'smart' | 'shared' | 'user' | 'unfiltered' |

PluginListenerHandle

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