{"_id":"@bondulich/native-audio","_rev":"5-7f5fd421ca66d267dc5012b49f0e8fda","time":{"created":"2024-05-16T19:38:41.424Z","6.0.0":"2024-05-16T19:27:29.127Z","modified":"2024-05-20T20:15:20.553Z","6.0.1":"2024-05-16T19:38:41.702Z","6.0.2":"2024-05-20T20:09:42.965Z","6.0.3":"2024-05-20T20:15:20.383Z"},"name":"@bondulich/native-audio","dist-tags":{"latest":"6.0.3"},"versions":{"6.0.1":{"name":"@bondulich/native-audio","version":"6.0.1","description":"A native plugin for native audio engine","main":"dist/plugin.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","keywords":["capacitor","plugin","audio","media","native"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api NativeAudio --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build","prepare":"husky install"},"author":{"name":"bazuka5801","email":"bazuka5801@mail.ru"},"license":"MIT","dependencies":{},"devDependencies":{"@capacitor/android":"^6.0.0","@capacitor/ios":"^6.0.0","@capacitor/cli":"^6.0.0","@capacitor/core":"^6.0.0","@capacitor/docgen":"0.2.1","@ionic/eslint-config":"^0.3.0","@ionic/prettier-config":"~3.0.0","@ionic/swiftlint-config":"^1.1.2","eslint":"^7.11.0","prettier":"~2.8.8","prettier-plugin-java":"~2.1.0","rimraf":"^5.0.1","rollup":"^2.79.1","swiftlint":"^1.0.2","typescript":"~4.8.4","husky":"^8.0.3"},"peerDependencies":{"@capacitor/core":"^6.0.0"},"husky":{"hooks":{"pre-commit":"pretty-quick --staged"}},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"repository":{"type":"git","url":"git+https://github.com/bondulich/native-audio.git"},"bugs":{"url":"https://github.com/capacitor-community/native-audio/issues"},"publishConfig":{"access":"public"},"_id":"@bondulich/native-audio@6.0.1","gitHead":"d11633a6210ce92f28647543d387613906723b5e","homepage":"https://github.com/bondulich/native-audio#readme","_nodeVersion":"18.20.0","_npmVersion":"10.5.0","dist":{"integrity":"sha512-3hvBioytBdcLeHfyIYjGm13RHBw8/OblKm8swNytZKS5453mrVKtFb/QFAxnCj82pv6mAHkUE1yn2Pq6YBBbhw==","shasum":"aac1962c58b59e0d99ec58155358134ced7c5b3c","tarball":"https://registry.npmjs.org/@bondulich/native-audio/-/native-audio-6.0.1.tgz","fileCount":37,"unpackedSize":112827,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICXwvclgD+exQIFLi8EwIWB3TpnVMRtjc1br4cFyI4RZAiEAw44RTDCNe8zgtVjAbbxoNQj+XakeDMaMSuDp62UDedc="}]},"_npmUser":{"name":"bondulich","email":"bondulich12@gmail.com"},"directories":{},"maintainers":[{"name":"bondulich","email":"bondulich12@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/native-audio_6.0.1_1715888321520_0.30871939913865254"},"_hasShrinkwrap":false},"6.0.2":{"name":"@bondulich/native-audio","version":"6.0.2","description":"A native plugin for native audio engine","main":"dist/plugin.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","keywords":["capacitor","plugin","audio","media","native"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api NativeAudio --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build","prepare":"husky install"},"author":{"name":"bazuka5801","email":"bazuka5801@mail.ru"},"license":"MIT","dependencies":{},"devDependencies":{"@capacitor/android":"^6.0.0","@capacitor/ios":"^6.0.0","@capacitor/cli":"^6.0.0","@capacitor/core":"^6.0.0","@capacitor/docgen":"0.2.1","@ionic/eslint-config":"^0.3.0","@ionic/prettier-config":"~3.0.0","@ionic/swiftlint-config":"^1.1.2","eslint":"^7.11.0","prettier":"~2.8.8","prettier-plugin-java":"~2.1.0","rimraf":"^5.0.1","rollup":"^2.79.1","swiftlint":"^1.0.2","typescript":"~4.8.4","husky":"^8.0.3"},"peerDependencies":{"@capacitor/core":"^6.0.0"},"husky":{"hooks":{"pre-commit":"pretty-quick --staged"}},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"repository":{"type":"git","url":"git+https://github.com/bondulich/native-audio.git"},"bugs":{"url":"https://github.com/capacitor-community/native-audio/issues"},"publishConfig":{"access":"public"},"_id":"@bondulich/native-audio@6.0.2","gitHead":"b9fa7f130b196488013e793cf60b2a8b36bda6f8","homepage":"https://github.com/bondulich/native-audio#readme","_nodeVersion":"18.20.0","_npmVersion":"10.5.0","dist":{"integrity":"sha512-HOIR6xuNJC9k4JjLj5SEeiFq2HldneI/2D0/IxcJIBNkj2HCv1WLUIPHIsl3bme3kWcyMD9ajFM8TQLh5Zfh+w==","shasum":"68559367d28258685ca75074901e3695af2b5988","tarball":"https://registry.npmjs.org/@bondulich/native-audio/-/native-audio-6.0.2.tgz","fileCount":37,"unpackedSize":112808,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBNy1NvtGE0cTU7bDkyqvVui3uBusbFyonMnXM5/vf0mAiEAzPIO4N4sOQpSmZtURZk2QzJawcZPiH1AQCInLO/Gt0k="}]},"_npmUser":{"name":"bondulich","email":"bondulich12@gmail.com"},"directories":{},"maintainers":[{"name":"bondulich","email":"bondulich12@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/native-audio_6.0.2_1716235782744_0.7121716478788673"},"_hasShrinkwrap":false},"6.0.3":{"name":"@bondulich/native-audio","version":"6.0.3","description":"A native plugin for native audio engine","main":"dist/plugin.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","keywords":["capacitor","plugin","audio","media","native"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api NativeAudio --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build","prepare":"husky install"},"author":{"name":"bazuka5801","email":"bazuka5801@mail.ru"},"license":"MIT","dependencies":{},"devDependencies":{"@capacitor/android":"^6.0.0","@capacitor/ios":"^6.0.0","@capacitor/cli":"^6.0.0","@capacitor/core":"^6.0.0","@capacitor/docgen":"0.2.1","@ionic/eslint-config":"^0.3.0","@ionic/prettier-config":"~3.0.0","@ionic/swiftlint-config":"^1.1.2","eslint":"^7.11.0","prettier":"~2.8.8","prettier-plugin-java":"~2.1.0","rimraf":"^5.0.1","rollup":"^2.79.1","swiftlint":"^1.0.2","typescript":"~4.8.4","husky":"^8.0.3"},"peerDependencies":{"@capacitor/core":"^6.0.0"},"husky":{"hooks":{"pre-commit":"pretty-quick --staged"}},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"repository":{"type":"git","url":"git+https://github.com/bondulich/native-audio.git"},"bugs":{"url":"https://github.com/capacitor-community/native-audio/issues"},"publishConfig":{"access":"public"},"_id":"@bondulich/native-audio@6.0.3","gitHead":"2f992f96d9266f0d88523774893962cf29fb07f5","homepage":"https://github.com/bondulich/native-audio#readme","_nodeVersion":"18.20.0","_npmVersion":"10.5.0","dist":{"integrity":"sha512-HjTXbCWfhqSez7PEedJ8Qnk2+lHMTaE/7igEmKLhGXQqqJH2v3v89K7Bh4jUmK14fdY7Gq6Z4zOJMMIyGGuvVQ==","shasum":"8b644aa7308abbe0ff8396513751c6ad8ae533fc","tarball":"https://registry.npmjs.org/@bondulich/native-audio/-/native-audio-6.0.3.tgz","fileCount":37,"unpackedSize":112799,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCV7ONZj5Xu4y+2UWgFWVsj/dE3mVQtUnm/ELK7Z+giGAIhAN1sT9PhJIZ6c7B0sz+pJAMyphACU3dHM92dl3cUhNqu"}]},"_npmUser":{"name":"bondulich","email":"bondulich12@gmail.com"},"directories":{},"maintainers":[{"name":"bondulich","email":"bondulich12@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/native-audio_6.0.3_1716236120195_0.9743604414896141"},"_hasShrinkwrap":false}},"maintainers":[{"name":"bondulich","email":"bondulich12@gmail.com"}],"description":"A native plugin for native audio engine","homepage":"https://github.com/bondulich/native-audio#readme","keywords":["capacitor","plugin","audio","media","native"],"repository":{"type":"git","url":"git+https://github.com/bondulich/native-audio.git"},"author":{"name":"bazuka5801","email":"bazuka5801@mail.ru"},"bugs":{"url":"https://github.com/capacitor-community/native-audio/issues"},"license":"MIT","readme":"


\n

Native Audio

\n

@capacitor-community/native-audio

\n

\n This project is a fork to support Capacitor v6\n

\n

\n Capacitor community plugin for playing sounds natively.\n

\n\n

\n \n \n \n
\n \n \n\n\n\n

\n\n# Capacitor Native Audio Plugin\n\nCapacitor plugin for native audio engine.\nCapacitor v6 - βœ… Support!\n\nClick on video to see example πŸ’₯\n\n[![YouTube Example](https://img.youtube.com/vi/XpUGlWWtwHs/0.jpg)](https://www.youtube.com/watch?v=XpUGlWWtwHs)\n\n\n## Maintainers\n\n| Maintainer | GitHub | Social |\n| ------------- | ------------------------------------------- | ----------------------------------- |\n| Maxim Bazuev | [bazuka5801](https://github.com/bazuka5801) | [Telegram](https://t.me/bazuka5801) |\n\nMainteinance Status: Actively Maintained\n\n## Preparation\nAll audio place in specific platform folder\n\nAndoid: `android/app/src/assets`\n\niOS: `ios/App/App/sounds`\n\nWeb: `assets/sounds`\n\n## Installation\n\nTo use npm\n\n```bash\nnpm install @bondulich/native-audio\n```\n\nSync native files\n\n```bash\nnpx cap sync\n```\n\nOn iOS, Android and Web, no further steps are needed.\n\n## Configuration\n\nNo configuration required for this plugin.\n\n\n\n\n\n\n\n## Supported methods\n\n| Name | Android | iOS | Web |\n| :------------- | :------ | :-- | :-- |\n| configure | βœ… | βœ… | ❌ |\n| preload | βœ… | βœ… | βœ… |\n| play | βœ… | βœ… | βœ… |\n| pause | βœ… | βœ… | βœ… |\n| resume | βœ… | βœ… | βœ… |\n| loop | βœ… | βœ… | βœ… |\n| stop | βœ… | βœ… | βœ… |\n| unload | βœ… | βœ… | βœ… |\n| setVolume | βœ… | βœ… | βœ… |\n| getDuration | βœ… | βœ… | βœ… |\n| getCurrentTime | βœ… | βœ… | βœ… |\n| isPlaying | βœ… | βœ… | βœ… |\n\n## Usage\n\n[Example repository](https://github.com/bazuka5801/native-audio-example)\n\n```typescript\nimport {NativeAudio} from '@bondulich/native-audio'\n\n\n/**\n * This method will load more optimized audio files for background into memory.\n * @param assetPath - relative path of the file or absolute url (file://)\n * assetId - unique identifier of the file\n * audioChannelNum - number of audio channels\n * isUrl - pass true if assetPath is a `file://` url\n * @returns void\n */\nNativeAudio.preload({\n assetId: \"fire\",\n assetPath: \"fire.mp3\",\n audioChannelNum: 1,\n isUrl: false\n});\n\n/**\n * This method will play the loaded audio file if present in the memory.\n * @param assetId - identifier of the asset\n * @param time - (optional) play with seek. example: 6.0 - start playing track from 6 sec\n * @returns void\n */\nNativeAudio.play({\n assetId: 'fire',\n // time: 6.0 - seek time\n});\n\n/**\n * This method will loop the audio file for playback.\n * @param assetId - identifier of the asset\n * @returns void\n */\nNativeAudio.loop({\n assetId: 'fire',\n});\n\n\n/**\n * This method will stop the audio file if it's currently playing.\n * @param assetId - identifier of the asset\n * @returns void\n */\nNativeAudio.stop({\n assetId: 'fire',\n});\n\n/**\n * This method will unload the audio file from the memory.\n * @param assetId - identifier of the asset\n * @returns void\n */\nNativeAudio.unload({\n assetId: 'fire',\n});\n\n/**\n * This method will set the new volume for a audio file.\n * @param assetId - identifier of the asset\n * volume - numerical value of the volume between 0.1 - 1.0\n * @returns void\n */\nNativeAudio.setVolume({\n assetId: 'fire',\n volume: 0.4,\n});\n\n/**\n * this method will getΒ the duration of an audio file.\n * only works if channels == 1\n */\nNativeAudio.getDuration({\n assetId: 'fire'\n})\n.then(result => {\n console.log(result.duration);\n})\n\n/**\n * this method will get the current time of a playing audio file.\n * only works if channels == 1\n */\nNativeAudio.getCurrentTime({\n assetId: 'fire'\n});\n.then(result => {\n console.log(result.currentTime);\n})\n\n/**\n * This method will return false if audio is paused or not loaded.\n * @param assetId - identifier of the asset\n * @returns {isPlaying: boolean}\n */\nNativeAudio.isPlaying({\n assetId: 'fire'\n})\n.then(result => {\n console.log(result.isPlaying);\n})\n```\n\n## API\n\n\n\n\n\n\n### configure(...)\n\n```typescript\nconfigure(options: ConfigureOptions) => Promise\n```\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------- |\n| **`options`** | ConfigureOptions |\n\n--------------------\n\n\n### preload(...)\n\n```typescript\npreload(options: PreloadOptions) => Promise\n```\n\n| Param | Type |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | PreloadOptions |\n\n--------------------\n\n\n### play(...)\n\n```typescript\nplay(options: { assetId: string; time?: number; }) => Promise\n```\n\n| Param | Type |\n| ------------- | ------------------------------------------------ |\n| **`options`** | { assetId: string; time?: number; } |\n\n--------------------\n\n\n### pause(...)\n\n```typescript\npause(options: { assetId: string; }) => Promise\n```\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { assetId: string; } |\n\n--------------------\n\n\n### resume(...)\n\n```typescript\nresume(options: { assetId: string; }) => Promise\n```\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { assetId: string; } |\n\n--------------------\n\n\n### loop(...)\n\n```typescript\nloop(options: { assetId: string; }) => Promise\n```\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { assetId: string; } |\n\n--------------------\n\n\n### stop(...)\n\n```typescript\nstop(options: { assetId: string; }) => Promise\n```\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { assetId: string; } |\n\n--------------------\n\n\n### unload(...)\n\n```typescript\nunload(options: { assetId: string; }) => Promise\n```\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { assetId: string; } |\n\n--------------------\n\n\n### setVolume(...)\n\n```typescript\nsetVolume(options: { assetId: string; volume: number; }) => Promise\n```\n\n| Param | Type |\n| ------------- | ------------------------------------------------- |\n| **`options`** | { assetId: string; volume: number; } |\n\n--------------------\n\n\n### getCurrentTime(...)\n\n```typescript\ngetCurrentTime(options: { assetId: string; }) => Promise<{ currentTime: number; }>\n```\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { assetId: string; } |\n\n**Returns:** Promise<{ currentTime: number; }>\n\n--------------------\n\n\n### getDuration(...)\n\n```typescript\ngetDuration(options: { assetId: string; }) => Promise<{ duration: number; }>\n```\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { assetId: string; } |\n\n**Returns:** Promise<{ duration: number; }>\n\n--------------------\n\n\n### isPlaying(...)\n\n```typescript\nisPlaying(options: { assetId: string; }) => Promise<{ isPlaying: boolean; }>\n```\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { assetId: string; } |\n\n**Returns:** Promise<{ isPlaying: boolean; }>\n\n--------------------\n\n\n### addListener('complete', ...)\n\n```typescript\naddListener(eventName: 'complete', listenerFunc: (event: { assetId: string; }) => void) => Promise\n```\n\nListen for asset completed playing event\n\n| Param | Type |\n| ------------------ | ----------------------------------------------------- |\n| **`eventName`** | 'complete' |\n| **`listenerFunc`** | (event: { assetId: string; }) => void |\n\n**Returns:** Promise<PluginListenerHandle>\n\n**Since:** 5.0.1\n\n--------------------\n\n\n### Interfaces\n\n\n#### ConfigureOptions\n\n| Prop | Type | Description | Default |\n| ----------- | -------------------- | ------------------------------------------------- | ----------------- |\n| **`fade`** | boolean | indicating whether or not to fade audio. | true |\n| **`focus`** | boolean | indicating whether or not to disable mixed audio. | true |\n\n\n#### PreloadOptions\n\n| Prop | Type |\n| --------------------- | -------------------- |\n| **`assetPath`** | string |\n| **`assetId`** | string |\n| **`volume`** | number |\n| **`audioChannelNum`** | number |\n| **`isUrl`** | boolean |\n\n\n#### PluginListenerHandle\n\n| Prop | Type |\n| ------------ | ----------------------------------------- |\n| **`remove`** | () => Promise<void> |\n\n\n","readmeFilename":"README.md"}