Cvc.MixerUIDevice¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_active_profile` ()
	`get_best_profile` (selected, current)
	`get_description` ()
	`get_gicon` ()
	`get_icon_name` ()
	`get_id` ()
	`get_matching_profile` (profile)
	`get_origin` ()
	`get_port` ()
	`get_profiles` ()
	`get_stream_id` ()
	`get_supported_profiles` ()
	`get_top_priority_profile` ()
	`get_user_preferred_profile` ()
	`has_ports` ()
	`invalidate_stream` ()
	`is_output` ()
	`set_profiles` (in_profiles)
	`set_user_preferred_profile` (profile)
	`should_profiles_be_hidden` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`card`	`int`	r/w	Set/Get card
`description`	`str`	r/w	Set first line description
`icon-name`	`str`	r/w/c	Name of icon to display for this card
`origin`	`str`	r/w	Set second line description name
`port-available`	`bool`	r/w	determine whether this port is available
`port-name`	`str`	r/w	Set port-name
`stream-id`	`int`	r/w	Set/Get stream id
`type`	`int`	r/w	determine whether its an input and output

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Cvc.MixerUIDevice(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Cvc.MixerUIDeviceClass

get_active_profile()¶

Return type:: str

get_best_profile(selected, current)¶

Parameters:

selected (str or None) – The selected profile or its canonical name or None for any profile
current (str) – The currently selected profile

Returns:

a profile name, valid as long as the UI device profiles are.

Return type:

str

get_description()¶

Return type:: str

get_gicon()¶

Return type:: Gio.Icon

get_icon_name()¶

Return type:: str

get_id()¶

Return type:: int

get_matching_profile(profile)¶

Parameters:: profile (str) –
Return type:: str

get_origin()¶

Return type:: str

get_port()¶

Return type:: str

get_profiles()¶

Return type:: [Cvc.MixerCardProfile]

get_stream_id()¶

Return type:: int

get_supported_profiles()¶

Return type:: [Cvc.MixerCardProfile]

get_top_priority_profile()¶

Return type:: str

get_user_preferred_profile()¶

Return type:: str

has_ports()¶

Return type:: bool

invalidate_stream()¶

is_output()¶

Return type:: bool

set_profiles(in_profiles)¶

Parameters:: in_profiles ([Cvc.MixerCardProfile]) – a list of Cvc.MixerCardProfile

Assigns value to

device->priv->profiles (profiles to be added to combobox)
device->priv->supported_profiles (all profiles of this port)
device->priv->disable_profile_swapping (whether to show the combobox)

This method attempts to reduce the list of profiles visible to the user by figuring out from the context of that device (whether it’s an input or an output) what profiles actually provide an alternative.

It does this by the following.

It ignores off profiles.
It takes the canonical name of the profile. That name is what you get when you ignore the other direction.
In the first iteration, it only adds the names of canonical profiles - i e when the other side is turned off.
Normally the first iteration covers all cases, but sometimes (e g bluetooth) it doesn’t, so add other profiles whose canonical name isn’t already added in a second iteration.

set_user_preferred_profile(profile)¶

Parameters:: profile (str) –

should_profiles_be_hidden()¶

Return type:: bool

Property Details¶

Cvc.MixerUIDevice.props.card¶

Name:: card
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE

Set/Get card

Cvc.MixerUIDevice.props.description¶

Name:: description
Type:: str
Default Value:: 'no-name-set'
Flags:: READABLE, WRITABLE

Set first line description

Cvc.MixerUIDevice.props.icon_name¶

Name:: icon-name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

Name of icon to display for this card

Cvc.MixerUIDevice.props.origin¶

Name:: origin
Type:: str
Default Value:: 'no-name-set'
Flags:: READABLE, WRITABLE

Set second line description name

Cvc.MixerUIDevice.props.port_available¶

Name:: port-available
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

determine whether this port is available

Cvc.MixerUIDevice.props.port_name¶

Name:: port-name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Set port-name

Cvc.MixerUIDevice.props.stream_id¶

Name:: stream-id
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Set/Get stream id

Cvc.MixerUIDevice.props.type¶

Name:: type
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

determine whether its an input and output