EvmuBuzzer Struct Reference

#include <evmu_buzzer.h>

Inheritance diagram for EvmuBuzzer:

Data Fields
union {
EvmuBuzzerClass *   pClass
EvmuPeripheral   base
};
GblBool	pcmChanged
GblBool	enableFreqResp
Data Fields inherited from EvmuPeripheral
union {
EvmuPeripheralClass *   pClass
GblObject   base
};
GblFlags	logLevel
Data Fields inherited from GblObject
GblObjectClass *	pClass
GblBox	base
Data Fields inherited from GblBox
GblBoxClass *	pClass
GblInstance	base
GblArrayMap *	pFields
volatile uint16_t	refCounter
uint16_t	contextType
uint16_t	constructedInPlace
uint16_t	derivedFlags
Data Fields inherited from GblInstance
GblClass *	pClass

Related Symbols
(Note that these are not member symbols.)
Configuration
Methods for managing buzzer configuration
GblBool	EvmuBuzzer_isActive (const EvmuBuzzer *pSelf)
GblBool	EvmuBuzzer_isConfigured (const EvmuBuzzer *pSelf)
GblBool	EvmuBuzzer_isEnabled (const EvmuBuzzer *pSelf)
void	EvmuBuzzer_setEnabled (EvmuBuzzer *pSelf, GblBool en)
Tone Playback
Methods for managing tone generation and playback
void	EvmuBuzzer_tone (const EvmuBuzzer *pSelf, uint16_t *pPeriod, uint8_t *pInvPulseLen)
EVMU_RESULT	EvmuBuzzer_setTone (EvmuBuzzer *pSelf, uint16_t period, uint8_t invPulseLen)
EVMU_RESULT	EvmuBuzzer_playTone (EvmuBuzzer *pSelf)
EVMU_RESULT	EvmuBuzzer_stopTone (EvmuBuzzer *pSelf)
PCM Back-End
Methods used to implement an audio driver back-end
const void *	EvmuBuzzer_pcmBuffer (const EvmuBuzzer *pSelf)
size_t	EvmuBuzzer_pcmSamples (const EvmuBuzzer *pSelf)
size_t	EvmuBuzzer_pcmFrequency (const EvmuBuzzer *pSelf)
float	EvmuBuzzer_pcmGain (const EvmuBuzzer *pSelf)
Related Symbols inherited from EvmuPeripheral
EvmuDevice *	EvmuPeripheral_device (const EvmuPeripheral *pSelf)

