snd_pcm_mute_event_t

Updated: April 19, 2023

Information about the mute event

Synopsis:

typedef struct snd_pcm_mute_event
{
	uint8_t  mute;
	uint8_t  reason;
#define SND_PCM_MUTE_EVENT_SAME_PRIORITY     1
#define SND_PCM_MUTE_EVENT_HIGHER_PRIORITY   2
	uint8_t  zero[2];
} snd_pcm_mute_event_t;

Description:

The snd_pcm_mute_event structure is delivered whenever a channel is ducked to or unducked from zero and preemption isn't enabled. You can use this structure to get information to determine if you were ducked because a higher or same priority audio stream played.

The members include:

mute
The event indicates whether the channel was muted. A value of 1 specifies that the channel was muted; otherwise the channel was unmuted.
reason
A value of SND_PCM_MUTE_EVENT_SAME_PRIORITY specifies the audio type that caused the channel to mute is the same priority. A value of SND_PCM_MUTE_EVENT_HIGHER_PRIORITY specifies that the channel was ducked because the audio type was a higher priority.

Classification:

QNX Neutrino