github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2026-05-20 00:06:24 +08:00
Code Issues Projects Releases Wiki Activity

docs(all): standardizes and adds return types, also some param fixes

Browse Source
This commit is contained in:
Alex Muramoto
2016-11-29 16:40:50 -06:00
parent b7a562053a
commit 3da2831779
88 changed files with 635 additions and 347 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/plugins/native-audio.ts
+5 -1
View File
@@ -55,7 +55,8 @@ export class NativeAudio {
/**
* Plays an audio asset
* @param id {string} unique ID for the audio file
* @param completeCallback {Function} callback to be invoked when audio is done playing
* @param completeCallback {Function} optional. Callback to be invoked when audio is done playing
* @returns {Promise<any>}
*/
@Cordova({
successIndex: 1,
@@ -66,6 +67,7 @@ export class NativeAudio {
/**
* Stops playing an audio
* @param id {string} unique ID for the audio file
* @returns {Promise<any>}
*/
@Cordova()
static stop(id: string): Promise<any> {return; }
@@ -81,6 +83,7 @@ export class NativeAudio {
/**
* Unloads an audio file from memory
* @param id {string} unique ID for the audio file
* @returns {Promise<any>}
*/
@Cordova()
static unload(id: string): Promise<any> {return; }
@@ -89,6 +92,7 @@ export class NativeAudio {
* Changes the volume for preloaded complex assets.
* @param id {string} unique ID for the audio file
* @param volume {number} the volume of the audio asset (0.1 to 1.0)
* @returns {Promise<any>}
*/
@Cordova()
static setVolumeForComplexAsset(id: string, volume: number): Promise<any> {return; }