Function stopPlaybackMonitoring

  • stopPlaybackMonitoring(): boolean

    Stops the playback monitoring process

    Terminates all active monitoring activities including API polling, progress interpolation, and event handling. This function performs a complete and clean shutdown of the monitoring service.

    The function handles several important cleanup tasks:

    • Cancels all active polling intervals
    • Terminates progress update timers
    • Resets backoff strategy state
    • Logs the monitoring termination
    • Preserves accumulated listening data

    Typical usage scenarios include:

    • User-requested monitoring pause/stop
    • Application shutdown
    • Reconfiguration of monitoring parameters
    • Error recovery requiring service restart
    • Authentication changes

    Returns boolean

    Boolean indicating whether monitoring was successfully stopped

    Example

    // Stop monitoring during application shutdown
    app.on('before-quit', () => {
      stopPlaybackMonitoring();
    });

    // Stop, reconfigure, and restart monitoring
    stopPlaybackMonitoring();
    setMonitoringConfig({ pollingInterval: 5000 });
    startPlaybackMonitoring(mainWindow, clientId, clientSecret);

    Source

    export function stopPlaybackMonitoring(): boolean {
      try {
        if (monitoringInterval) {
          clearTimeout(monitoringInterval);
          monitoringInterval = null;
          store.saveLog("Stopped Spotify playback monitoring", "INFO");
        } else {
          store.saveLog("No active monitoring session to stop", "DEBUG");
        }

        // Clear the progress update interval when stopping monitoring
        if (progressUpdateInterval) {
          clearInterval(progressUpdateInterval);
          progressUpdateInterval = null;
        }

        // Reset backoff strategy when stopping
        resetBackoff();

        return true;
      } catch (error) {
        store.saveLog(`Failed to stop playback monitoring: ${error}`, "ERROR");
        return false;
      }
    }

Settings

Member Visibility