Symbol.Audio

Symbol.Audio version class.

Version class constructor.

The Audio.Device object to obtain version information from.

Version of the Symbol Audio native API.

The Notify C API version. Returns 0 on some devices.

Version of the Assembly.

The SimulatedAudio class can be used to program Symbol audio drivers on standard emulators provided by Microsoft.

The SimulatedAudio class does not call the underlying Symbol Audio 'C' API. Instead calls to Win32 audio functions are made. These calls mimic the functionality of the Symbol specific functionality. Audio settings for simulation are obtained and set in registry (HKLM\Software\Symbol\Audio\Settings).

Audio Controller class provides access to controllable audio features.

The Audio Controller class is the common base class for derived classes such as and . These derived classes should be used to construct Audio objects.

Controller class constructor with settable device object.

A device object that contains information about which audio device to control.

Allows a Controller to attempt to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Frees up all resources used by the Controller, including any objects it has created. It is strongly recommended that this method be called when the Controller is no longer needed by the application.

Gets the next AudioStatus object from the audio status event queue.

The GetNextStatus method is most commonly called by methods that have been invoked via the ChangeNotify event. This method provides access to the AudioStatus object that contains information about the audio event that has occured. A object with audio event information.

Play a .wav file.

A string that contains the absolute path and name of the .wav file.

Play tone on the beeper if present or the given .wav file.

Beep duration (in milliseconds). Frequency in Hertz The name of the .wav file including its absolute path.

Play tone on the beeper if it is present.

Beep duration (in milliseconds). Frequency in Hertz

Internal method called by MessageWindow class to notify UI thread of read.

A System.EventArgs object

Returns a friendly name for the class.

A string that contains "AudioController".

Returns a friendly name for the class.

A string that contains "AudioController".

Returns the number of BeeperVolumeLevels for the audio hardware.

The application can set the level between 0 and the maximum number of supported levels, minus 1 for . Note: Not all Symbol mobile devices provide a beeper. An Integer value that contains the number of volume levels for the audio hardware.

Controls the volume of sounds played through the beeper.

For those products that support both a speaker and a beeper, or only a beeper, the beeper volume controls the volume of the beeper. The application can set the level between 0 and the maximum number of supported beeper volume levels less one. Any values outside this range will result in Symbol.Exception.InvalidUsageException("Negative values are not allowed...") being thrown. An Integer that defines the volume level.

Controls the time delay between playing sounds at the normal sound levels and special higher settings.

For those products that support only a speaker (as opposed to a speaker and a beeper), a special speaker volume setting is provided specifically for the purpose of playing back a very audible Decode Beep through the speaker. The value of EarSaveDelay is that amount of time after a sound is played at the normal volume setting, until the special Higher volume settings are allowed. Only positive integer values are accepted. Any negative/invalid values provided will result in Symbol.Exception.InvalidUsageException("Negative values are not allowed...") being thrown. An Integer that specified in seconds the time between playing sounds at the normal level and the special higher settings.

Provides access to version information.

A object.

Attach to this notification event to be called back when a audio event occurs.

A delegate of the method that will be invoked when a audio event occurs.

SimulatedAudio constructor with settable Audio.Device.

If the Audio.Device object passed to this contructor does not represent an AudioType.SimulatedAudio device, then an Symbol.Exceptions.InvalidDataTypeException will be thrown. An Audio.Device object that targets a SimulatedAudio device.

Gets the next AudioStatus object from the audio status event queue.

Returns the number of BeeperVolumeLevels for the audio hardware.

For SimulatedAudio the value is retrieved and set in the registry. An Integer value that contains the number of volume levels for the audio hardware.

Controls the volume of sounds played through the beeper.

For SimulatedAudio the value is retrieved and set in the registry. No actual change in volume takes place. The application can set the level between 0 and the maximum number of supported beeper volume levels less one. Any values outside this range will result in Symbol.Exception.InvalidUsageException("Negative values are not allowed...") being thrown. An Integer that defines the volume level.

Controls the time delay between playing sounds at the normal sound levels and special higher settings.

For SimulatedAudio the value is retrieved and set in the registry. No actual change in EarSaveDelay takes place. Only positive integer values are accepted. Any negative/invalid values provided will result in Symbol.Exception.InvalidUsageException("Negative values are not allowed...") being thrown. An Integer that specified in seconds the time between playing sounds at the normal level and the special higher settings.

Provides access to version information.

A object.

Types of audio devices.

A standard audio device. Commonly found in most Symbol mobile devices.

A simulated audio device. Commonly used on stock emulators that do not provide Symbol specific audio APIs.

The Symbol.Audio.Device class provides information about all the available audio devices in the system.

