1.0.1 • Published 9 months ago

@wisdomgarden/media-picker v1.0.1

Weekly downloads
-
License
MIT
Repository
gitlab
Last release
9 months ago

Media Picker Plugin

This is a Capacitor 2 plugin that provides a Media Picker for selecting images and videos.

Install

npm install @wisdomgarden/media-picker
npx cap sync

or

yarn install @wisdomgarden/media-picker 
npx cap sync

Example

// use in web
import { MediaPicker } from '@wisdomgarden/media-picker';
// use in native
import { Plugins } from '@capacitor/core';

const { MediaPicker } = Plugins;
var ret = await MediaPicker.checkAvailability();

console.log('is available', ret.isAvailable);

ret = await MediaPicker.pickMedias({
  type: MediaPicker.MEDIA_TYPE.ImageOAndVideo,
  maximum: 2
})

if(ret && ret.uris) {
  console.log('picked medias', ret.uris);
}

API

checkAvailability

checkAvailability(): Promise<AvailabilityState>;

Get the availability state of the media picker.

Returns: Promise<AvailabilityState>

PropertyTypeDescription
isAvailablebooleanWhether the media picker is available

pickMedias

pickMedias(options: {type: PICK_MEDIA_TYPE, maximum?: number}): Promise<PickMediasResult>;

Pick multiple medias.

ParamsTypeDescriptionrequireddefault
typePICK_MEDIA_TYPEThe type of media to picktrue
maximumnumberThe maximum number of media to pickfalse1

Returns: Promise<PickMediasResult>


Interfaces

AvailabilityState

PropTypeDescription
isAvailablebooleanWhether the media picker is available

PICK_MEDIA_TYPE

PropTypeDescription
ImageOnlystringOnly images
VideoOnlystringOnly videos
ImageOAndVideostringImages and videos

PickMediasResult

PropTypeDescription
urisstring[]The uris of the picked media or undefined if no media is picked
1.0.1

9 months ago

1.0.0

9 months ago