MateMixerStreamSwitch

MateMixerStreamSwitch

Synopsis

#include <libmatemixer/matemixer.h>

enum                MateMixerStreamSwitchFlags;
enum                MateMixerStreamSwitchRole;
                    MateMixerStreamSwitch;
struct              MateMixerStreamSwitchClass;
MateMixerStreamSwitchFlags mate_mixer_stream_switch_get_flags
                                                        (MateMixerStreamSwitch *swtch);
MateMixerStreamSwitchRole mate_mixer_stream_switch_get_role
                                                        (MateMixerStreamSwitch *swtch);
MateMixerStream *   mate_mixer_stream_switch_get_stream (MateMixerStreamSwitch *swtch);

Object Hierarchy

  GObject
   +----MateMixerSwitch
         +----MateMixerStreamSwitch
               +----MateMixerStreamToggle

Properties

  "flags"                    MateMixerStreamSwitchFlags  : Read / Write / Construct Only
  "role"                     MateMixerStreamSwitchRole  : Read / Write / Construct Only
  "stream"                   MateMixerStream*      : Read / Write / Construct Only

Description

Details

enum MateMixerStreamSwitchFlags

typedef enum {
 /*< flags >*/
    MATE_MIXER_STREAM_SWITCH_NO_FLAGS = 0,
    MATE_MIXER_STREAM_SWITCH_TOGGLE   = 1 << 0,
} MateMixerStreamSwitchFlags;

MATE_MIXER_STREAM_SWITCH_NO_FLAGS

No flags.

MATE_MIXER_STREAM_SWITCH_TOGGLE

The switch is a MateMixerStreamToggle.

enum MateMixerStreamSwitchRole

typedef enum {
    MATE_MIXER_STREAM_SWITCH_ROLE_UNKNOWN,
    MATE_MIXER_STREAM_SWITCH_ROLE_PORT,
    MATE_MIXER_STREAM_SWITCH_ROLE_BOOST
} MateMixerStreamSwitchRole;

MATE_MIXER_STREAM_SWITCH_ROLE_UNKNOWN

Unknown stream switch role.

MATE_MIXER_STREAM_SWITCH_ROLE_PORT

The switch changes the active port.

MATE_MIXER_STREAM_SWITCH_ROLE_BOOST

The switch changes the boost value.

MateMixerStreamSwitch

typedef struct _MateMixerStreamSwitch MateMixerStreamSwitch;

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


struct MateMixerStreamSwitchClass

struct MateMixerStreamSwitchClass {
    MateMixerSwitchClass parent_class;
};

The class structure for MateMixerStreamSwitch.

MateMixerSwitchClass parent_class;

The parent class.

mate_mixer_stream_switch_get_flags ()

MateMixerStreamSwitchFlags mate_mixer_stream_switch_get_flags
                                                        (MateMixerStreamSwitch *swtch);

Gets the flags of the switch. See MateMixerStreamSwitchFlags for information about the meaning of the individual flags.

swtch :

a MateMixerStreamSwitch

Returns :

the flags of the switch.

mate_mixer_stream_switch_get_role ()

MateMixerStreamSwitchRole mate_mixer_stream_switch_get_role
                                                        (MateMixerStreamSwitch *swtch);

Gets the role of the switch. The role identifies the purpose of the switch.

swtch :

a MateMixerStreamSwitch

Returns :

the switch role.

mate_mixer_stream_switch_get_stream ()

MateMixerStream *   mate_mixer_stream_switch_get_stream (MateMixerStreamSwitch *swtch);

Property Details

The "flags" property

  "flags"                    MateMixerStreamSwitchFlags  : Read / Write / Construct Only

Flags of the switch.


The "role" property

  "role"                     MateMixerStreamSwitchRole  : Read / Write / Construct Only

Role of the switch.

Default value: MATE_MIXER_STREAM_SWITCH_ROLE_UNKNOWN


The "stream" property

  "stream"                   MateMixerStream*      : Read / Write / Construct Only

Stream owning the switch.