vx_evt_aux_audio_properties
Learn about audio management.
Read time 3 minutesLast updated 8 months ago
Module: Audio Devices
Used by the SDK sound system to present audio information to the application, which can be used to create a visual representation of the speaker (for example, a "VU" meter). More...
#include <VxcEvents.h>Public Attributes
Name | |
|---|---|
| vx_evt_base_t | base The common properties for all events. |
| vx_aux_audio_properties_state | state |
| int | mic_is_active A flag used to determine whether the mic is active. |
| int | mic_volume Indicates the current value of the master microphone volume, which is set by using the "set mic volume" method. |
| double | mic_energy The instantaneous (fast) energy at the capture device. |
| int | speaker_volume Indicates the current value of the master speaker volume, which is set by using the "set speaker volume" method. |
| double | speaker_energy The energy associated with any rendered audio. |
| int | speaker_is_active Indicates whether voice is detected in the rendered audio stream at this moment. |
| double | fast_energy_meter The instantaneous (fast) energy at the capture device. |
| double | noise_floor_meter The current noise floor estimate. |
| double | speech_threshold_meter The current magnitude that "fast energy" must surpass to activate speech. |
Detailed Description
struct vx_evt_aux_audio_properties;
Used by the SDK sound system to present audio information to the application, which can be used to create a visual representation of the speaker (for example, a "VU" meter).
These events are presented at one half the rate of the audio capture rate.
Public Attributes Documentation
variable base
vx_evt_base_t base;
The common properties for all events.
variable state
vx_aux_audio_properties_state state;
Deprecated:
This is deprecated and should not be used.
variable mic_is_active
int mic_is_active;
A flag used to determine whether the mic is active.
- 1 indicates that the capture device is detecting speech activity (as determined by the built-in Vivox Voice Activity Detector).
- 0 indicates that no speech energy has been detected.
variable mic_volume
int mic_volume;
Indicates the current value of the master microphone volume, which is set by using the "set mic volume" method.
This is a non-negative integer value between 0 and 100 (inclusive).
variable mic_energy
double mic_energy;
The instantaneous (fast) energy at the capture device.
Note: For an unsmoothed dBFS value of fast energy, see fast_energy_meter and its companion *_meter values.
This is a value from 0.0 to 1.0, which when graphed, show behavior similar to an analog VU Meter.
variable speaker_volume
int speaker_volume;
Indicates the current value of the master speaker volume, which is set by using the "set speaker volume" method.
This is a non-negative integer value between 0 and 100 (inclusive).
variable speaker_energy
double speaker_energy;
The energy associated with any rendered audio.
variable speaker_is_active
int speaker_is_active;
Indicates whether voice is detected in the rendered audio stream at this moment.
variable fast_energy_meter
double fast_energy_meter;
The instantaneous (fast) energy at the capture device.
This is a floating point number between 0 and 1, which is logarithmically spaced representing -Inf dBFS to +0dBFS.
variable noise_floor_meter
double noise_floor_meter;
The current noise floor estimate.
This is a floating point number between 0 and 1, which is logarithmically spaced representing -Inf dBFS to +0dBFS.
variable speech_threshold_meter
double speech_threshold_meter;
The current magnitude that "fast energy" must surpass to activate speech.
This ranges between noise_floor and -9dBFS. This is a floating point number between 0 and 1, which is logarithmically spaced representing -Inf dBFS to +0dBFS.