Ags.FrameClock¶

Subclasses:: None

Methods¶

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

class	`get_instance` ()
class	`new` ()
	`copy_time` (source)
	`from_string` (str)
	`get_absolute_frame_offset` ()
	`get_absolute_note_256th_offset` ()
	`get_absolute_note_offset` ()
	`get_bpm` ()
	`get_buffer_size` ()
	`get_frame_offset` ()
	`get_has_16th_pulse` ()
	`get_has_256th_pulse` ()
	`get_loop` ()
	`get_note_256th_frame_offset` ()
	`get_note_256th_offset` ()
	`get_note_frame_offset` ()
	`get_note_offset` ()
	`get_samplerate` ()
	`get_start_note_offset` ()
	`increment_counter` ()
	`set_bpm` (bpm)
	`set_buffer_size` (buffer_size)
	`set_flags` (flags)
	`set_loop` (do_loop, loop_left, loop_right)
	`set_note_offset` (note_offset)
	`set_samplerate` (samplerate)
	`set_start_note_offset` (start_note_offset)
	`start` ()
	`stop` ()
	`test_flags` (flags)
	`to_string` ()
	`to_time_string` ()
	`unset_flags` (flags)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
absolute_delay	`object`	r
absolute_frame_offset	`int`	r
absolute_note_256th_offset	[`int`]	r
absolute_note_256th_offset_length	`int`	r
absolute_note_offset	`int`	r
bpm	`float`	r
buffer_size	`int`	r
delay_counter	`object`	r
do_loop	`bool`	r
fixed_absolute_delay	`object`	r
flags	`Ags.FrameClockFlags`	r
frame_offset	`int`	r
gobject	`GObject.Object`	r
has_16th_pulse	`bool`	r
has_256th_pulse	`bool`	r
loop_left	`int`	r
loop_right	`int`	r
note_256th_frame_offset	[`int`]	r
note_256th_frame_offset_length	`int`	r
note_256th_offset	[`int`]	r
note_256th_offset_length	`int`	r
note_frame_offset	`int`	r
note_offset	`int`	r
obj_mutex	`GLib.RecMutex`	r
period_frame_offset	`int`	r
samplerate	`int`	r
start_note_offset	`int`	r

Class Details¶

class Ags.FrameClock(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Ags.FrameClockClass

classmethod get_instance()¶

Returns:: the singleton Ags.FrameClock
Return type:: Ags.FrameClock

Singleton frame clock.

Added in version 9.0.0.

classmethod new()¶

Returns:: a new Ags.FrameClock
Return type:: Ags.FrameClock

Creates an Ags.FrameClock

Added in version 9.0.0.

copy_time(source)¶

Parameters:: source (Ags.FrameClock) – the source Ags.FrameClock

Copy time of source to self.

Added in version 9.0.0.

from_string(str)¶

Parameters:: str (str) – the string

Frame clock from string.

Added in version 9.0.0.

get_absolute_frame_offset()¶

Returns:: the absolute frame offset
Return type:: int

Get absolute frame offset of self.

Added in version 9.0.0.

get_absolute_note_256th_offset()¶

Returns:

absolute_note_256th_offset:: return location of note 256th offset, maximum length 16
length:: return location of length

Return type:

(absolute_note_256th_offset: int, length: int)

Get absolute note 256th offset of self.

Added in version 9.0.0.

get_absolute_note_offset()¶

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

Get absolute note offset of self.

Added in version 9.0.0.

get_bpm()¶

Returns:: the bpm
Return type:: float

Get bpm of self.

Added in version 9.0.0.

get_buffer_size()¶

Returns:: the buffer size
Return type:: int

Get buffer size of self.

Added in version 9.0.0.

get_frame_offset()¶

Returns:: the frame offset
Return type:: int

Get frame offset of self.

Added in version 9.0.0.

get_has_16th_pulse()¶

Returns:: True if has 16th pulse, otherwise False
Return type:: bool

Get has 16th pulse of self.

Added in version 9.0.0.

get_has_256th_pulse()¶

Returns:: True if has 256th pulse, otherwise False
Return type:: bool

Get has 256th pulse of self.

Added in version 9.0.0.

get_loop()¶

Returns:

True if do loop, otherwise False

loop_left:: return location of loop left
loop_right:: return location of loop right

Return type:

(bool, loop_left: int, loop_right: int)

Get loop of self.

Added in version 9.0.0.

get_note_256th_frame_offset()¶

Returns:

note_256th_frame_offset:: return location of note 256th frame offset
length:: return location of array length, maximum 16 items

Return type:

(note_256th_frame_offset: int, length: int)

Get note 256th frame offset of self.

Added in version 9.0.0.

get_note_256th_offset()¶

Returns:

note_256th_offset:: return location of note 256th offset, maximum length 16
length:: return location of length

Return type:

(note_256th_offset: int, length: int)

Get note 256th offset of self.

Added in version 9.0.0.

get_note_frame_offset()¶

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

Get note frame offset of self.

Added in version 9.0.0.

get_note_offset()¶

Returns:: the note offset
Return type:: int

Get note offset of self.

Added in version 9.0.0.

get_samplerate()¶

Returns:: the samplerate
Return type:: int

Get samplerate of self.

Added in version 9.0.0.

get_start_note_offset()¶

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

Get start note offset of self.

Added in version 9.0.0.

increment_counter()¶: Increment counter of self.

Added in version 9.0.0.

set_bpm(bpm)¶

Parameters:: bpm (float) – the bpm

Set bpm of self.

Added in version 9.0.0.

set_buffer_size(buffer_size)¶

Parameters:: buffer_size (int) – the buffer size

Set buffer size of self.

Added in version 9.0.0.

set_flags(flags)¶

Parameters:: flags (Ags.FrameClockFlags) – the flags

Set flags of self.

Added in version 9.0.0.

set_loop(do_loop, loop_left, loop_right)¶

Parameters:

do_loop (bool) – do loop if True, otherwise False
loop_left (int) – loop left
loop_right (int) – loop right

Get loop of self.

Added in version 9.0.0.

set_note_offset(note_offset)¶

Parameters:: note_offset (int) – the note offset

Set note offset of self.

Added in version 9.0.0.

set_samplerate(samplerate)¶

Parameters:: samplerate (int) – the samplerate

Set samplerate of self.

Added in version 9.0.0.

set_start_note_offset(start_note_offset)¶

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

Set start note offset of self.

Added in version 9.0.0.

start()¶: Start self.

Added in version 9.0.0.

stop()¶: Stop self.

Added in version 9.0.0.

test_flags(flags)¶

Parameters:: flags (Ags.FrameClockFlags) – the flags
Returns:: if flags set returning True otherwise False
Return type:: bool

Test flags to be set.

Added in version 9.0.0.

to_string()¶

Returns:: the serialized string
Return type:: str

Frame clock to string.

Added in version 9.0.0.

to_time_string()¶

Returns:: the time string
Return type:: str

Frame clock to time string.

Added in version 9.0.0.

unset_flags(flags)¶

Parameters:: flags (Ags.FrameClockFlags) – the flags

Unset flags of self.

Added in version 9.0.0.