/**
 * Result containing the compass heading value.
 *
 * @since 7.0.0
 */
export interface CompassHeading {
    /** Compass heading in degrees (0-360) */
    value: number;
}
/**
 * Event data for heading change events.
 *
 * @since 7.0.0
 */
export interface HeadingChangeEvent {
    /** Compass heading in degrees (0-360) */
    value: number;
}
/**
 * Options for configuring compass listening behavior.
 *
 * @since 8.1.4
 */
export interface ListeningOptions {
    /**
     * Minimum interval between heading change events in milliseconds.
     * Lower values = more frequent updates but higher CPU/battery usage.
     *
     * @default 100
     * @since 8.1.4
     */
    minInterval?: number;
    /**
     * Minimum heading change in degrees required to trigger an event.
     * Lower values = more sensitive but more events.
     * Handles wraparound (e.g., 359° to 1° = 2° change).
     *
     * @default 2.0
     * @since 8.1.4
     */
    minHeadingChange?: number;
}
/**
 * Compass accuracy level constants.
 *
 * @since 8.2.0
 */
export declare enum CompassAccuracy {
    /** High accuracy - approximates to less than 5 degrees of error */
    HIGH = 3,
    /** Medium accuracy - approximates to less than 10 degrees of error */
    MEDIUM = 2,
    /** Low accuracy - approximates to less than 15 degrees of error */
    LOW = 1,
    /** Unreliable accuracy - approximates to more than 15 degrees of error */
    UNRELIABLE = 0,
    /** Unknown accuracy value */
    UNKNOWN = -1
}
/**
 * Event data for accuracy change events.
 *
 * @since 8.2.0
 */
export interface AccuracyChangeEvent {
    /** Current accuracy level of the compass */
    accuracy: CompassAccuracy;
}
/**
 * Permission state for compass access.
 *
 * @since 7.0.0
 */
export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';
/**
 * Permission status for compass plugin.
 *
 * @since 7.0.0
 */
export interface PermissionStatus {
    /**
     * Permission state for accessing compass/location data.
     * On iOS, this requires location permission to access heading.
     * On Android, no special permissions are required for compass sensors.
     *
     * @since 7.0.0
     */
    compass: PermissionState;
}
/**
 * Capacitor Compass Plugin interface for reading device compass heading.
 *
 * @since 7.0.0
 */
