system_tray Namespace Reference

Handles the system tray icon and notification system. More...

Functions
int	end_tray ()
	Exit the system tray.
void	run_tray ()
	Run the system tray with platform specific options.
int	system_tray ()
	Create the system tray.
void	tray_donate_github_cb (struct tray_menu *item)
	Callback for opening GitHub Sponsors from the system tray.
void	tray_donate_patreon_cb (struct tray_menu *item)
	Callback for opening Patreon from the system tray.
void	tray_donate_paypal_cb (struct tray_menu *item)
	Callback for opening PayPal donation from the system tray.
void	tray_open_ui_cb (struct tray_menu *item)
	Callback for opening the UI from the system tray.
void	tray_quit_cb (struct tray_menu *item)
	Callback for exiting Sunshine from the system tray.
void	tray_reset_display_device_config_cb (struct tray_menu *item)
	Callback for resetting display device configuration.
void	tray_restart_cb (struct tray_menu *item)
	Callback for restarting Sunshine from the system tray.
void	update_tray_pausing (std::string app_name)
	Sets the tray icon in pausing mode (stream stopped but app running) and spawns the appropriate notification.
void	update_tray_playing (std::string app_name)
	Sets the tray icon in playing mode and spawns the appropriate notification.
void	update_tray_require_pin ()
	Spawns a notification for PIN Pairing. Clicking it opens the PIN Web UI Page.
void	update_tray_stopped (std::string app_name)
	Sets the tray icon in stopped mode (app and stream stopped) and spawns the appropriate notification.

Detailed Description

Handles the system tray icon and notification system.

Function Documentation

end_tray()

int system_tray::end_tray

(

)

Exit the system tray.

Returns

0 after exiting the system tray.

run_tray()

int system_tray::run_tray

(

)

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.

system_tray()

int system_tray::system_tray

(

)

Create the system tray.

This function has an endless loop, so it should be run in a separate thread.

Returns

1 if the system tray failed to create, otherwise 0 once the tray has been terminated.

tray_donate_github_cb()

void system_tray::tray_donate_github_cb

(

struct tray_menu *

item

)

Callback for opening GitHub Sponsors from the system tray.

Parameters

item	The tray menu item.

tray_donate_patreon_cb()

void system_tray::tray_donate_patreon_cb

(

struct tray_menu *

item

)

Callback for opening Patreon from the system tray.

Parameters

item	The tray menu item.

tray_donate_paypal_cb()

void system_tray::tray_donate_paypal_cb

(

struct tray_menu *

item

)

Callback for opening PayPal donation from the system tray.

Parameters

item	The tray menu item.

tray_open_ui_cb()

void system_tray::tray_open_ui_cb

(

struct tray_menu *

item

)

Callback for opening the UI from the system tray.

Parameters

item	The tray menu item.

tray_quit_cb()

void system_tray::tray_quit_cb

(

struct tray_menu *

item

)

Callback for exiting Sunshine from the system tray.

Parameters

item	The tray menu item.

tray_reset_display_device_config_cb()

void system_tray::tray_reset_display_device_config_cb

(

struct tray_menu *

item

)

Callback for resetting display device configuration.

Parameters

item	The tray menu item.

tray_restart_cb()

void system_tray::tray_restart_cb

(

struct tray_menu *

item

)

Callback for restarting Sunshine from the system tray.

Parameters

item	The tray menu item.

update_tray_pausing()

void system_tray::update_tray_pausing

(

std::string

app_name

)

Sets the tray icon in pausing mode (stream stopped but app running) and spawns the appropriate notification.

Parameters

app_name

The paused application name

update_tray_playing()

void system_tray::update_tray_playing

(

std::string

app_name

)

Sets the tray icon in playing mode and spawns the appropriate notification.

Parameters

app_name

The started application name

update_tray_stopped()

void system_tray::update_tray_stopped

(

std::string

app_name

)

Sets the tray icon in stopped mode (app and stream stopped) and spawns the appropriate notification.

Parameters

app_name

The started application name