Ags.Sequencer¶

Implementations:: None

Methods¶

	`get_bpm` ()
	`get_buffer` (buffer_length)
	`get_delay_factor` ()
	`get_device` ()
	`get_midi_version` ()
	`get_next_buffer` (buffer_length)
	`get_note_offset` ()
	`get_start_note_offset` ()
	`is_playing` ()
	`is_recording` ()
	`is_starting` ()
	`list_cards` ()
	`lock_buffer` (buffer)
	`offset_changed` (note_offset)
	`play` ()
	`play_init` ()
	`record` ()
	`record_init` ()
	`set_bpm` (bpm)
	`set_delay_factor` (delay_factor)
	`set_device` (card_id)
	`set_note_offset` (note_offset)
	`set_start_note_offset` (start_note_offset)
	`stop` ()
	`tic` ()
	`unlock_buffer` (buffer)

Virtual Methods¶

	`do_get_bpm` ()
	`do_get_buffer` (buffer_length)
	`do_get_delay_factor` ()
	`do_get_device` ()
	`do_get_midi_version` ()
	`do_get_next_buffer` (buffer_length)
	`do_get_note_offset` ()
	`do_get_start_note_offset` ()
	`do_is_playing` ()
	`do_is_recording` ()
	`do_is_starting` ()
	`do_list_cards` ()
	`do_lock_buffer` (buffer)
	`do_offset_changed` (note_offset)
	`do_play` ()
	`do_play_init` ()
	`do_record` ()
	`do_record_init` ()
	`do_set_bpm` (bpm)
	`do_set_delay_factor` (delay_factor)
	`do_set_device` (card_id)
	`do_set_midi_version` (midi_version)
	`do_set_note_offset` (note_offset)
	`do_set_start_note_offset` (start_note_offset)
	`do_stop` ()
	`do_tic` ()
	`do_unlock_buffer` (buffer)

Properties¶

None

Signals¶

Name	Short Description
`offset-changed`	The `::offset-changed` signal notifies about changed position within notation.
`tic`	The `::tic` signal is emitted every tic of the sequencer.

Fields¶

None

Class Details¶

class Ags.Sequencer¶

Bases:: GObject.GInterface
Structure:: Ags.SequencerInterface

get_bpm()¶

Returns:: bpm
Return type:: float

Get current playback bpm.

New in version 3.0.0.

get_buffer(buffer_length)¶

Parameters:: buffer_length (int) – the buffer’s length
Returns:: current playback buffer
Return type:: object or None

Get current playback buffer.

New in version 3.0.0.

get_delay_factor()¶

Returns:: delay factor
Return type:: float

Get current playback delay factor.

New in version 3.0.0.

get_device()¶

Returns:: the device’s identifier
Return type:: str

Get device.

New in version 3.0.0.

get_midi_version()¶

Returns:: the MIDI version
Return type:: Ags.SequencerMidiVersion

Get MIDI version.

New in version 7.0.0.

get_next_buffer(buffer_length)¶

Parameters:: buffer_length (int) – the buffer’s length
Returns:: next playback buffer
Return type:: object or None

Get future playback buffer.

New in version 3.0.0.

get_note_offset()¶

Returns:: offset
Return type:: int

Get current playback note offset.

New in version 3.0.0.

get_start_note_offset()¶

Returns:: the start note offset
Return type:: int

Get start playback note offset.

New in version 3.0.0.

is_playing()¶

Returns:: True if playing, else False
Return type:: bool

Get playing.

New in version 3.0.0.

is_recording()¶

Returns:: True if recording, else False
Return type:: bool

Get recording.

New in version 3.0.0.

is_starting()¶

Returns:: True if starting, else False
Return type:: bool

Get starting.

New in version 3.0.0.

list_cards()¶

Returns:

card_id:: a list containing card ids
card_name:: a list containing card names

Return type:

(card_id: [str], card_name: [str])

Retrieve card_id and card_name as a list of strings.

New in version 3.0.0.

lock_buffer(buffer)¶

Parameters:: buffer (object or None) – the buffer to lock

Lock buffer.

New in version 3.0.0.

offset_changed(note_offset)¶

Parameters:: note_offset (int) – the note offset

Callback when counter expires minor note offset.

New in version 3.0.0.

play()¶

Raises:: GLib.Error

Plays the current buffer of sequencer.

New in version 3.0.0.

play_init()¶

Raises:: GLib.Error

Initializes the sequencer for playback.

New in version 3.0.0.

record()¶

Raises:: GLib.Error

Records the current buffer of sequencer.

New in version 3.0.0.

record_init()¶

Raises:: GLib.Error

Initializes the sequencer for recording.

New in version 3.0.0.

set_bpm(bpm)¶

Parameters:: bpm (float) – the bpm to set

Set current playback bpm.

New in version 3.0.0.

set_delay_factor(delay_factor)¶

Parameters:: delay_factor (float) – the delay factor to set

Set current playback delay factor.

New in version 3.0.0.

set_device(card_id)¶

Parameters:: card_id (str) – the device to set

Set device.

New in version 3.0.0.

