UNPKG

1.59 kBTypeScriptView Raw
1import { Observable } from 'rxjs/Observable';
2/**
3 * @name DB Meter
4 * @description This plugin defines a global DBMeter object, which permits to get the decibel values from the microphone.
5 * @usage
6 * ```typescript
7 * import { DBMeter } from 'ionic-native';
8 *
9 *
10 * // Start listening
11 * let subscription = DBMeter.start().subscribe(
12 * data => console.log(data)
13 * );
14 *
15 * // Check if we are listening
16 * DBMeter.isListening().then(
17 * (isListening: boolean) => console.log(isListening)
18 * );
19 *
20 * // Stop listening
21 * subscription.unsubscribe();
22 *
23 * // Delete DBMeter instance from memory
24 * DBMeter.delete().then(
25 * () => console.log('Deleted DB Meter instance'),
26 * error => console.log('Error occurred while deleting DB Meter instance')
27 * );
28 * ```
29 */
30export declare class DBMeter {
31 /**
32 * Starts listening
33 * @returns {Observable<any>} Returns an observable. Subscribe to start listening. Unsubscribe to stop listening.
34 */
35 static start(): Observable<any>;
36 /**
37 * Stops listening
38 * @private
39 */
40 static stop(): Promise<any>;
41 /**
42 * Check if the DB Meter is listening
43 * @returns {Promise<boolean>} Returns a promise that resolves with a boolean that tells us whether the DB meter is listening
44 */
45 static isListening(): Promise<boolean>;
46 /**
47 * Delete the DB Meter instance
48 * @returns {Promise<any>} Returns a promise that will resolve if the instance has been deleted, and rejects if errors occur.
49 */
50 static delete(): Promise<any>;
51}