Cvc.MixerStream¶

Subclasses:: Cvc.MixerEventRole, Cvc.MixerSink, Cvc.MixerSinkInput, Cvc.MixerSource, Cvc.MixerSourceOutput

Methods¶

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

	`change_is_muted` (is_muted)
	`change_port` (port)
	`create_monitor` ()
	`get_application_id` ()
	`get_base_volume` ()
	`get_can_decibel` ()
	`get_card_index` ()
	`get_channel_map` ()
	`get_decibel` ()
	`get_description` ()
	`get_form_factor` ()
	`get_gicon` ()
	`get_icon_name` ()
	`get_id` ()
	`get_index` ()
	`get_is_muted` ()
	`get_name` ()
	`get_port` ()
	`get_ports` ()
	`get_state` ()
	`get_sysfs_path` ()
	`get_volume` ()
	`is_event_stream` ()
	`is_running` ()
	`is_virtual` ()
	`push_volume` ()
	`remove_monitor` ()
	`set_application_id` (application_id)
	`set_base_volume` (base_volume)
	`set_can_decibel` (can_decibel)
	`set_card_index` (card_index)
	`set_decibel` (db)
	`set_description` (description)
	`set_form_factor` (form_factor)
	`set_icon_name` (name)
	`set_is_event_stream` (is_event_stream)
	`set_is_muted` (is_muted)
	`set_is_virtual` (is_event_stream)
	`set_name` (name)
	`set_port` (port)
	`set_ports` (ports)
	`set_state` (state)
	`set_sysfs_path` (sysfs_path)
	`set_volume` (volume)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_change_is_muted` (is_muted)
	`do_change_port` (port)
	`do_monitor_suspend` ()
	`do_monitor_update` (v)
	`do_push_volume` (operation)

Properties¶

Name	Type	Flags	Short Description
`application-id`	`str`	r/w/c	Application identifier for this stream
`can-decibel`	`bool`	r/w/c	Whether stream volume can be converted to decibel units
`card-index`		r/w/c	The index of the card for this stream
`channel-map`	`Cvc.ChannelMap`	r/w/c	The channel map for this stream
`decibel`	`float`	r/w/c	The decibel level for this stream
`description`	`str`	r/w/c	Description to display for this stream
`form-factor`	`str`	r/w/c	Device form factor for this stream, as reported by PulseAudio
`icon-name`	`str`	r/w/c	Name of icon to display for this stream
`id`	`int`	r/w/co	The id for this stream
`index`	`int`	r/w/co	The index for this stream
`is-event-stream`	`bool`	r/w/c	Whether stream’s role is to play an event
`is-muted`	`bool`	r/w/c	Whether stream is muted
`is-virtual`	`bool`	r/w/c	Whether the stream is virtual
`name`	`str`	r/w/c	Name to display for this stream
`pa-context`	`int`	r/w/co	The PulseAudio context for this stream
`port`	`str`	r/w	The name of the current port for this stream
`state`	`Cvc.MixerStreamState`	r/w	The current state of this stream
`sysfs-path`	`str`	r/w/c	Sysfs path for the device associated with this stream
`volume`	`int`	r/w	The volume for this stream

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`monitor-suspend`
`monitor-update`

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Cvc.MixerStream(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: Cvc.MixerStreamClass

change_is_muted(is_muted)¶

Parameters:: is_muted (bool) –
Return type:: bool

change_port(port)¶

Parameters:: port (str) –
Return type:: bool

create_monitor()¶

get_application_id()¶

Return type:: str

get_base_volume()¶

Return type:: int

get_can_decibel()¶

Return type:: bool

get_card_index()¶

Return type:: int

get_channel_map()¶

Return type:: Cvc.ChannelMap

get_decibel()¶

Return type:: float

get_description()¶

Return type:: str

get_form_factor()¶

Return type:: str

get_gicon()¶

Returns:: a new Gio.Icon
Return type:: Gio.Icon

get_icon_name()¶

Return type:: str

get_id()¶

Return type:: int

get_index()¶

Return type:: int

get_is_muted()¶

Return type:: bool

get_name()¶

Return type:: str

get_port()¶

Return type:: Cvc.MixerStreamPort

get_ports()¶

Return type:: [Cvc.MixerStreamPort]

get_state()¶

Return type:: Cvc.MixerStreamState

get_sysfs_path()¶

Return type:: str

get_volume()¶

Return type:: int

is_event_stream()¶

Return type:: bool

is_running()¶

Return type:: bool

is_virtual()¶

Return type:: bool

push_volume()¶

Return type:: bool

remove_monitor()¶

set_application_id(application_id)¶

Parameters:: application_id (str) –
Return type:: bool

set_base_volume(base_volume)¶

Parameters:: base_volume (int) –
Return type:: bool

set_can_decibel(can_decibel)¶

Parameters:: can_decibel (bool) –
Return type:: bool

set_card_index(card_index)¶

Parameters:: card_index (int) –
Return type:: bool

set_decibel(db)¶

Parameters:: db (float) –
Return type:: bool

set_description(description)¶

Parameters:: description (str) –
Return type:: bool

set_form_factor(form_factor)¶

Parameters:: form_factor (str) –
Return type:: bool

set_icon_name(name)¶

Parameters:: name (str) –
Return type:: bool

set_is_event_stream(is_event_stream)¶

Parameters:: is_event_stream (bool) –
Return type:: bool

set_is_muted(is_muted)¶

Parameters:: is_muted (bool) –
Return type:: bool

set_is_virtual(is_event_stream)¶

Parameters:: is_event_stream (bool) –
Return type:: bool

set_name(name)¶

Parameters:: name (str) –
Return type:: bool

set_port(port)¶

Parameters:: port (str) –
Return type:: bool

set_ports(ports)¶

Parameters:: ports ([Cvc.MixerStreamPort]) –
Return type:: bool

set_state(state)¶

Parameters:: state (Cvc.MixerStreamState) –
Return type:: bool

set_sysfs_path(sysfs_path)¶

Parameters:: sysfs_path (str) –
Return type:: bool

set_volume(volume)¶

Parameters:: volume (int) –
Return type:: bool

do_change_is_muted(is_muted) virtual¶

Parameters:: is_muted (bool) –
Return type:: bool

do_change_port(port) virtual¶

Parameters:: port (str) –
Return type:: bool

do_monitor_suspend() virtual¶

do_monitor_update(v) virtual¶

Parameters:: v (float) –

do_push_volume(operation) virtual¶

Parameters:: operation (object or None) –
Return type:: bool

Signal Details¶

Cvc.MixerStream.signals.monitor_suspend(mixer_stream)¶

Signal Name:: monitor-suspend
Flags:: RUN_LAST
Parameters:: mixer_stream (Cvc.MixerStream) – The object which received the signal

Cvc.MixerStream.signals.monitor_update(mixer_stream, object)¶

Signal Name:

monitor-update

Flags:

RUN_LAST

Parameters:

mixer_stream (Cvc.MixerStream) – The object which received the signal
object (float) –

Property Details¶

Cvc.MixerStream.props.application_id¶

Name:: application-id
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

Application identifier for this stream

Cvc.MixerStream.props.can_decibel¶

Name:: can-decibel
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT

Whether stream volume can be converted to decibel units

Cvc.MixerStream.props.card_index¶

Name:: card-index
Type:
Default Value:: 4294967295
Flags:: READABLE, WRITABLE, CONSTRUCT

The index of the card for this stream

Cvc.MixerStream.props.channel_map¶

Name:: channel-map
Type:: Cvc.ChannelMap
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

The channel map for this stream

Cvc.MixerStream.props.decibel¶

Name:: decibel
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, CONSTRUCT

The decibel level for this stream

Cvc.MixerStream.props.description¶

Name:: description
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

Description to display for this stream

Cvc.MixerStream.props.form_factor¶

Name:: form-factor
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

Device form factor for this stream, as reported by PulseAudio

Cvc.MixerStream.props.icon_name¶

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

Name of icon to display for this stream

Cvc.MixerStream.props.id¶

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

The id for this stream

Cvc.MixerStream.props.index¶

Name:: index
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The index for this stream

Cvc.MixerStream.props.is_event_stream¶

Name:: is-event-stream
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT

Whether stream’s role is to play an event

Cvc.MixerStream.props.is_muted¶

Name:: is-muted
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT

Whether stream is muted

Cvc.MixerStream.props.is_virtual¶

Name:: is-virtual
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT

Whether the stream is virtual

Cvc.MixerStream.props.name¶

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

Name to display for this stream

Cvc.MixerStream.props.pa_context¶

Name:: pa-context
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The PulseAudio context for this stream

Cvc.MixerStream.props.port¶

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

The name of the current port for this stream

Cvc.MixerStream.props.state¶

Name:: state
Type:: Cvc.MixerStreamState
Default Value:: Cvc.MixerStreamState.INVALID
Flags:: READABLE, WRITABLE

The current state of this stream

Cvc.MixerStream.props.sysfs_path¶

Name:: sysfs-path
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

Sysfs path for the device associated with this stream

Cvc.MixerStream.props.volume¶

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

The volume for this stream