gstmixertrack

gstmixertrack — Basic mixer control object (volume slider, switch)

Functions

Properties

guint flags Read
guint index Read / Write / Construct Only
gchar * label Read
gint max-volume Read
gint min-volume Read
gint num-channels Read
gchar * untranslated-label Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GstMixerTrack
        ╰── GstMixerOptions

Includes

#include <gst/interfaces/mixer.h>

Description

Basic mixer control object (note that it is a GObject and not a GstObject).

A mixer track represents a single slider control of none, one or more channels. A mixer track with no channels is usually interpreted as a on/off switch control.

Note the presence of both min_volume and max_volume fields. Applications must not assume that min_volume is 0 or max_volume is any particular value.

Functions

GST_MIXER_TRACK_HAS_FLAG()

#define             GST_MIXER_TRACK_HAS_FLAG(channel, flag)

Types and Values

struct GstMixerTrack

struct GstMixerTrack;

enum GstMixerTrackFlags

Mixer track flags.

Members

GST_MIXER_TRACK_INPUT

mixer track is for input

 

GST_MIXER_TRACK_OUTPUT

mixer track is for output

 

GST_MIXER_TRACK_MUTE

input or output is muted

 

GST_MIXER_TRACK_RECORD

input is audible in speakers attached to output (for GST_MIXER_TRACK_INPUT mixer tracks only)

 

GST_MIXER_TRACK_MASTER

this mixer track is likely to be the master control

 

GST_MIXER_TRACK_SOFTWARE

mixer track's' volume control is implemented in software (as opposed to a hardware control)

 

GST_MIXER_TRACK_NO_RECORD

input track lacks support for recordable. Since: 0.10.23

 

GST_MIXER_TRACK_NO_MUTE

play track doesn't support mute. Since: 0.10.23

 

GST_MIXER_TRACK_WHITELIST

track should be displayed "by default" in apps. Since: 0.10.23

 

GST_MIXER_TRACK_READONLY

track is read-only. Since: 0.10.25

 

GST_MIXER_TRACK_WRITEONLY

track is write-only. Since: 0.10.25

 

Property Details

The “flags” property

  “flags”                    guint

Flags indicating the type of mixer track.

Flags: Read

Default value: 0


The “index” property

  “index”                    guint

Index of the mixer track, if available. Mixer track implementations must set this at construct time. This can be used to discern between multiple tracks with identical labels.

Flags: Read / Write / Construct Only

Default value: 0

Since 0.10.21


The “label” property

  “label”                    gchar *

The label assigned to the track (may be translated).

Flags: Read

Default value: NULL


The “max-volume” property

  “max-volume”               gint

The maximum possible volume level.

Flags: Read

Default value: 0


The “min-volume” property

  “min-volume”               gint

The minimum possible volume level.

Flags: Read

Default value: 0


The “num-channels” property

  “num-channels”             gint

The number of channels contained within the track.

Flags: Read

Allowed values: >= 0

Default value: 0


The “untranslated-label” property

  “untranslated-label”       gchar *

The untranslated label of the mixer track, if available. Mixer track implementations must set this at construct time. Applications may find this useful to determine icons for various kind of tracks. However, applications mustn't make any assumptions about the naming of tracks, the untranslated labels are purely informational and may change.

Flags: Read / Write / Construct Only

Default value: NULL

Since 0.10.13

See Also

GstMixer, GstMixerOptions