AgsAudio.AudioSignal

g Ags.Connectable Ags.Connectable AgsAudio.AudioSignal AgsAudio.AudioSignal Ags.Connectable->AgsAudio.AudioSignal GObject.GInterface GObject.GInterface GObject.GInterface->Ags.Connectable GObject.Object GObject.Object GObject.Object->AgsAudio.AudioSignal

Subclasses:None

Methods

Inherited:GObject.Object (37), Ags.Connectable (13)
Structs:GObject.ObjectClass (5)
class find_by_recall_id (audio_signal, recall_id)
class find_stream_current (audio_signal, recall_id)
class get_rt_template (audio_signal)
class get_template (audio_signal)
class is_active (audio_signal, recall_id)
class new (output_soundcard, recycling, recall_id)
class new_with_length (output_soundcard, recycling, recall_id, length)
  add_note (note)
  add_stream ()
  clear ()
  close_feed (template, frame_count, old_frame_count)
  contains_note (note)
  continue_feed (template, frame_count, old_frame_count)
  duplicate_stream (template)
  feed (template, frame_count)
  feed_extended (template, frame_count, old_frame_count, do_open, do_close)
  get_buffer_size ()
  get_format ()
  get_input_soundcard ()
  get_length_till_current ()
  get_note ()
  get_output_soundcard ()
  get_recycling ()
  get_samplerate ()
  open_feed (template, frame_count, old_frame_count)
  refresh_data ()
  remove_note (note)
  set_buffer_size (buffer_size)
  set_flags (flags)
  set_format (format)
  set_input_soundcard (input_soundcard)
  set_note (note)
  set_output_soundcard (output_soundcard)
  set_recycling (recycling)
  set_samplerate (samplerate)
  stream_lock ()
  stream_resize (length)
  stream_safe_resize (length)
  stream_unlock ()
  test_flags (flags)
  unset_flags (flags)

Virtual Methods

Inherited:GObject.Object (7), Ags.Connectable (13)
  do_add_note (note)
  do_refresh_data ()
  do_remove_note (note)

Properties

Name Type Flags Short Description
attack int r/w The attack to be used
buffer-size int r/w The buffer size to be used
damping Ags.Complex r/w The timbre’s damping
delay float r/w The delay to be used
first-frame int r/w The first frame of the stream
format int r/w The format to be used
frame-count int r/w The initial frame count of audio data
input-soundcard GObject.Object r/w The input soundcard it is assigned with
input-soundcard-channel int r/w The input soundcard channel
last-frame int r/w The last frame of the stream
length int r/w The length of the stream
loop-end int r/w The loop end of the stream
loop-start int r/w The loop start of the stream
note int r/w The note it is assigned with
output-soundcard GObject.Object r/w The output soundcard it is assigned with
output-soundcard-channel int r/w The output soundcard channel
recall-id AgsAudio.RecallID r/w The recall id it is assigned with
recycling AgsAudio.Recycling r/w The recycling it is assigned with
rt-template AgsAudio.AudioSignal r/w The assigend realtime template
samplerate int r/w The samplerate to be used
stream int r The stream it contains
stream-current int r The current stream
stream-end int r The stream’s end
template AgsAudio.AudioSignal r/w The assigend template
timbre-end int r/w The timbre’s end frame
timbre-start int r/w The timbre’s start frame
vibration Ags.Complex r/w The timbre’s vibration
word-size int r The word size of a frame

Signals

Inherited:GObject.Object (1)
Name Short Description
add-note The ::add-note signal notifies about adding note.
refresh-data The ::refresh-data signal notifies about requesting to refresh data.
remove-note The ::remove-note signal notifies about removing note.

Fields

Inherited:GObject.Object (1)
Name Type Access Description
attack int r  
buffer_size int r  
damping Ags.Complex r  
delay float r  
first_frame int r  
flags int r  
format int r  
frame_count int r  
gobject GObject.Object r  
input_soundcard GObject.Object r  
input_soundcard_channel int r  
last_frame int r  
length int r  
loop_end int r  
loop_start int r  
note [object] r  
obj_mutex GLib.RecMutex r  
output_soundcard GObject.Object r  
output_soundcard_channel int r  
recall_id GObject.Object r  
recycling GObject.Object r  
rt_template GObject.Object r  
samplerate int r  
stream [object] r  
stream_current [object] r  
stream_end [object] r  
stream_mutex GLib.RecMutex r  
template GObject.Object r  
timbre_end int r  
timbre_start int r  
uuid Ags.UUID r  
vibration Ags.Complex r  
word_size int r  

