GstMixer

typedef struct _GstMixer GstMixer;

enum GstMixerType

typedef enum
{
  GST_MIXER_HARDWARE,
  GST_MIXER_SOFTWARE
} GstMixerType;

enum GstMixerFlags

typedef enum
{
  GST_MIXER_FLAG_NONE                = 0,
  GST_MIXER_FLAG_AUTO_NOTIFICATIONS  = (1<<0),
  GST_MIXER_FLAG_HAS_WHITELIST       = (1<<1),
  GST_MIXER_FLAG_GROUPING            = (1<<2),
} GstMixerFlags;

Flags indicating which optional features are supported by a mixer implementation.

Since 0.10.14

enum GstMixerMessageType

typedef enum
{
  GST_MIXER_MESSAGE_INVALID,
  GST_MIXER_MESSAGE_MUTE_TOGGLED,
  GST_MIXER_MESSAGE_RECORD_TOGGLED,
  GST_MIXER_MESSAGE_VOLUME_CHANGED,
  GST_MIXER_MESSAGE_OPTION_CHANGED,
  GST_MIXER_MESSAGE_OPTIONS_LIST_CHANGED,
  GST_MIXER_MESSAGE_MIXER_CHANGED
} GstMixerMessageType;

An enumeration for the type of a GstMixer message received on the bus

Since 0.10.14

gst_mixer_list_tracks ()

const GList*        gst_mixer_list_tracks               (GstMixer *mixer);

Returns a list of available tracks for this mixer/element. Note that it is allowed for sink (output) elements to only provide the output tracks in this list. Likewise, for sources (inputs), it is allowed to only provide input elements in this list.

gst_mixer_get_volume ()

void                gst_mixer_get_volume                (GstMixer *mixer,
                                                         GstMixerTrack *track,
                                                         gint *volumes);

Get the current volume(s) on the given track.

gst_mixer_set_volume ()

void                gst_mixer_set_volume                (GstMixer *mixer,
                                                         GstMixerTrack *track,
                                                         gint *volumes);

Sets the volume on each channel in a track. Short note about naming: a track is defined as one separate stream owned by the mixer/element, such as 'Line-in' or 'Microphone'. A channel is said to be a mono-stream inside this track. A stereo track thus contains two channels.

gst_mixer_set_mute ()

void                gst_mixer_set_mute                  (GstMixer *mixer,
                                                         GstMixerTrack *track,
                                                         gboolean mute);

Mutes or unmutes the given channel. To find out whether a track is currently muted, use GST_MIXER_TRACK_HAS_FLAG().

gst_mixer_set_record ()

void                gst_mixer_set_record                (GstMixer *mixer,
                                                         GstMixerTrack *track,
                                                         gboolean record);

Enables or disables recording on the given track. Note that this is only possible on input tracks, not on output tracks (see GST_MIXER_TRACK_HAS_FLAG() and the GST_MIXER_TRACK_INPUT flag).

gst_mixer_set_option ()

void                gst_mixer_set_option                (GstMixer *mixer,
                                                         GstMixerOptions *opts,
                                                         gchar *value);

Sets a name/value option in the mixer to the requested value.

gst_mixer_mute_toggled ()

void                gst_mixer_mute_toggled              (GstMixer *mixer,
                                                         GstMixerTrack *track,
                                                         gboolean mute);

This function is called by the mixer implementation to produce a notification message on the bus indicating that the given track has changed mute state.

This function only works for GstElements that are implementing the GstMixer interface, and the element needs to have been provided a bus.

gst_mixer_record_toggled ()

void                gst_mixer_record_toggled            (GstMixer *mixer,
                                                         GstMixerTrack *track,
                                                         gboolean record);

This function is called by the mixer implementation to produce a notification message on the bus indicating that the given track has changed recording state.

This function only works for GstElements that are implementing the GstMixer interface, and the element needs to have been provided a bus.

gst_mixer_volume_changed ()

void                gst_mixer_volume_changed            (GstMixer *mixer,
                                                         GstMixerTrack *track,
                                                         gint *volumes);

This function is called by the mixer implementation to produce a notification message on the bus indicating that the volume(s) for the given track have changed.

This function only works for GstElements that are implementing the GstMixer interface, and the element needs to have been provided a bus.

gst_mixer_option_changed ()

void                gst_mixer_option_changed            (GstMixer *mixer,
                                                         GstMixerOptions *opts,
                                                         gchar *value);

This function is called by the mixer implementation to produce a notification message on the bus indicating that the given options object has changed state.

This function only works for GstElements that are implementing the GstMixer interface, and the element needs to have been provided a bus.

