![]() |
![]() |
![]() |
libmatemixer Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <libmatemixer/matemixer.h> MateMixerStreamToggle; struct MateMixerStreamToggleClass; gboolean mate_mixer_stream_toggle_get_state (MateMixerStreamToggle *toggle
); gboolean mate_mixer_stream_toggle_set_state (MateMixerStreamToggle *toggle
,gboolean state
); MateMixerSwitchOption * mate_mixer_stream_toggle_get_state_option (MateMixerStreamToggle *toggle
,gboolean state
);
"off-state-option" MateMixerSwitchOption* : Read / Write / Construct Only "on-state-option" MateMixerSwitchOption* : Read / Write / Construct Only "state" gboolean : Read / Write
typedef struct _MateMixerStreamToggle MateMixerStreamToggle;
The MateMixerStreamToggle structure contains only private data and should only be accessed using the provided API.
struct MateMixerStreamToggleClass { MateMixerStreamSwitchClass parent_class; };
The class structure for MateMixerStreamToggle.
MateMixerStreamSwitchClass |
The parent class. |
gboolean mate_mixer_stream_toggle_get_state (MateMixerStreamToggle *toggle
);
Gets the current state of the toggle. TRUE
corresponds to the 'on' state and
FALSE
to the 'off' state.
|
a MateMixerStreamToggle |
Returns : |
TRUE or FALSE . |
gboolean mate_mixer_stream_toggle_set_state (MateMixerStreamToggle *toggle
,gboolean state
);
Sets the toggle
to the selected state.
This function is equivalent to using mate_mixer_switch_set_active_option()
with a MateMixerSwitchOption representing the selected state.
|
a MateMixerStreamToggle |
|
the state to set |
Returns : |
TRUE on success or FALSE on failure. |
MateMixerSwitchOption * mate_mixer_stream_toggle_get_state_option (MateMixerStreamToggle *toggle
,gboolean state
);
Gets the MateMixerSwitchOption representing the selected state.
|
a MateMixerStreamToggle |
|
the state to get the MateMixerSwitchOption for |
Returns : |
a MateMixerSwitchOption. |
"off-state-option"
property"off-state-option" MateMixerSwitchOption* : Read / Write / Construct Only
The MateMixerSwitchOption representing the 'off' value of the toggle.
"on-state-option"
property"on-state-option" MateMixerSwitchOption* : Read / Write / Construct Only
The MateMixerSwitchOption representing the 'on' value of the toggle.