ado_mixer_element_sw1()

Create a switch (type 1) element

Synopsis:

#include <audio_driver.h>

ado_mixer_delement_t *ado_mixer_element_sw1 (
    ado_mixer_t *mixer,
    char *name,
    uint32_t number_of_switches,
    ado_mixer_delement_control_sw1_t *control,
    void *instance_data,
    void (*instance_free) (void *data) );

Arguments:

mixer

A pointer to the ado_mixer_t structure that specifies the mixer to create the element in. This structure was created by ado_mixer_create().

name

The name of the element. Elements are referred to by name, so be careful; for some standard names, see <asound.h>.

number_of_switches

The number of individual switches in the element. There's usually one switch for each voice of the stream passing through the element.

control

A callback function, of type ado_mixer_delement_control_sw1_t, that sets the state of the switches.

The prototype is:

int32_t control(
           MIXER_CONTEXT_T *context,
           ado_mixer_delement_t *element,
           uint8_t set,
           uint32_t *bitmap,
           void *instance_data );
  

instance_data

A pointer to any instance data that you need to pass to the control callback. This can be a pointer to allocated memory, in which case you'll need to define the instance_free function.

If you need to access this instance data, you have to call ado_mixer_get_element_instance_data() because ado_mixer_delement_t is an opaque data type.

instance_free

A function that must free any allocated instance data. It's called when the element is destroyed.

Description:

The ado_mixer_element_sw1() convenience function automates the creation of a switch (type 1) element. A switch type 1 element represents a switch with a single input and output that can be open or closed by a single control.

Returns:

A pointer to the newly allocated switch (type 1) element.

Classification:

QNX Neutrino

See also:

ado_mixer_create(), ado_mixer_element_sw2(), ado_mixer_element_sw3(), ado_mixer_get_element_instance_data()