gst_mixer_options_list_changed ()

void                gst_mixer_options_list_changed      (GstMixer *mixer,
                                                         GstMixerOptions *opts);

This function is called by the mixer implementation to produce a notification message on the bus indicating that the list of possible options of a given options object has changed.

The new options are not contained in the message on purpose. Applications should call gst_mixer_option_get_values() on opts to make opts update its internal state and obtain the new list of values.

This function only works for GstElements that are implementing the GstMixer interface, and the element needs to have been provided a bus for this to work.

Since 0.10.18

gst_mixer_get_option ()

const gchar*        gst_mixer_get_option                (GstMixer *mixer,
                                                         GstMixerOptions *opts);

Get the current value of a name/value option in the mixer.

gst_mixer_mixer_changed ()

void                gst_mixer_mixer_changed             (GstMixer *mixer);

This function is called by the mixer implementation to produce a notification message on the bus indicating that the list of available mixer tracks for a given mixer object has changed. Applications should rebuild their interface when they receive this message.

This function only works for GstElements that are implementing the GstMixer interface, and the element needs to have been provided a bus.

Since 0.10.18

gst_mixer_get_mixer_flags ()

GstMixerFlags       gst_mixer_get_mixer_flags           (GstMixer *mixer);

Get the set of supported flags for this mixer implementation.

gst_mixer_get_mixer_type ()

GstMixerType        gst_mixer_get_mixer_type            (GstMixer *mixer);

Get the GstMixerType of this mixer implementation.

Since 0.10.24

gst_mixer_message_get_type ()

GstMixerMessageType gst_mixer_message_get_type          (GstMessage *message);

Check a bus message to see if it is a GstMixer notification message and return the GstMixerMessageType identifying which type of notification it is.

Since 0.10.14

gst_mixer_message_parse_mute_toggled ()

void                gst_mixer_message_parse_mute_toggled
                                                        (GstMessage *message,
                                                         GstMixerTrack **track,
                                                         gboolean *mute);

Extracts the contents of a mute-toggled bus message. Reads the GstMixerTrack that has changed, and the new value of the mute flag.

The GstMixerTrack remains valid until the message is freed.

Since 0.10.14

gst_mixer_message_parse_option_changed ()

void                gst_mixer_message_parse_option_changed
                                                        (GstMessage *message,
                                                         GstMixerOptions **options,
                                                         const gchar **value);

Extracts the GstMixerOptions and new value from a option-changed bus notification message.

The options and value returned remain valid until the message is freed.

Since 0.10.14

gst_mixer_message_parse_record_toggled ()

void                gst_mixer_message_parse_record_toggled
                                                        (GstMessage *message,
                                                         GstMixerTrack **track,
                                                         gboolean *record);

Extracts the contents of a record-toggled bus message. Reads the GstMixerTrack that has changed, and the new value of the recording flag.

The GstMixerTrack remains valid until the message is freed.

Since 0.10.14

gst_mixer_message_parse_volume_changed ()

void                gst_mixer_message_parse_volume_changed
                                                        (GstMessage *message,
                                                         GstMixerTrack **track,
                                                         gint **volumes,
                                                         gint *num_channels);

Parses a volume-changed notification message and extracts the track object it refers to, as well as an array of volumes and the size of the volumes array.

The track object remains valid until the message is freed.

The caller must free the array returned in the volumes parameter using g_free when they are done with it.

Since 0.10.14

gst_mixer_message_parse_options_list_changed ()

void                gst_mixer_message_parse_options_list_changed
                                                        (GstMessage *message,
                                                         GstMixerOptions **options);

Extracts the GstMixerOptions whose value list has changed from an options-list-changed bus notification message.

The options object returned remains valid until the message is freed. You do not need to unref it.

Since 0.10.18

The "mute-toggled" signal

void                user_function                      (GstMixer      *gstmixer,
                                                        GstMixerTrack *arg1,
                                                        gboolean       arg2,
                                                        gpointer       user_data)      : Run Last

The "option-changed" signal

void                user_function                      (GstMixer        *gstmixer,
                                                        GstMixerOptions *arg1,
                                                        gchar           *arg2,
                                                        gpointer         user_data)      : Run Last

The "record-toggled" signal

void                user_function                      (GstMixer      *gstmixer,
                                                        GstMixerTrack *arg1,
                                                        gboolean       arg2,
                                                        gpointer       user_data)      : Run Last

The "volume-changed" signal

void                user_function                      (GstMixer      *gstmixer,
                                                        GstMixerTrack *arg1,
                                                        gpointer       arg2,
                                                        gpointer       user_data)      : Run Last