Class Details

class AgsAudio.AudioSignal(**kwargs)
Bases:GObject.Object, Ags.Connectable
Abstract:No
Structure:AgsAudio.AudioSignalClass
classmethod find_by_recall_id(audio_signal, recall_id)
Parameters:
Returns:

matching GLib.List-struct containing AgsAudio.AudioSignal

Return type:

[AgsAudio.AudioSignal]

Retrieve next audio signal refering to recall_id

New in version 3.0.0.

classmethod find_stream_current(audio_signal, recall_id)
Parameters:
Returns:

next GLib.List-struct matching AgsAudio.RecallID

Return type:

[AgsAudio.AudioSignal]

Retrieve next current stream of AgsAudio.AudioSignal list. Warning this function does not lock the stream mutex.

New in version 3.0.0.

classmethod get_rt_template(audio_signal)
Parameters:audio_signal ([AgsAudio.AudioSignal]) – a GLib.List-struct containing AgsAudio.AudioSignal
Returns:the rt-templates as GLib.List-struct containing AgsAudio.AudioSignal
Return type:[AgsAudio.AudioSignal]

Retrieve the realtime template audio signal.

New in version 3.0.0.

classmethod get_template(audio_signal)
Parameters:audio_signal ([AgsAudio.AudioSignal]) – the GLib.List-struct containing AgsAudio.AudioSignal
Returns:the template AgsAudio.AudioSignal or None if not found
Return type:AgsAudio.AudioSignal

Retrieve the template audio signal.

New in version 3.0.0.

classmethod is_active(audio_signal, recall_id)
Parameters:
Returns:

True if related audio signal to recall id is available, otherwise False

Return type:

bool

Check if is active.

New in version 3.0.0.

classmethod new(output_soundcard, recycling, recall_id)
Parameters:
Returns:

a new AgsAudio.AudioSignal

Return type:

AgsAudio.AudioSignal

Creates a AgsAudio.AudioSignal, with defaults of output_soundcard, linking recycling tree and refering to recall_id.

New in version 3.0.0.

classmethod new_with_length(output_soundcard, recycling, recall_id, length)
Parameters:
Returns:

a new AgsAudio.AudioSignal

Return type:

AgsAudio.AudioSignal

Creates a AgsAudio.AudioSignal, with defaults of soundcard, linking recycling tree and refering to recall_id. The audio data is tiled to length frame count.

New in version 3.0.0.

add_note(note)
Parameters:note (GObject.Object) – the AgsAudio.Note

Add note to self.

New in version 3.0.0.

add_stream()

Adds a buffer at the end of the stream.

New in version 3.0.0.

clear()

Clear self.

New in version 3.4.1.

close_feed(template, frame_count, old_frame_count)
Parameters:

Feed audio signal to grow upto frame count.

New in version 3.3.0.

contains_note(note)
Parameters:note (AgsAudio.Note) – the AgsAudio.Note
Returns:True on success, otherwise False
Return type:bool

Check if self contains note.

New in version 3.3.0.

continue_feed(template, frame_count, old_frame_count)
Parameters:

Feed audio signal to grow upto frame count.

New in version 3.3.0.

duplicate_stream(template)
Parameters:template (AgsAudio.AudioSignal) – the template AgsAudio.AudioSignal

Apply template audio data to self. Note should only be invoked by proper recall context because only the stream of template is locked.

New in version 3.0.0.

feed(template, frame_count)
Parameters:

Feed audio signal to grow upto frame count.

New in version 3.0.0.

feed_extended(template, frame_count, old_frame_count, do_open, do_close)
Parameters:

Feed audio signal to grow upto frame count.

New in version 3.3.0.

get_buffer_size()
Returns:the buffer size
Return type:int

Gets buffer size.

New in version 3.1.0.

get_format()
Returns:the format
Return type:int

Gets format.

New in version 3.1.0.

get_input_soundcard()
Returns:the input soundcard
Return type:GObject.Object

Get the input soundcard object of self.

New in version 3.1.0.

get_length_till_current()
Returns:the counted length.
Return type:int

Counts the buffers from :stream upto :stream-current.

New in version 3.0.0.