export interface CapgoCompassPlugin {
    /**
     * Get the current compass heading in degrees.
     * On iOS, the heading is updated in the background, and the latest value is returned.
     * On Android, the heading is calculated when the method is called using accelerometer and magnetometer sensors.
     * Not implemented on Web.
     *
     * @returns Promise that resolves with the compass heading
     * @throws Error if compass is not available or permission denied
     * @since 7.0.0
     * @example
     * ```typescript
     * const { value } = await CapgoCompass.getCurrentHeading();
     * console.log('Compass heading:', value, 'degrees');
     * ```
     */
    getCurrentHeading(): Promise<CompassHeading>;
    /**
     * Get the native Capacitor plugin version.
     *
     * @returns Promise that resolves with the plugin version
     * @throws Error if getting the version fails
     * @since 7.0.0
     * @example
     * ```typescript
     * const { version } = await CapgoCompass.getPluginVersion();
     * console.log('Plugin version:', version);
     * ```
     */
    getPluginVersion(): Promise<{
        version: string;
    }>;
    /**
     * Start listening for compass heading changes via events.
     * This starts the compass sensors and emits 'headingChange' events.
     *
     * @param options - Optional configuration for throttling behavior
     * @returns Promise that resolves when listening starts
     * @since 7.0.0
     * @example
     * ```typescript
     * // With default throttling (100ms interval, 2° minimum change)
     * await CapgoCompass.startListening();
     *
     * // With custom throttling for high-frequency updates
     * await CapgoCompass.startListening({
     *   minInterval: 50,      // 50ms between events
     *   minHeadingChange: 1.0 // 1° minimum change
     * });
     *
     * CapgoCompass.addListener('headingChange', (event) => {
     *   console.log('Heading:', event.value);
     * });
     * ```
     */
    startListening(options?: ListeningOptions): Promise<void>;
    /**
     * Stop listening for compass heading changes.
     * This stops the compass sensors and stops emitting events.
     *
     * @returns Promise that resolves when listening stops
     * @since 7.0.0
     * @example
     * ```typescript
     * await CapgoCompass.stopListening();
     * ```
     */
    stopListening(): Promise<void>;
    /**
     * Add a listener for compass heading change events.
     *
     * @param eventName - The event to listen for ('headingChange')
     * @param listenerFunc - The function to call when the event is emitted
     * @returns A promise that resolves with a handle to remove the listener
     * @since 7.0.0
     * @example
     * ```typescript
     * const handle = await CapgoCompass.addListener('headingChange', (event) => {
     *   console.log('Heading:', event.value, 'degrees');
     * });
     * // Later: handle.remove();
     * ```
     */
    addListener(eventName: 'headingChange', listenerFunc: (event: HeadingChangeEvent) => void): Promise<{
        remove: () => Promise<void>;
    }>;
    /**
     * Add a listener for compass accuracy change events.
     * Only supported on Android. On iOS and Web, this will never emit events.
     *
     * @param eventName - The event to listen for ('accuracyChange')
     * @param listenerFunc - The function to call when the event is emitted
     * @returns A promise that resolves with a handle to remove the listener
     * @since 8.2.0
     * @example
     * ```typescript
     * const handle = await CapgoCompass.addListener('accuracyChange', (event) => {
     *   console.log('Compass accuracy:', event.accuracy);
     * });
     * // Later: handle.remove();
     * ```
     */
    addListener(eventName: 'accuracyChange', listenerFunc: (event: AccuracyChangeEvent) => void): Promise<{
        remove: () => Promise<void>;
    }>;
    /**
     * Remove all listeners for this plugin.
     *
     * @returns Promise that resolves when all listeners are removed
     * @since 7.0.0
     * @example
     * ```typescript
     * await CapgoCompass.removeAllListeners();
     * ```
     */
    removeAllListeners(): Promise<void>;
    /**
     * Check the current permission status for accessing compass data.
     * On iOS, this checks location permission status.
     * On Android, this always returns 'granted' as no permissions are required.
     *
     * @returns Promise that resolves with the permission status
     * @since 7.0.0
     * @example
     * ```typescript
     * const status = await CapgoCompass.checkPermissions();
     * console.log('Compass permission:', status.compass);
     * ```
     */
    checkPermissions(): Promise<PermissionStatus>;
    /**
     * Request permission to access compass data.
     * On iOS, this requests location permission (required for heading data).
     * On Android, this resolves immediately as no permissions are required.
     *
     * @returns Promise that resolves with the new permission status
     * @since 7.0.0
     * @example
     * ```typescript
     * const status = await CapgoCompass.requestPermissions();
     * if (status.compass === 'granted') {
     *   // Can now use compass
     * }
     * ```
     */
    requestPermissions(): Promise<PermissionStatus>;
    /**
     * Start monitoring compass accuracy.
     * On Android, this monitors the magnetometer accuracy and emits accuracyChange events.
     * Developers can listen to these events and implement their own UI for calibration prompts.
     * On iOS and Web, this method does nothing as compass accuracy monitoring is not available.
     *
     * @returns Promise that resolves when monitoring starts
     * @since 8.2.0
     * @example
     * ```typescript
     * // Start monitoring accuracy
     * await CapgoCompass.watchAccuracy();
     *
     * // Listen for accuracy changes and implement custom UI
     * CapgoCompass.addListener('accuracyChange', (event) => {
     *   console.log('Accuracy changed to:', event.accuracy);
     *   if (event.accuracy < CompassAccuracy.MEDIUM) {
     *     // Show your custom calibration UI
     *   }
     * });
     * ```
     */
    watchAccuracy(): Promise<void>;
    /**
     * Stop monitoring compass accuracy.
     * This stops the accuracy monitoring.
     *
     * @returns Promise that resolves when monitoring stops
     * @since 8.2.0
     * @example
     * ```typescript
     * await CapgoCompass.unwatchAccuracy();
     * ```
     */
    unwatchAccuracy(): Promise<void>;
    /**
     * Get the current compass accuracy level.
     * On Android, returns the current magnetometer sensor accuracy.
     * On iOS and Web, always returns CompassAccuracy.UNKNOWN as accuracy monitoring is not available.
     *
     * @returns Promise that resolves with the current accuracy level
     * @since 8.2.0
     * @example
     * ```typescript
     * const { accuracy } = await CapgoCompass.getAccuracy();
     * if (accuracy < CompassAccuracy.MEDIUM) {
     *   console.log('Compass needs calibration');
     * }
     * ```
     */
    getAccuracy(): Promise<{
        accuracy: CompassAccuracy;
    }>;
}