Additional Inherited Members
Public Member Functions inherited from GblObject
GblContext *	GblObject_findContext (GblObject *pSelf)
GBL_RESULT	GblObject_property (const GblObject *pSelf, const char *pName,...)
GBL_RESULT	GblObject_propertyByQuark (const GblObject *pSelf, GblQuark name,...)
GBL_RESULT	GblObject_propertyVaList (const GblObject *pSelf, const char *pName, va_list *pList)
GBL_RESULT	GblObject_propertyVaListByQuark (const GblObject *pSelf, GblQuark name, va_list *pList)
GBL_RESULT	GblObject_propertyVariant (const GblObject *pSelf, const char *pName, GblVariant *pValue)
GBL_RESULT	GblObject_propertyVariantByQuark (const GblObject *pSelf, GblQuark name, GblVariant *pValue)
GBL_RESULT	GblObject_properties (const GblObject *pSelf,...)
GBL_RESULT	GblObject_propertiesVaList (const GblObject *pSelf, va_list *pList)
GBL_RESULT	GblObject_propertiesVariants (const GblObject *pSelf, size_t count, const char *pNames[], GblVariant *pValue)
GBL_RESULT	GblObject_setProperty (GblObject *pSelf, const char *pName,...)
GBL_RESULT	GblObject_setPropertyByQuark (GblObject *pSelf, GblQuark quark,...)
GBL_RESULT	GblObject_setPropertyVaList (GblObject *pSelf, const char *pName, va_list *pList)
GBL_RESULT	GblObject_setPropertyVaListByQuark (GblObject *pSelf, GblQuark name, va_list *pList)
GBL_RESULT	GblObject_setPropertyVariant (GblObject *pSelf, const char *pName, GblVariant *pValue)
GBL_RESULT	GblObject_setPropertyVariantByQuark (GblObject *pSelf, GblQuark name, GblVariant *pValue)
GBL_RESULT	GblObject_setProperties (GblObject *pSelf,...)
GBL_RESULT	GblObject_setPropertiesVaList (GblObject *pSelf, va_list *pList)
GBL_RESULT	GblObject_setPropertiesVariants (GblObject *pSelf, size_t count, const char *pNames[], GblVariant *pValue)
const GblStringRef *	GblObject_name (const GblObject *pSelf)
void	GblObject_setName (GblObject *pSelf, const char *pName)
void	GblObject_setNameRef (GblObject *pSelf, const GblStringRef *pRef)
GblObject *	GblObject_parent (const GblObject *pSelf)
void	GblObject_setParent (GblObject *pSelf, GblObject *pParent)
void	GblObject_addChild (GblObject *pSelf, GblObject *pChild)
GblBool	GblObject_removeChild (GblObject *pSelf, GblObject *pChild)
size_t	GblObject_depth (const GblObject *pSelf)
GblObject *	GblObject_childFirst (const GblObject *pSelf)
size_t	GblObject_childCount (const GblObject *pSelf)
GblObject *	GblObject_siblingNext (const GblObject *pSelf)
GblObject *	GblObject_findAncestorByType (const GblObject *pSelf, GblType ancestorType)
GblObject *	GblObject_findAncestorByName (const GblObject *pSelf, const char *pName)
GblObject *	GblObject_findAncestorByHeight (const GblObject *pSelf, size_t height)
GblObject *	GblObject_findBaseByDepth (const GblObject *pSelf, size_t depth)
GblObject *	GblObject_findChildByType (const GblObject *pSelf, GblType childType)
GblObject *	GblObject_findChildByName (const GblObject *pSelf, const char *pName)
GblObject *	GblObject_findChildByIndex (const GblObject *pSelf, size_t index)
GblObject *	GblObject_findSiblingByType (const GblObject *pSelf, GblType siblingType)
GblObject *	GblObject_findSiblingByName (const GblObject *pSelf, const char *pName)
GblObject *	GblObject_findSiblingByIndex (const GblObject *pSelf, size_t index)
GBL_RESULT	GblObject_sendEvent (GblObject *pSelf, GblEvent *pEvent)
GBL_RESULT	GblObject_notifyEvent (GblObject *pSelf, GblEvent *pEvent)
GBL_RESULT	GblObject_installEventFilter (GblObject *pSelf, GblIEventFilter *pFilter)
GBL_RESULT	GblObject_uninstallEventFilter (GblObject *pSelf, GblIEventFilter *pFilter)
size_t	GblObject_eventFilterCount (const GblObject *pSelf)
GblIEventFilter *	GblObject_eventFilter (const GblObject *pSelf, size_t index)
GBL_RESULT	GblObject_property (const GblObject *pSelf, const char *pName,...)
GBL_RESULT	GblObject_propertyByQuark (const GblObject *pSelf, GblQuark name,...)
GBL_RESULT	GblObject_propertyVaList (const GblObject *pSelf, const char *pName, va_list *pList)
GBL_RESULT	GblObject_propertyVaListByQuark (const GblObject *pSelf, GblQuark name, va_list *pList)
GBL_RESULT	GblObject_propertyVariant (const GblObject *pSelf, const char *pName, GblVariant *pValue)
GBL_RESULT	GblObject_propertyVariantByQuark (const GblObject *pSelf, GblQuark name, GblVariant *pValue)
GBL_RESULT	GblObject_properties (const GblObject *pSelf,...)
GBL_RESULT	GblObject_propertiesVaList (const GblObject *pSelf, va_list *pList)
GBL_RESULT	GblObject_propertiesVariants (const GblObject *pSelf, size_t count, const char *pNames[], GblVariant *pValue)
GBL_RESULT	GblObject_setProperty (GblObject *pSelf, const char *pName,...)
GBL_RESULT	GblObject_setPropertyByQuark (GblObject *pSelf, GblQuark quark,...)
GBL_RESULT	GblObject_setPropertyVaList (GblObject *pSelf, const char *pName, va_list *pList)
GBL_RESULT	GblObject_setPropertyVaListByQuark (GblObject *pSelf, GblQuark name, va_list *pList)
GBL_RESULT	GblObject_setPropertyVariant (GblObject *pSelf, const char *pName, GblVariant *pValue)
GBL_RESULT	GblObject_setPropertyVariantByQuark (GblObject *pSelf, GblQuark name, GblVariant *pValue)
GBL_RESULT	GblObject_setProperties (GblObject *pSelf,...)
GBL_RESULT	GblObject_setPropertiesVaList (GblObject *pSelf, va_list *pList)
GBL_RESULT	GblObject_setPropertiesVariants (GblObject *pSelf, size_t count, const char *pNames[], GblVariant *pValue)
const GblStringRef *	GblObject_name (const GblObject *pSelf)
void	GblObject_setName (GblObject *pSelf, const char *pName)
void	GblObject_setNameRef (GblObject *pSelf, const GblStringRef *pRef)
GblObject *	GblObject_parent (const GblObject *pSelf)
void	GblObject_setParent (GblObject *pSelf, GblObject *pParent)
void	GblObject_addChild (GblObject *pSelf, GblObject *pChild)
GblBool	GblObject_removeChild (GblObject *pSelf, GblObject *pChild)
size_t	GblObject_depth (const GblObject *pSelf)
GblObject *	GblObject_childFirst (const GblObject *pSelf)
size_t	GblObject_childCount (const GblObject *pSelf)
GblObject *	GblObject_siblingNext (const GblObject *pSelf)
GblObject *	GblObject_findAncestorByType (const GblObject *pSelf, GblType ancestorType)
GblObject *	GblObject_findAncestorByName (const GblObject *pSelf, const char *pName)
GblObject *	GblObject_findAncestorByHeight (const GblObject *pSelf, size_t height)
GblObject *	GblObject_findBaseByDepth (const GblObject *pSelf, size_t depth)
GblObject *	GblObject_findChildByType (const GblObject *pSelf, GblType childType)
GblObject *	GblObject_findChildByName (const GblObject *pSelf, const char *pName)
GblObject *	GblObject_findChildByIndex (const GblObject *pSelf, size_t index)
GblObject *	GblObject_findSiblingByType (const GblObject *pSelf, GblType siblingType)
GblObject *	GblObject_findSiblingByName (const GblObject *pSelf, const char *pName)
GblObject *	GblObject_findSiblingByIndex (const GblObject *pSelf, size_t index)
GBL_RESULT	GblObject_sendEvent (GblObject *pSelf, GblEvent *pEvent)
GBL_RESULT	GblObject_notifyEvent (GblObject *pSelf, GblEvent *pEvent)
GBL_RESULT	GblObject_installEventFilter (GblObject *pSelf, GblIEventFilter *pFilter)
GBL_RESULT	GblObject_uninstallEventFilter (GblObject *pSelf, GblIEventFilter *pFilter)
size_t	GblObject_eventFilterCount (const GblObject *pSelf)
GblIEventFilter *	GblObject_eventFilter (const GblObject *pSelf, size_t index)
Public Member Functions inherited from GblBox
GblBox *	GblBox_ref (GblBox *pSelf)
GblRefCount	GblBox_unref (GblBox *pSelf)
GblRefCount	GblBox_refCount (const GblBox *pSelf)
void *	GblBox_userdata (const GblBox *pSelf)
GBL_RESULT	GblBox_setUserdata (GblBox *pSelf, void *pUserdata)
GBL_RESULT	GblBox_setUserDestructor (GblBox *pSelf, GblArrayMapDtorFn pFnUdDtor)
uintptr_t	GblBox_field (const GblBox *pSelf, GblQuark key)
uintptr_t	GblBox_takeField (GblBox *pSelf, GblQuark key)
GblBool	GblBox_clearField (GblBox *pSelf, GblQuark key)
GblBool	GblBox_hasField (const GblBox *pSelf, GblQuark key)
GBL_RESULT	GblBox_setField (GblBox *pSelf, GblQuark key, uintptr_t ud, GblArrayMapDtorFn pFnDtor)
GblBox *	GblBox_ref (GblBox *pSelf)
GblRefCount	GblBox_unref (GblBox *pSelf)
GblRefCount	GblBox_refCount (const GblBox *pSelf)
void *	GblBox_userdata (const GblBox *pSelf)
GBL_RESULT	GblBox_setUserdata (GblBox *pSelf, void *pUserdata)
GBL_RESULT	GblBox_setUserDestructor (GblBox *pSelf, GblArrayMapDtorFn pFnUdDtor)
uintptr_t	GblBox_field (const GblBox *pSelf, GblQuark key)
uintptr_t	GblBox_takeField (GblBox *pSelf, GblQuark key)
GblBool	GblBox_clearField (GblBox *pSelf, GblQuark key)
GblBool	GblBox_hasField (const GblBox *pSelf, GblQuark key)
GBL_RESULT	GblBox_setField (GblBox *pSelf, GblQuark key, uintptr_t ud, GblArrayMapDtorFn pFnDtor)
Public Member Functions inherited from GblInstance
GblRefCount	GblInstance_destroy (GblInstance *pSelf)
GblBool	GblInstance_check (const GblInstance *pSelf, GblType toType)
GblInstance *	GblInstance_cast (GblInstance *pSelf, GblType toType)
GblInstance *	GblInstance_as (GblInstance *pSelf, GblType toType)
void *	GblInstance_private (const GblInstance *pSelf, GblType base)
GblInstance *	GblInstance_public (const void *pPriv, GblType base)
GblType	GblInstance_typeOf (const GblInstance *pSelf)
size_t	GblInstance_size (const GblInstance *pSelf)
size_t	GblInstance_privateSize (const GblInstance *pSelf)
size_t	GblInstance_totalSize (const GblInstance *pSelf)
GblClass *	GblInstance_class (const GblInstance *pSelf)
GBL_RESULT	GblInstance_swizzleClass (GblInstance *pSelf, GblClass *pClass)
GBL_RESULT	GblInstance_sinkClass (GblInstance *pSelf)
GBL_RESULT	GblInstance_floatClass (GblInstance *pSelf)
GblBool	GblInstance_check (const GblInstance *pSelf, GblType toType)
GblInstance *	GblInstance_cast (GblInstance *pSelf, GblType toType)
GblInstance *	GblInstance_as (GblInstance *pSelf, GblType toType)
void *	GblInstance_private (const GblInstance *pSelf, GblType base)
GblInstance *	GblInstance_public (const void *pPriv, GblType base)
GblType	GblInstance_typeOf (const GblInstance *pSelf)
size_t	GblInstance_size (const GblInstance *pSelf)
size_t	GblInstance_privateSize (const GblInstance *pSelf)
size_t	GblInstance_totalSize (const GblInstance *pSelf)
GblClass *	GblInstance_class (const GblInstance *pSelf)
GBL_RESULT	GblInstance_swizzleClass (GblInstance *pSelf, GblClass *pClass)
GBL_RESULT	GblInstance_sinkClass (GblInstance *pSelf)
GBL_RESULT	GblInstance_floatClass (GblInstance *pSelf)

