Skip to content

daveshirman/capacitor-plugin-remote-audio

Repository files navigation

capacitor-plugin-remote-audio

A very basic and probably in much need of attention Capacitor plugin for playing remote audio files in Android. iOS not implemented as wasn't required at time of writing.

Install

npm install capacitor-plugin-remote-audio
npx cap sync

API

setOrientation(...)

setOrientation(options: { orientation: OrientationChoice; }) => any
Param Type
options { orientation: OrientationChoice; }

Returns: any


getMediaInfo(...)

getMediaInfo(options: { title: string; url: string; }) => any
Param Type
options { title: string; url: string; }

Returns: any


play(...)

play(options: { url: string; }) => any
Param Type
options { url: string; }

Returns: any


pause()

pause() => any

Returns: any


stop()

stop() => any

Returns: any


seek(...)

seek(options: { milliseconds: number; }) => any
Param Type
options { milliseconds: number; }

Returns: any


getCurrentPosition()

getCurrentPosition() => any

Returns: any


checkOrRequestStoragePermissions()

checkOrRequestStoragePermissions() => any

Returns: any


downloadMedia(...)

downloadMedia(options: { id: string; url: string; folderName: string; }) => any
Param Type
options { id: string; url: string; folderName: string; }

Returns: any


cancelDownload(...)

cancelDownload(options: { id: string; folderName: string; }) => any
Param Type
options { id: string; folderName: string; }

Returns: any


deleteDownload(...)

deleteDownload(options: { id: string; folderName: string; }) => any
Param Type
options { id: string; folderName: string; }

Returns: any


deleteAllDownloads(...)

deleteAllDownloads(options: { folderName: string; }) => any
Param Type
options { folderName: string; }

Returns: any


showRateApp()

showRateApp() => any

Returns: any


Enums

OrientationChoice

Members Value
Unlocked "unlocked"
Portrait "portrait"
Landscape "landscape"