The primary interaction point for the Volume Control API.
See the VCAPI.Default property for more information.
More...

Collaboration diagram for VolumeControl.SDK.VCAPI:

Public Member Functions
void	ShowSessionListNotification ()
	Display the SessionListNotification window. More...

void	ShowDeviceListNotification ()
	Display the DeviceListNotification window. More...

void	ShowMixer ()
	Display the Mixer window. More...

Properties
static VCAPI	Default = null! `[get, set]`
	This is the default instance of VCAPI. You must use this to access the API. More...

static AsyncLogWriter	Log `[get]`
	This is the default log instance. More...

AudioDeviceManager	AudioDeviceManager `[get]`
	Gets the audio device manager object. More...

AudioDeviceSelector	AudioDeviceSelector `[get]`
	Gets the audio device selection manager object. More...

AudioSessionManager	AudioSessionManager `[get]`
	Gets the audio session manager object. More...

AudioSessionMultiSelector	AudioSessionMultiSelector `[get]`
	Gets the audio session selection manager object. More...

HotkeyManager	HotkeyManager `[get]`
	Gets the hotkey manager object. More...

IntPtr	MainWindowHWnd `[get]`
	Gets the handle of the main window. More...

Config	Settings `[get]`
	Gets the application settings object. More...

Detailed Description

The primary interaction point for the Volume Control API.
See the VCAPI.Default property for more information.

Have an idea for extending the Volume Control API? We'd love to hear it! Let us know with a Feature Request

, or by submitting a Pull Request

.

Member Function Documentation

◆ ShowDeviceListNotification()

void VolumeControl.SDK.VCAPI.ShowDeviceListNotification ( )

Display the DeviceListNotification window.

References VolumeControl.Core.Config.DeviceListNotificationConfig, VolumeControl.Core.NotificationConfigSection.Enabled, and VolumeControl.SDK.VCAPI.Settings.

◆ ShowMixer()

void VolumeControl.SDK.VCAPI.ShowMixer ( )

Display the Mixer window.

◆ ShowSessionListNotification()

void VolumeControl.SDK.VCAPI.ShowSessionListNotification ( )

Display the SessionListNotification window.

References VolumeControl.Core.NotificationConfigSection.Enabled, VolumeControl.Core.Config.SessionListNotificationConfig, and VolumeControl.SDK.VCAPI.Settings.

Property Documentation

◆ AudioDeviceManager

AudioDeviceManager VolumeControl.SDK.VCAPI.AudioDeviceManager

get

Gets the audio device manager object.

◆ AudioDeviceSelector

AudioDeviceSelector VolumeControl.SDK.VCAPI.AudioDeviceSelector

get

Gets the audio device selection manager object.

◆ AudioSessionManager

AudioSessionManager VolumeControl.SDK.VCAPI.AudioSessionManager

get

Gets the audio session manager object.

◆ AudioSessionMultiSelector

AudioSessionMultiSelector VolumeControl.SDK.VCAPI.AudioSessionMultiSelector

get

Gets the audio session selection manager object.

◆ Default

VCAPI VolumeControl.SDK.VCAPI.Default = null!

staticgetset

This is the default instance of VCAPI.
You must use this to access the API.

Referenced by VolumeControl.SDK.Internal.Initializer.Initialize().

◆ HotkeyManager

HotkeyManager VolumeControl.SDK.VCAPI.HotkeyManager

get

Gets the hotkey manager object.

◆ Log

AsyncLogWriter VolumeControl.SDK.VCAPI.Log

staticget

This is the default log instance.

◆ MainWindowHWnd

IntPtr VolumeControl.SDK.VCAPI.MainWindowHWnd

get

Gets the handle of the main window.

This is the handle of the main window, for use with Windows API methods in User32 or elsewhere.

◆ Settings

Config VolumeControl.SDK.VCAPI.Settings

get

Gets the application settings object.

This is the object that contains many of the runtime application settings.
These are saved to the user configuration when the application shuts down.

Referenced by VolumeControl.SDK.VCAPI.ShowDeviceListNotification(), and VolumeControl.SDK.VCAPI.ShowSessionListNotification().

The documentation for this class was generated from the following file:

/home/runner/work/volume-control/volume-control/VolumeControl.SDK/VCAPI.cs

Public Member Functions

Properties