The Symbol.Audio.Device class provides an excellent starting point for applications that wish to gain more information about the available audio devices. The AvailableDevices property provides a static Device array with each entry mapping to available audio hardware. Each entry can be used to contruct an object based on the audio type information. Ex: An AudioType.StandardAudio type device object is used to construct an Audio.StandardAudio object.

Device class constructor with settable device name, friendly name, and AudioType. Device constructors are not normally called by the user. Selecting a Device reference by using Device.AvailableDevices is preferred instead.

An Audio.Device object will be contructed with the given Device Name and Friendly Name. The AudioType specifies the type of hardware is targeted. The name of the device (should be either "AUDIOAPI32" for standard audio or "SIMULATE" for simulated audio). A friendly name for the device. Can be any string. An AudioType value that specifies the type of audio hardware.

Returns the type of audio device.

This information is used by applications to determine which Audio object can be contructed. An AudioType value that specifies what type of device is being targeted.

The AvailableDevices property can be used to obtain a list of all available hardware for use with the audio classes.

The AvailableDevices property provides a static Device array with each entry mapping to available audio hardware. Each entry can be used to contruct an object based on the audio type information. Ex: An AudioType.StandardAudio type device object is used to construct an Audio.StandardAudio object. A array that represents all available audio hardware.

Defines the events that can be fired by the Audio classes.

Audio Beeper volume has changed.

Audio ear save delay has changed.

Defines the types of events for the Audio classes.

The state of the Audio driver has changed.

An error occured during event processing.

The AudioStatus class provides access to notification information.

The AudioStatus class is normally obtained from the StandardAudio.GetNextStatus method. The GetNextStatus() method is usually called when a ChangeNotify event has been fired and your event processing method (EventHandler) has been invoked. During your event processing the AudioStatus object is obtained so that information about the status change can be retrieved.

The AudioStatus constructor is not normally called by the developer.

An EventTypes enumerated type that defines the type of event that has occurred. A ChangeType enumerated type that defines what changed in the audio driver.

Retrieves the Audio event type.

An EventTypes member that defines the type of event that has occured.

Retrieves the Audio driver change.

A ChangeType member that defines what changed in the audio driver.

The StandardAudio class provides access to controllable audio features on Symbol mobile devices.

The StandardAudio class is the primary class for Audio class library and should be used to access and control the audio functionality on Symbol mobile devices. Unlike the SimulatedAudio device, calls the underlying audio drivers will be made when methods and properties are accessed within this class.

StandardAudio constructor with settable Audio.Device.

If the Audio.Device object passed to this contructor does not represent an AudioType.StandardAudio device, then a Symbol.Exceptions.InvalidDataTypeException will be thrown. An Audio.Device object that targets a StandardAudio device.

Gets the next AudioStatus object from the audio status event queue.

On products that support a real beeper, the frequency and duration generate the sound. On products that do not support a real beeper, the wav file is played through the speaker at the current beeper volume. On products that support both a speaker and real beeper, the wavfile is played through the speaker, and the sound with a specified frequency and duration is generated through the real beeper. NOTE: If multiple beeps are played it is possible that you may miss some of the beeps on older devices such as MC9060. The method may also throw an OperationFailureException with errorcode E_AUD_BUSYMUTEX on these devices. However, this behavior is not observed on the newer devices such as MC9500 and MC75A.

Beep duration (in milliseconds). Frequency in Hertz The name of the .wav file including its absolute path.

Play tone on the beeper if it is present. NOTE: If multiple beeps are played it is possible that you may miss some of the beeps on older devices such as MC9060. The method may also throw an OperationFailureException with errorcode E_AUD_BUSYMUTEX on these devices. However, this behavior is not observed on the newer devices such as MC9500 and MC75A.

Beep duration (in milliseconds). Frequency in Hertz

Returns the number of BeeperVolumeLevels for the audio hardware.

Controls the volume of sounds played through the beeper.

Controls the time delay between playing sounds at the normal sound levels and special higher settings.

Provides access to version information.

A object.

The AUDIO_INFO structure defines the wav file name and/or beep parameters for the AUDIO_PlayBeeper function.

Name of .wav file.

Beep duration (in milliseconds).

Frequency (in Hz).

The AUDIO_VERSION_INFO data type holds the version information for the audio driver and notify driver. It has a major and minor version stored in the HIWORD and LOWORD, respectively.

Sub-structure describing memory allocated and used by this structure.

The Notify C API version.

The C API version.

The STRUCT_INFO structure enables extensibility of API structures. A STRUCT_INFO structure is embedded in each structure of the API to describe the memory allocated and used by that structure. If the structure grows in future revisions of the API, the STRUCT_INFO information can be used to determine which fields are valid for use.

Size of the allocated structure, in bytes.

Amount of memory the structure actually uses, in bytes.