Detailed Description

Instance structure for Buzzer Peripheral.

EvmuBuzzer is the GblInstance structure representing the piezoelectric buzzer peripheral and associated logic.

See also

EvmuBuzzerClass

Definition at line 84 of file evmu_buzzer.h.

Friends And Related Symbol Documentation

EvmuBuzzer_isActive()

GblBool EvmuBuzzer_isActive ( const EvmuBuzzer *  pSelf )

related

Returns whether playback is active or not.

EvmuBuzzer_isConfigured()

GblBool EvmuBuzzer_isConfigured ( const EvmuBuzzer *  pSelf )

related

Returns whether the buzzer has been configured for playback.

EvmuBuzzer_isEnabled()

GblBool EvmuBuzzer_isEnabled ( const EvmuBuzzer *  pSelf )

related

Returns whether software has enabled or disabled the buzzer.

EvmuBuzzer_pcmBuffer()

const void * EvmuBuzzer_pcmBuffer ( const EvmuBuzzer *  pSelf )

related

Returns the current PCM buffer to the audio driver.

EvmuBuzzer_pcmFrequency()

size_t EvmuBuzzer_pcmFrequency ( const EvmuBuzzer *  pSelf )

related

Returns the PCM buffer's sample frequency to the audio driver.

EvmuBuzzer_pcmGain()

