Om  1.0.0
A universal framework for multimedia simulation
Public Attributes | List of all members
om::sound::devices::SoundDeviceManagerDelegate Class Reference

A class that contains function objects that recieve SoundDeviceManager events. More...

#include <omSoundDeviceManagerDelegate.h>

Public Attributes

Function< void(SoundDeviceManager &manager, const SoundDeviceID &deviceID)> deviceAdded
 A function object that is called whenever a new sound device is discovered by the system. More...
 
Function< void(SoundDeviceManager &manager, const SoundDeviceID &deviceID)> deviceRemoved
 A function object that is called whenever a sound device is removed from the system. More...
 

Detailed Description

A class that contains function objects that recieve SoundDeviceManager events.

Any device-manager-related event that might be processed has an appropriate callback function object. Each callback function is called by the device manager whenever such an event is received. If a callback function in the delegate is not initialized, the device manager simply ignores it.

Member Data Documentation

Function<void ( SoundDeviceManager& manager, const SoundDeviceID& deviceID )> om::sound::devices::SoundDeviceManagerDelegate::deviceAdded

A function object that is called whenever a new sound device is discovered by the system.

This callback is called whenever a new sound device is connected or added to the system. This allows the user to use new sound devices as they are discovered.

This method will be called from a separate thread so any data accessed in the callback function should use proper thread synchonization to avoid unsafe access.

Function<void ( SoundDeviceManager& manager, const SoundDeviceID& deviceID )> om::sound::devices::SoundDeviceManagerDelegate::deviceRemoved

A function object that is called whenever a sound device is removed from the system.

This callback is called whenever a sound device is disconnected or removed from the system. This allows the user to know when devices are disconnected and to discontinue use of those devices.

This method will be called from a separate thread so any data accessed in the callback function should use proper thread synchonization to avoid unsafe access.


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