set_note_offset(note_offset)¶

Parameters:: note_offset (int) – the note offset to set

Set current playback note offset.

New in version 3.0.0.

set_start_note_offset(start_note_offset)¶

Parameters:: start_note_offset (int) – the start note offset to set

Set start playback note offset.

New in version 3.0.0.

stop()¶: Stops the sequencer from playing to it.

New in version 3.0.0.

tic()¶: Every call to play may generate a tic.

New in version 3.0.0.

unlock_buffer(buffer)¶

Parameters:: buffer (object or None) – the buffer to unlock

Unlock buffer.

New in version 3.0.0.

do_get_bpm() virtual¶

Returns:: bpm
Return type:: float

Get current playback bpm.

New in version 3.0.0.

do_get_buffer(buffer_length) virtual¶

Parameters:: buffer_length (int) – the buffer’s length
Returns:: current playback buffer
Return type:: object or None

Get current playback buffer.

New in version 3.0.0.

do_get_delay_factor() virtual¶

Returns:: delay factor
Return type:: float

Get current playback delay factor.

New in version 3.0.0.

do_get_device() virtual¶

Returns:: the device’s identifier
Return type:: str

Get device.

New in version 3.0.0.

do_get_midi_version() virtual¶

Returns:: the MIDI version
Return type:: Ags.SequencerMidiVersion

Get MIDI version.

New in version 7.0.0.

do_get_next_buffer(buffer_length) virtual¶

Parameters:: buffer_length (int) – the buffer’s length
Returns:: next playback buffer
Return type:: object or None

Get future playback buffer.

New in version 3.0.0.

do_get_note_offset() virtual¶

Returns:: offset
Return type:: int

Get current playback note offset.

New in version 3.0.0.

do_get_start_note_offset() virtual¶

Returns:: the start note offset
Return type:: int

Get start playback note offset.

New in version 3.0.0.

do_is_playing() virtual¶

Returns:: True if playing, else False
Return type:: bool

Get playing.

New in version 3.0.0.

do_is_recording() virtual¶

Returns:: True if recording, else False
Return type:: bool

Get recording.

New in version 3.0.0.

do_is_starting() virtual¶

Returns:: True if starting, else False
Return type:: bool

Get starting.

New in version 3.0.0.

do_list_cards() virtual¶

Returns:

card_id:: a list containing card ids
card_name:: a list containing card names

Return type:

(card_id: [str], card_name: [str])

Retrieve card_id and card_name as a list of strings.

New in version 3.0.0.

do_lock_buffer(buffer) virtual¶

Parameters:: buffer (object or None) – the buffer to lock

Lock buffer.

New in version 3.0.0.

do_offset_changed(note_offset) virtual¶

Parameters:: note_offset (int) – the note offset

Callback when counter expires minor note offset.

New in version 3.0.0.

do_play() virtual¶: Plays the current buffer of sequencer.

New in version 3.0.0.

do_play_init() virtual¶: Initializes the sequencer for playback.

New in version 3.0.0.

do_record() virtual¶: Records the current buffer of sequencer.

New in version 3.0.0.

do_record_init() virtual¶: Initializes the sequencer for recording.

New in version 3.0.0.

do_set_bpm(bpm) virtual¶

Parameters:: bpm (float) – the bpm to set

Set current playback bpm.

New in version 3.0.0.

do_set_delay_factor(delay_factor) virtual¶

Parameters:: delay_factor (float) – the delay factor to set

Set current playback delay factor.

New in version 3.0.0.

do_set_device(card_id) virtual¶

Parameters:: card_id (str) – the device to set

Set device.

New in version 3.0.0.

do_set_midi_version(midi_version) virtual¶

Parameters:: midi_version (Ags.SequencerMidiVersion) –

do_set_note_offset(note_offset) virtual¶

Parameters:: note_offset (int) – the note offset to set

Set current playback note offset.

New in version 3.0.0.

do_set_start_note_offset(start_note_offset) virtual¶

Parameters:: start_note_offset (int) – the start note offset to set

Set start playback note offset.

New in version 3.0.0.

do_stop() virtual¶: Stops the sequencer from playing to it.

New in version 3.0.0.

do_tic() virtual¶: Every call to play may generate a tic.

New in version 3.0.0.

do_unlock_buffer(buffer) virtual¶

Parameters:: buffer (object or None) – the buffer to unlock

Unlock buffer.

New in version 3.0.0.

Signal Details¶

Ags.Sequencer.signals.offset_changed(sequencer, note_offset)¶

Signal Name:

offset-changed

Flags:

RUN_LAST

Parameters:

sequencer (Ags.Sequencer) – The object which received the signal
note_offset (int) – new notation offset

The ::offset-changed signal notifies about changed position within notation.

New in version 3.0.0.

Ags.Sequencer.signals.tic(sequencer)¶

Signal Name:: tic
Flags:: RUN_LAST
Parameters:: sequencer (Ags.Sequencer) – The object which received the signal

The ::tic signal is emitted every tic of the sequencer. This notifies about a newly played buffer.

New in version 3.0.0.