get_note()
Returns:the GLib.List-struct containig AgsAudio.Note
Return type:[AgsAudio.Note]

Get note.

New in version 3.1.0.

get_output_soundcard()
Returns:the output soundcard
Return type:GObject.Object

Get the output soundcard object of self.

New in version 3.1.0.

get_recycling()
Returns:the AgsAudio.Recycling
Return type:GObject.Object

Get recycling.

New in version 3.1.0.

get_samplerate()
Returns:the samplerate
Return type:int

Gets samplerate.

New in version 3.1.0.

open_feed(template, frame_count, old_frame_count)
Parameters:

Feed audio signal to grow upto frame count.

New in version 3.3.0.

refresh_data()
remove_note(note)
Parameters:note (GObject.Object) – the AgsAudio.Note

Remove note from self.

New in version 3.0.0.

set_buffer_size(buffer_size)
Parameters:buffer_size (int) – the buffer size

Set buffer size.

New in version 3.0.0.

set_flags(flags)
Parameters:flags (int) – see AgsAudio.AudioSignalFlags-enum

Enable a feature of self.

New in version 3.0.0.

set_format(format)
Parameters:format (int) – the format

Set format.

New in version 3.0.0.

set_input_soundcard(input_soundcard)
Parameters:input_soundcard (GObject.Object) – the GObject.Object implementing Ags.Soundcard

Set the input soundcard object of self.

New in version 3.0.0.

set_note(note)
Parameters:note ([AgsAudio.Note]) – the GLib.List-struct containing AgsAudio.Note

Set note by replacing existing.

New in version 3.1.0.

set_output_soundcard(output_soundcard)
Parameters:output_soundcard (GObject.Object) – the GObject.Object implementing Ags.Soundcard

Set the output soundcard object of self.

New in version 3.0.0.

set_recycling(recycling)
Parameters:recycling (GObject.Object) – the AgsAudio.Recycling

Set recycling.

New in version 3.1.0.

set_samplerate(samplerate)
Parameters:samplerate (int) – the samplerate

Set samplerate.

New in version 3.0.0.

stream_lock()

Lock stream mutex.

New in version 3.1.0.

stream_resize(length)
Parameters:length (int) – the new length

Resize stream of self to length number of buffers.

New in version 3.0.0.

stream_safe_resize(length)
Parameters:length (int) – the new length

Resize stream of self to length number of buffers. But doesn’t shrink more than the current stream position.

New in version 3.0.0.

stream_unlock()

Unlock stream mutex.

New in version 3.1.0.

test_flags(flags)
Parameters:flags (int) – the flags
Returns:True if flags are set, else False
Return type:bool

Test flags to be set on self.

New in version 3.0.0.

unset_flags(flags)
Parameters:flags (int) – see AgsAudio.AudioSignalFlags-enum

Disable a feature of self.

New in version 3.0.0.

do_add_note(note) virtual
Parameters:note (GObject.Object) – the AgsAudio.Note

Add note to audio_signal.

New in version 3.0.0.

do_refresh_data() virtual
do_remove_note(note) virtual
Parameters:note (GObject.Object) – the AgsAudio.Note

Remove note from audio_signal.

New in version 3.0.0.

Signal Details

AgsAudio.AudioSignal.signals.add_note(audio_signal, note)
Signal Name:

add-note

Flags:

RUN_LAST

Parameters:

The ::add-note signal notifies about adding note.

New in version 3.0.0.

AgsAudio.AudioSignal.signals.refresh_data(audio_signal)
Signal Name:refresh-data
Flags:RUN_LAST
Parameters:audio_signal (AgsAudio.AudioSignal) – The object which received the signal

The ::refresh-data signal notifies about requesting to refresh data.

New in version 3.0.0.

AgsAudio.AudioSignal.signals.remove_note(audio_signal, note)
Signal Name:

remove-note

Flags:

RUN_LAST

Parameters:

The ::remove-note signal notifies about removing note.

New in version 3.0.0.

Property Details

AgsAudio.AudioSignal.props.attack
Name:attack
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The attack to be used.

New in version 3.0.0.

AgsAudio.AudioSignal.props.buffer_size
Name:buffer-size
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The buffer size to be used.

New in version 3.0.0.

AgsAudio.AudioSignal.props.damping
Name:damping
Type:Ags.Complex
Default Value:None
Flags:READABLE, WRITABLE

Damping of timbre.

New in version 3.0.0.