float EvmuBuzzer_pcmGain ( const EvmuBuzzer *  pSelf )

related

Returns the PCM buffer's gain to the audio driver.

EvmuBuzzer_pcmSamples()

size_t EvmuBuzzer_pcmSamples ( const EvmuBuzzer *  pSelf )

related

Returns the PCM buffer's sample size to the audio driver.

EvmuBuzzer_playTone()

EVMU_RESULT EvmuBuzzer_playTone ( EvmuBuzzer *  pSelf )

related

Plays the current tone's square wave.

EvmuBuzzer_setEnabled()

void EvmuBuzzer_setEnabled ( EvmuBuzzer *  pSelf, GblBool  en  )

related

Allows software to enable or disable buzzer emulation.

EvmuBuzzer_setTone()

EVMU_RESULT EvmuBuzzer_setTone ( EvmuBuzzer *  pSelf, uint16_t  period, uint8_t  invPulseLen  )

related

Sets the square wave of the current tone without impacting playback.

EvmuBuzzer_stopTone()

EVMU_RESULT EvmuBuzzer_stopTone ( EvmuBuzzer *  pSelf )

related

Stops playback of the current tone.

EvmuBuzzer_tone()

void EvmuBuzzer_tone ( const EvmuBuzzer *  pSelf, uint16_t *  pPeriod, uint8_t *  pInvPulseLen  )

related

Returns the current tone's square wave.

Field Documentation

base

EvmuPeripheral EvmuBuzzer::base

Inherited base instance structure.

Definition at line 84 of file evmu_buzzer.h.

enableFreqResp

GblBool EvmuBuzzer::enableFreqResp

Enables per-tone gain/volume emulation.

Definition at line 86 of file evmu_buzzer.h.

pClass

EvmuBuzzerClass* EvmuBuzzer::pClass

Pointer to class/vtable structure.

Definition at line 84 of file evmu_buzzer.h.

pcmChanged

GblBool EvmuBuzzer::pcmChanged

User-toggle for polling updates.

Definition at line 85 of file evmu_buzzer.h.

---

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

• evmu_buzzer.h