server/src/system_tray.h

Rama main · réplica de lectura del repositorio original.

/**
 * @file src/system_tray.h
 * @brief Declarations for the system tray icon and notification system.
 */
#pragma once

#include <string>

struct tray_menu;

/**
 * @brief Handles the system tray icon and notification system.
 */
namespace system_tray {
  /**
   * @brief Callback for opening the UI from the system tray.
   * @param item The tray menu item.
   */
  void tray_open_ui_cb([[maybe_unused]] struct tray_menu *item);

  void tray_force_stop_cb(struct tray_menu *item);

  /**
   * @brief Generic notification helper (stacking). Title/text copied immediately; callback optional.
   * @param title Notification title
   * @param text Notification body
   * @param cb Optional click callback (opens URLs, UI pages, etc.)
   */
  void tray_notify(const char *title, const char *text, void (*cb)() = nullptr);

  /**
   * @brief Callback for restarting Sunshine from the system tray.
   * @param item The tray menu item.
   */
  void tray_restart_cb([[maybe_unused]] struct tray_menu *item);

  /**
   * @brief Callback for exiting Sunshine from the system tray.
   * @param item The tray menu item.
   */
  void tray_quit_cb([[maybe_unused]] struct tray_menu *item);

  /**
   * @brief Create the system tray.
   * @details This function has an endless loop, so it should be run in a separate thread.
   * @return 1 if the system tray failed to create, otherwise 0 once the tray has been terminated.
   */
  int system_tray();

  /**
   * @brief Run the system tray with platform specific options.
   * @todo macOS requires that UI elements be created on the main thread, so the system tray is not currently implemented for macOS.
   */
  void run_tray();

  /**
   * @brief Exit the system tray.
   * @return 0 after exiting the system tray.
   */
  int end_tray();

  /**
   * @brief Sets the tray icon in playing mode and spawns the appropriate notification
   * @param app_name The started application name
   */
  void update_tray_playing(std::string app_name);

  /**
   * @brief Sets the tray icon in pausing mode (stream stopped but app running) and spawns the appropriate notification
   * @param app_name The paused application name
   */
  void update_tray_pausing(std::string app_name);

  /**
   * @brief Sets the tray icon in stopped mode (app and stream stopped) and spawns the appropriate notification
   * @param app_name The started application name
   */
  void update_tray_stopped(std::string app_name);

  void
    update_tray_launch_error(std::string app_name, int exit_code);

  /**
   * @brief Spawns a notification for PIN Pairing. Clicking it opens the PIN Web UI Page
   */
  void update_tray_require_pin();

  void update_tray_paired(std::string device_name);

  /**
   * @brief Records the connecting client's name. No separate notification is
   * raised; update_tray_playing() folds the name into the single
   * "App launched" toast so a stream connect shows one notification.
   */
  void update_tray_client_connected(std::string client_name);

  /**
   * @brief Spawns a notification when ViGEm is missing.
   * Clicking it opens the Web UI Dashboard for more information.
   */
  void update_tray_vigem_missing();
}  // namespace system_tray