AgsAudio.AudioSignal.props.delay
Name:delay
Type:float
Default Value:0.0
Flags:READABLE, WRITABLE

The delay to be used.

New in version 3.0.0.

AgsAudio.AudioSignal.props.first_frame
Name:first-frame
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The first frame of stream.

New in version 3.0.0.

AgsAudio.AudioSignal.props.format
Name:format
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The format to be used.

New in version 3.0.0.

AgsAudio.AudioSignal.props.frame_count
Name:frame-count
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The initial size of audio data.

New in version 3.0.0.

AgsAudio.AudioSignal.props.input_soundcard
Name:input-soundcard
Type:GObject.Object
Default Value:None
Flags:READABLE, WRITABLE

The assigned input Ags.Soundcard.

New in version 3.0.0.

AgsAudio.AudioSignal.props.input_soundcard_channel
Name:input-soundcard-channel
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The input soundcard channel.

New in version 3.0.0.

AgsAudio.AudioSignal.props.last_frame
Name:last-frame
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The last frame of stream.

New in version 3.0.0.

AgsAudio.AudioSignal.props.length
Name:length
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The length of the stream.

New in version 3.0.0.

AgsAudio.AudioSignal.props.loop_end
Name:loop-end
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The loop end of stream.

New in version 3.0.0.

AgsAudio.AudioSignal.props.loop_start
Name:loop-start
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The loop start of stream.

New in version 3.0.0.

AgsAudio.AudioSignal.props.note
Name:note
Type:int
Default Value:None
Flags:READABLE, WRITABLE

The assigned AgsAudio.Note providing default settings.

New in version 3.0.0.

AgsAudio.AudioSignal.props.output_soundcard
Name:output-soundcard
Type:GObject.Object
Default Value:None
Flags:READABLE, WRITABLE

The assigned output Ags.Soundcard providing default settings.

New in version 3.0.0.

AgsAudio.AudioSignal.props.output_soundcard_channel
Name:output-soundcard-channel
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The output soundcard channel.

New in version 3.0.0.

AgsAudio.AudioSignal.props.recall_id
Name:recall-id
Type:AgsAudio.RecallID
Default Value:None
Flags:READABLE, WRITABLE

The assigned AgsAudio.RecallID providing context.

New in version 3.0.0.

AgsAudio.AudioSignal.props.recycling
Name:recycling
Type:AgsAudio.Recycling
Default Value:None
Flags:READABLE, WRITABLE

The assigned AgsAudio.Recycling linking tree.

New in version 3.0.0.

AgsAudio.AudioSignal.props.rt_template
Name:rt-template
Type:AgsAudio.AudioSignal
Default Value:None
Flags:READABLE, WRITABLE

The assigned AgsAudio.AudioSignal realtime template.

New in version 3.0.0.

AgsAudio.AudioSignal.props.samplerate
Name:samplerate
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The samplerate to be used.

New in version 3.0.0.

AgsAudio.AudioSignal.props.stream
Name:stream
Type:int
Default Value:None
Flags:READABLE

The stream it contains.

New in version 3.0.0.

AgsAudio.AudioSignal.props.stream_current
Name:stream-current
Type:int
Default Value:None
Flags:READABLE

The current stream.

New in version 3.0.0.

AgsAudio.AudioSignal.props.stream_end
Name:stream-end
Type:int
Default Value:None
Flags:READABLE

The end of stream.

New in version 3.0.0.

AgsAudio.AudioSignal.props.template
Name:template
Type:AgsAudio.AudioSignal
Default Value:None
Flags:READABLE, WRITABLE

The assigned AgsAudio.AudioSignal template.

New in version 3.0.0.

AgsAudio.AudioSignal.props.timbre_end
Name:timbre-end
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The timbre’s end frame.

New in version 3.0.0.

AgsAudio.AudioSignal.props.timbre_start
Name:timbre-start
Type:int
Default Value:0
Flags:READABLE, WRITABLE

The timbre’s start frame.

New in version 3.0.0.

AgsAudio.AudioSignal.props.vibration
Name:vibration
Type:Ags.Complex
Default Value:None
Flags:READABLE, WRITABLE

Vibration of timbre.

New in version 3.0.0.

AgsAudio.AudioSignal.props.word_size
Name:word-size
Type:int
Default Value:0
Flags:READABLE

The word size of frame.

New in version 3.0.0.