MateMixerStream

MateMixerStream

Synopsis

#include <libmatemixer/matemixer.h>

enum                MateMixerDirection;
                    MateMixerStream;
struct              MateMixerStreamClass;
const gchar *       mate_mixer_stream_get_name          (MateMixerStream *stream);
const gchar *       mate_mixer_stream_get_label         (MateMixerStream *stream);
MateMixerDirection  mate_mixer_stream_get_direction     (MateMixerStream *stream);
MateMixerDevice *   mate_mixer_stream_get_device        (MateMixerStream *stream);
MateMixerStreamControl * mate_mixer_stream_get_control  (MateMixerStream *stream,
                                                         const gchar *name);
MateMixerStreamSwitch * mate_mixer_stream_get_switch    (MateMixerStream *stream,
                                                         const gchar *name);
MateMixerStreamControl * mate_mixer_stream_get_default_control
                                                        (MateMixerStream *stream);
const GList *       mate_mixer_stream_list_controls     (MateMixerStream *stream);
const GList *       mate_mixer_stream_list_switches     (MateMixerStream *stream);

Object Hierarchy

  GObject
   +----MateMixerStream

Properties

  "default-control"          MateMixerStreamControl*  : Read / Write / Construct Only
  "device"                   MateMixerDevice*      : Read / Write / Construct Only
  "direction"                MateMixerDirection    : Read / Write / Construct Only
  "label"                    gchar*                : Read / Write / Construct Only
  "name"                     gchar*                : Read / Write / Construct Only

Signals

  "control-added"                                  : Run First
  "control-removed"                                : Run First
  "switch-added"                                   : Run First
  "switch-removed"                                 : Run First

Description

Details

enum MateMixerDirection

typedef enum {
    MATE_MIXER_DIRECTION_UNKNOWN,
    MATE_MIXER_DIRECTION_INPUT,
    MATE_MIXER_DIRECTION_OUTPUT,
} MateMixerDirection;

Sound stream direction.

MATE_MIXER_DIRECTION_UNKNOWN

 Unknown direction.

MATE_MIXER_DIRECTION_INPUT

 Input direction (recording).

MATE_MIXER_DIRECTION_OUTPUT

 Output direction (playback).

MateMixerStream

typedef struct _MateMixerStream MateMixerStream;

The MateMixerStream structure contains only private data and should only be accessed using the provided API.

struct MateMixerStreamClass

struct MateMixerStreamClass {
    GObjectClass parent_class;
};

The class structure for MateMixerStream.

GObjectClass parent_class;

 The parent class.

mate_mixer_stream_get_name ()

const gchar *       mate_mixer_stream_get_name          (MateMixerStream *stream);

stream :

 a MateMixerStream

mate_mixer_stream_get_label ()

const gchar *       mate_mixer_stream_get_label         (MateMixerStream *stream);

stream :

 a MateMixerStream

mate_mixer_stream_get_direction ()

MateMixerDirection  mate_mixer_stream_get_direction     (MateMixerStream *stream);

stream :

 a MateMixerStream

mate_mixer_stream_get_device ()

MateMixerDevice *   mate_mixer_stream_get_device        (MateMixerStream *stream);

stream :

 a MateMixerStream

mate_mixer_stream_get_control ()

MateMixerStreamControl * mate_mixer_stream_get_control  (MateMixerStream *stream,
                                                         const gchar *name);

stream :

 a MateMixerStream

name :

 the name of a stream control

mate_mixer_stream_get_switch ()

MateMixerStreamSwitch * mate_mixer_stream_get_switch    (MateMixerStream *stream,
                                                         const gchar *name);

Gets the switch with the given name.

stream :

 a MateMixerStream

name :

 the name of a stream switch

Returns :

 a MateMixerStreamSwitch or NULL if there is no such switch.

mate_mixer_stream_get_default_control ()

MateMixerStreamControl * mate_mixer_stream_get_default_control
                                                        (MateMixerStream *stream);

stream :

 a MateMixerStream

mate_mixer_stream_list_controls ()

const GList *       mate_mixer_stream_list_controls     (MateMixerStream *stream);

stream :

 a MateMixerStream

mate_mixer_stream_list_switches ()

const GList *       mate_mixer_stream_list_switches     (MateMixerStream *stream);

stream :

 a MateMixerStream

Property Details

The "default-control" property

  "default-control"          MateMixerStreamControl*  : Read / Write / Construct Only

Default control of the stream.

The "device" property

  "device"                   MateMixerDevice*      : Read / Write / Construct Only

Device the stream belongs to.

The "direction" property

  "direction"                MateMixerDirection    : Read / Write / Construct Only

Direction of the stream.

Default value: MATE_MIXER_DIRECTION_UNKNOWN

The "label" property

  "label"                    gchar*                : Read / Write / Construct Only

Label of the stream.

Default value: NULL

The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

Name of the stream.

Default value: NULL

Signal Details

The "control-added" signal

void                user_function                      (MateMixerStream *matemixerstream,
                                                        gchar           *arg1,
                                                        gpointer         user_data)            : Run First

The "control-removed" signal

void                user_function                      (MateMixerStream *matemixerstream,
                                                        gchar           *arg1,
                                                        gpointer         user_data)            : Run First

The "switch-added" signal

void                user_function                      (MateMixerStream *matemixerstream,
                                                        gchar           *arg1,
                                                        gpointer         user_data)            : Run First

The "switch-removed" signal

void                user_function                      (MateMixerStream *matemixerstream,
                                                        gchar           *arg1,
                                                        gpointer         user_data)            : Run First
Generated by GTK-Doc V1.19