MateMixerSwitch: libmatemixer Reference Manual

## MateMixerSwitch MateMixerSwitch |

## Functions

const gchar * | mate_mixer_switch_get_name ()
const gchar * | mate_mixer_switch_get_label ()
MateMixerSwitchOption * | mate_mixer_switch_get_option ()
const GList * | mate_mixer_switch_list_options ()
MateMixerSwitchOption * | mate_mixer_switch_get_active_option ()
gboolean | mate_mixer_switch_set_active_option ()

## Properties

MateMixerSwitchOption * | active-option | Read / Write / Construct Only
char * | label | Read / Write / Construct Only
char * | name | Read / Write / Construct Only

## Types and Values

| MateMixerSwitch
struct | MateMixerSwitchClass

## Object Hierarchy

        GObject
        ╰── MateMixerSwitch
            ├── MateMixerDeviceSwitch
            ╰── MateMixerStreamSwitch

## Includes

    #include <libmatemixer/matemixer.h>

## Description

## Functions

### mate_mixer_switch_get_name ()

    const gchar *
    mate_mixer_switch_get_name (MateMixerSwitch *swtch);

Gets the name of the switch.

The name serves as a unique identifier and in most cases it is not in a user-readable form.

#### Parameters

swtch | a MateMixerSwitch |

#### Returns

the name of the switch.

### mate_mixer_switch_get_label ()

    const gchar *
    mate_mixer_switch_get_label (MateMixerSwitch *swtch);

Gets the label of the switch.

This is a potentially translated string that should be presented to users in the user interface.

#### Parameters

swtch | a MateMixerSwitch |

#### Returns

the label of the switch option.

### mate_mixer_switch_get_option ()

    MateMixerSwitchOption *
    mate_mixer_switch_get_option (MateMixerSwitch *swtch,
                                  const gchar *name);

Gets the MateMixerSwitchOption with the given name.

#### Parameters

swtch | a MateMixerSwitch |
name | the name of an option |

#### Returns

a MateMixerSwitchOption or `NULL` if there is no such switch option.

### mate_mixer_switch_list_options ()

    const GList *
    mate_mixer_switch_list_options (MateMixerSwitch *swtch);

Gets the list of switch options that belong to the switch.

The returned GList is owned by the MateMixerSwitch and may be invalidated at any time.

#### Parameters

swtch | a MateMixerSwitch |

#### Returns

a GList of the switch options.

### mate_mixer_switch_get_active_option ()

    MateMixerSwitchOption *
    mate_mixer_switch_get_active_option (MateMixerSwitch *swtch);

Gets the MateMixerSwitchOption which is currently active.

#### Parameters

swtch | a MateMixerSwitch |

#### Returns

a MateMixerSwitchOption.

### mate_mixer_switch_set_active_option ()

    gboolean
    mate_mixer_switch_set_active_option (MateMixerSwitch *swtch,
                                         MateMixerSwitchOption *option);

Changes the currently active switch option.

#### Parameters

swtch | a MateMixerSwitch |
option | the MateMixerSwitchOption to set as the active option |

#### Returns

`TRUE` on success or `FALSE` on failure.

## Types and Values

### MateMixerSwitch

    typedef struct _MateMixerSwitch MateMixerSwitch;

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

### struct MateMixerSwitchClass

    struct MateMixerSwitchClass {
        GObjectClass parent_class;
    };

The class structure for MateMixerSwitch.

#### Members

## Property Details

### The `“active-option”` property

      “active-option”            MateMixerSwitchOption *

Active option of the switch.

Owner: MateMixerSwitch

Flags: Read / Write / Construct Only

### The `“label”` property

      “label”                    char *

Label of the switch.

Owner: MateMixerSwitch

Flags: Read / Write / Construct Only

Default value: NULL

### The `“name”` property

      “name”                     char *

Name of the switch.

Owner: MateMixerSwitch

Flags: Read / Write / Construct Only

Default value: NULL