Functions

  buffer_util_char_buffer_read_complex (cbuffer, byte_order)
  buffer_util_char_buffer_read_double (cbuffer, byte_order)
  buffer_util_char_buffer_read_float (cbuffer, byte_order)
  buffer_util_char_buffer_read_s16 (cbuffer, byte_order)
  buffer_util_char_buffer_read_s24 (cbuffer, byte_order)
  buffer_util_char_buffer_read_s32 (cbuffer, byte_order)
  buffer_util_char_buffer_read_s64 (cbuffer, byte_order)
  buffer_util_char_buffer_read_s8 (cbuffer, byte_order)
  buffer_util_char_buffer_swap_bytes (cbuffer, word_size, buffer_size)
  buffer_util_char_buffer_to_complex (cbuffer, buffer_size)
  buffer_util_char_buffer_to_double (cbuffer, buffer_size)
  buffer_util_char_buffer_to_float (cbuffer, buffer_size)
  buffer_util_char_buffer_to_s16 (cbuffer, buffer_size)
  buffer_util_char_buffer_to_s24 (cbuffer, buffer_size)
  buffer_util_char_buffer_to_s32 (cbuffer, buffer_size)
  buffer_util_char_buffer_to_s64 (cbuffer, buffer_size)
  buffer_util_char_buffer_to_s8 (cbuffer, buffer_size)
  buffer_util_char_buffer_write_complex (cbuffer, value, byte_order)
  buffer_util_char_buffer_write_double (cbuffer, value, byte_order)
  buffer_util_char_buffer_write_float (cbuffer, value, byte_order)
  buffer_util_char_buffer_write_s16 (cbuffer, value, byte_order)
  buffer_util_char_buffer_write_s24 (cbuffer, value, byte_order)
  buffer_util_char_buffer_write_s32 (cbuffer, value, byte_order)
  buffer_util_char_buffer_write_s64 (cbuffer, value, byte_order)
  buffer_util_char_buffer_write_s8 (cbuffer, value, byte_order)
  buffer_util_complex_to_char_buffer (buffer, buffer_length)
  buffer_util_double_to_char_buffer (buffer, buffer_length)
  buffer_util_float_to_char_buffer (buffer, buffer_length)
  buffer_util_s16_to_char_buffer (buffer, buffer_length)
  buffer_util_s24_to_char_buffer (buffer, buffer_length)
  buffer_util_s32_to_char_buffer (buffer, buffer_length)
  buffer_util_s64_to_char_buffer (buffer, buffer_length)
  buffer_util_s8_to_char_buffer (buffer, buffer_length)
  cclosure_marshal_BOOLEAN__OBJECT_OBJECT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_BOOLEAN__POINTER_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_BOOLEAN__UINT_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_BOOLEAN__VOID (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_DOUBLE__DOUBLE_BOOLEAN (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_INT64__OBJECT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_INT__VOID (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_OBJECT__OBJECT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_OBJECT__OBJECT_OBJECT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_OBJECT__OBJECT_POINTER_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_OBJECT__OBJECT_POINTER_POINTER_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_OBJECT__STRING_STRING_STRING (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_OBJECT__UINT_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_OBJECT__VOID (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__INT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__INT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__OBJECT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__OBJECT_OBJECT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__OBJECT_POINTER_INT64 (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__OBJECT_POINTER_OBJECT_OBJECT_STRING_STRING_STRING (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__OBJECT_POINTER_POINTER_OBJECT_STRING_STRING_STRING (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__OBJECT_POINTER_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__OBJECT_STRING_STRING_STRING_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__OBJECT_STRING_STRING_STRING_STRING_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__OBJECT_STRING_STRING_STRING_STRING_UINT_POINTER_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__OBJECT_STRING_STRING_STRING_UINT_POINTER_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__POINTER_POINTER_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__POINTER_STRING_STRING (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__POINTER_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__STRING_STRING (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__STRING_STRING_STRING (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__STRING_STRING_STRING_STRING (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__UINT_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__UINT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__ULONG_POINTER_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__ULONG_UINT_POINTER_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_POINTER__VOID (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_STRING__STRING_STRING (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_STRING__ULONG_STRING_STRING_STRING_STRING_UINT_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_UINT__INT_UINT_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_UINT__VOID (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_ULONG__VOID (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__BOOLEAN_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__DOUBLE_DOUBLE (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__INT64_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__INT_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__INT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__INT_UINT_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__OBJECT_OBJECT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__OBJECT_OBJECT_OBJECT_INT_BOOLEAN (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__OBJECT_OBJECT_OBJECT_OBJECT_OBJECT_OBJECT_OBJECT_OBJECT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__OBJECT_OBJECT_OBJECT_OBJECT_OBJECT_OBJECT_UINT_INT_BOOLEAN (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__OBJECT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__OBJECT_UINT_UINT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__POINTER_INT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__POINTER_INT_INT_BOOLEAN (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__POINTER_INT_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__POINTER_OBJECT_OBJECT_STRING_STRING_STRING_UINT_UINT_UINT_UINT_INT_UINT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__POINTER_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__POINTER_POINTER_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__POINTER_POINTER_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__POINTER_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__POINTER_UINT_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__POINTER_UINT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__STRING_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__STRING_STRING_STRING (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__STRING_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__STRING_UINT_DOUBLE (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__STRING_UINT_POINTER (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__STRING_UINT_STRING_DOUBLE (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT64 (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_BOOLEAN (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_DOUBLE (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_DOUBLE_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_INT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_POINTER_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_STRING_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_UINT_BOOLEAN (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_UINT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_UINT_UINT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_UINT_UINT_UINT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_UINT_UINT_UINT_UINT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__UINT_UINT_UINT_UINT_UINT_UINT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__ULONG_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__ULONG_UINT_BOOLEAN (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  cclosure_marshal_VOID__ULONG_UINT_UINT (closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
  complex_alloc ()
  controller_resource_alloc (group_id, user_id, access_mode)
  controller_resource_free (controller_resource)
  controller_resource_ref (controller_resource)
  controller_resource_unref (controller_resource)
  destroy_entry_alloc (ptr, destroy_func)
  destroy_util_dispose_and_unref (gobject)
  endian_host_is_be ()
  endian_host_is_le ()
  endian_swap_float (x)
  globals_get (key)
  globals_get_hash_table ()
  globals_set (key, value)
  id_generator_create_uuid ()
  list_util_find_type (list, gtype)
  login_info_alloc ()
  login_info_free (login_info)
  login_info_ref (login_info)
  login_info_unref (login_info)
  math_util_find_exponent_parenthesis (str)
  math_util_find_function (str)
  math_util_find_function_parenthesis (str)
  math_util_find_parenthesis_all (str)
  math_util_find_symbol (str)
  math_util_find_term_parenthesis (str)
  math_util_is_term (term)
  math_util_split_polynomial (polynomial)
  math_util_split_sum (sum)
  plugin_read (file, node, plugin)
  plugin_write (file, parent, plugin)
  soundcard_helper_config_get_buffer_size (config)
  soundcard_helper_config_get_dsp_channels (config)
  soundcard_helper_config_get_format (config)
  soundcard_helper_config_get_pcm_channels (config)
  soundcard_helper_config_get_samplerate (config)
  string_util_escape_single_quote (str)
  strv_contains (str_array, str)
  strv_equal (strv1, strv2)
  strv_index (str_array, str)
  strv_length (str_array)
  time_get_uptime_from_offset (offset, bpm, delay, delay_factor)
  time_timeout_expired (start_time, timeout_delay)
  uuid_alloc ()
  uuid_from_string (str)
  woker_thread_do_poll_loop (ptr)

Details

Ags.buffer_util_char_buffer_read_complex(cbuffer, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • byte_order (int) – reverse order
Returns:

the Ags.Complex value

Return type:

Ags.Complex

Read a Ags.Complex quantity of cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_read_double(cbuffer, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • byte_order (int) – reverse order
Returns:

the float value

Return type:

float

Read a float quantity of cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_read_float(cbuffer, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • byte_order (int) – reverse order
Returns:

the float value

Return type:

float

Read a float quantity of cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_read_s16(cbuffer, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • byte_order (int) – reverse order
Returns:

the gint16 value

Return type:

int

Read a gint16 quantity of cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_read_s24(cbuffer, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • byte_order (int) – reverse order
Returns:

the gint32 value

Return type:

int

Read a gint32 24 bit quantity of cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_read_s32(cbuffer, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • byte_order (int) – reverse order
Returns:

the gint32 value

Return type:

int

Read a gint32 32 bit quantity of cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_read_s64(cbuffer, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • byte_order (int) – reverse order
Returns:

the gint64 value

Return type:

int

Read a gint64 64 bit quantity of cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_read_s8(cbuffer, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • byte_order (int) – reverse order, ignored here
Returns:

the gint8 value

Return type:

int

Read a gint8 quantity of cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_swap_bytes(cbuffer, word_size, buffer_size)
Parameters:
  • cbuffer (int) – the buffer to swap
  • word_size (int) – the word size
  • buffer_size (int) – the buffer size

Swap bytes in view of Little/Big-Endian.

New in version 3.0.0.

Ags.buffer_util_char_buffer_to_complex(cbuffer, buffer_size)
Parameters:
  • cbuffer (int) – the guchar buffer
  • buffer_size (int) – the buffer size
Returns:

the Ags.Complex buffer

Return type:

Ags.Complex

Unpack cbuffer to a Ags.Complex buffer

New in version 3.0.0.

Ags.buffer_util_char_buffer_to_double(cbuffer, buffer_size)
Parameters:
  • cbuffer (int) – the guchar buffer
  • buffer_size (int) – the buffer size
Returns:

the float buffer

Return type:

float

Unpack cbuffer to a float buffer

New in version 3.0.0.

Ags.buffer_util_char_buffer_to_float(cbuffer, buffer_size)
Parameters:
  • cbuffer (int) – the guchar buffer
  • buffer_size (int) – the buffer size
Returns:

the float buffer

Return type:

float

Unpack cbuffer to a float buffer

New in version 3.0.0.

Ags.buffer_util_char_buffer_to_s16(cbuffer, buffer_size)
Parameters:
  • cbuffer (int) – the guchar buffer
  • buffer_size (int) – the buffer size
Returns:

the gint16 buffer

Return type:

int

Unpack cbuffer to a gint16 buffer

New in version 3.0.0.

Ags.buffer_util_char_buffer_to_s24(cbuffer, buffer_size)
Parameters:
  • cbuffer (int) – the guchar buffer
  • buffer_size (int) – the buffer size
Returns:

the gint32 buffer

Return type:

int

Unpack cbuffer to a gint32 buffer

New in version 3.0.0.

Ags.buffer_util_char_buffer_to_s32(cbuffer, buffer_size)
Parameters:
  • cbuffer (int) – the guchar buffer
  • buffer_size (int) – the buffer size
Returns:

the gint32 buffer

Return type:

int

Unpack cbuffer to a gint32 buffer

New in version 3.0.0.

Ags.buffer_util_char_buffer_to_s64(cbuffer, buffer_size)
Parameters:
  • cbuffer (int) – the guchar buffer
  • buffer_size (int) – the buffer size
Returns:

the gint64 buffer

Return type:

int

Unpack cbuffer to a gint64 buffer

New in version 3.0.0.

Ags.buffer_util_char_buffer_to_s8(cbuffer, buffer_size)
Parameters:
  • cbuffer (int) – the guchar buffer
  • buffer_size (int) – the buffer size
Returns:

the gint8 buffer

Return type:

int

Unpack cbuffer to a gint8 buffer

New in version 3.0.0.

Ags.buffer_util_char_buffer_write_complex(cbuffer, value, byte_order)
Parameters:

Write a Ags.Complex quantity to cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_write_double(cbuffer, value, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • value (float) – the float value
  • byte_order (int) – reverse order

Write a float quantity to cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_write_float(cbuffer, value, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • value (float) – the float value
  • byte_order (int) – reverse order

Write a float quantity to cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_write_s16(cbuffer, value, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • value (int) – the gint16 value
  • byte_order (int) – reverse order

Write a gint16 quantity to cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_write_s24(cbuffer, value, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • value (int) – the gint32 value
  • byte_order (int) – reverse order

Write a gint32 quantity to cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_write_s32(cbuffer, value, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • value (int) – the gint32 value
  • byte_order (int) – reverse order

Write a gint32 quantity to cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_write_s64(cbuffer, value, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • value (int) – the gint64 value
  • byte_order (int) – reverse order

Write a gint64 quantity to cbuffer.

New in version 3.0.0.

Ags.buffer_util_char_buffer_write_s8(cbuffer, value, byte_order)
Parameters:
  • cbuffer (int) – the character buffer
  • value (int) – the gint8 value
  • byte_order (int) – reverse order

Write a gint8 quantity to cbuffer.

New in version 3.0.0.

Ags.buffer_util_complex_to_char_buffer(buffer, buffer_length)
Parameters:
Returns:

the guchar buffer

Return type:

int

Pack buffer into an guchar buffer.

New in version 3.0.0.

Ags.buffer_util_double_to_char_buffer(buffer, buffer_length)
Parameters:
  • buffer (float) – the float buffer
  • buffer_length (int) – the buffer length
Returns:

the guchar buffer

Return type:

int

Pack buffer into an guchar buffer.

New in version 3.0.0.

Ags.buffer_util_float_to_char_buffer(buffer, buffer_length)
Parameters:
  • buffer (float) – the float buffer
  • buffer_length (int) – the buffer length
Returns:

the guchar buffer

Return type:

int

Pack buffer into an guchar buffer.

New in version 3.0.0.

Ags.buffer_util_s16_to_char_buffer(buffer, buffer_length)
Parameters:
  • buffer (int) – the gint16 buffer
  • buffer_length (int) – the buffer length
Returns:

the guchar buffer

Return type:

int

Pack buffer into an guchar buffer.

New in version 3.0.0.

Ags.buffer_util_s24_to_char_buffer(buffer, buffer_length)
Parameters:
  • buffer (int) – the gint32 buffer
  • buffer_length (int) – the buffer length
Returns:

the guchar buffer

Return type:

int

Pack buffer into an guchar buffer.

New in version 3.0.0.

Ags.buffer_util_s32_to_char_buffer(buffer, buffer_length)
Parameters:
  • buffer (int) – the gint32 buffer
  • buffer_length (int) – the buffer length
Returns:

the guchar buffer

Return type:

int

Pack buffer into an guchar buffer.

New in version 3.0.0.

Ags.buffer_util_s64_to_char_buffer(buffer, buffer_length)
Parameters:
  • buffer (int) – the gint64 buffer
  • buffer_length (int) – the buffer length
Returns:

the guchar buffer

Return type:

int

Pack buffer into an guchar buffer.

New in version 3.0.0.

Ags.buffer_util_s8_to_char_buffer(buffer, buffer_length)
Parameters:
  • buffer (int) – the gint8 buffer
  • buffer_length (int) – the buffer length
Returns:

the guchar buffer

Return type:

int

Pack buffer into an guchar buffer.

New in version 3.0.0.

Ags.cclosure_marshal_BOOLEAN__OBJECT_OBJECT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_BOOLEAN__POINTER_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_BOOLEAN__UINT_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_BOOLEAN__VOID(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_DOUBLE__DOUBLE_BOOLEAN(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_INT64__OBJECT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_INT__VOID(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_OBJECT__OBJECT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_OBJECT__OBJECT_OBJECT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_OBJECT__OBJECT_POINTER_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_OBJECT__OBJECT_POINTER_POINTER_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_OBJECT__STRING_STRING_STRING(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_OBJECT__UINT_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_OBJECT__VOID(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__INT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__INT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__OBJECT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__OBJECT_OBJECT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__OBJECT_POINTER_INT64(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__OBJECT_POINTER_OBJECT_OBJECT_STRING_STRING_STRING(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__OBJECT_POINTER_POINTER_OBJECT_STRING_STRING_STRING(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__OBJECT_POINTER_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__OBJECT_STRING_STRING_STRING_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__OBJECT_STRING_STRING_STRING_STRING_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__OBJECT_STRING_STRING_STRING_STRING_UINT_POINTER_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__OBJECT_STRING_STRING_STRING_UINT_POINTER_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__POINTER_POINTER_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__POINTER_STRING_STRING(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__POINTER_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__STRING_STRING(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__STRING_STRING_STRING(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__STRING_STRING_STRING_STRING(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__UINT_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__UINT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__ULONG_POINTER_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__ULONG_UINT_POINTER_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_POINTER__VOID(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_STRING__STRING_STRING(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_STRING__ULONG_STRING_STRING_STRING_STRING_UINT_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_UINT__INT_UINT_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_UINT__VOID(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_ULONG__VOID(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__BOOLEAN_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__DOUBLE_DOUBLE(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__INT64_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__INT_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__INT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__INT_UINT_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__OBJECT_OBJECT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__OBJECT_OBJECT_OBJECT_INT_BOOLEAN(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__OBJECT_OBJECT_OBJECT_OBJECT_OBJECT_OBJECT_OBJECT_OBJECT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__OBJECT_OBJECT_OBJECT_OBJECT_OBJECT_OBJECT_UINT_INT_BOOLEAN(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__OBJECT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__OBJECT_UINT_UINT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__POINTER_INT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__POINTER_INT_INT_BOOLEAN(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__POINTER_INT_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__POINTER_OBJECT_OBJECT_STRING_STRING_STRING_UINT_UINT_UINT_UINT_INT_UINT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__POINTER_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__POINTER_POINTER_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__POINTER_POINTER_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__POINTER_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__POINTER_UINT_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__POINTER_UINT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__STRING_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__STRING_STRING_STRING(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__STRING_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__STRING_UINT_DOUBLE(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__STRING_UINT_POINTER(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__STRING_UINT_STRING_DOUBLE(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT64(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_BOOLEAN(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_DOUBLE(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_DOUBLE_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_INT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_POINTER_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_STRING_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_UINT_BOOLEAN(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_UINT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_UINT_UINT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_UINT_UINT_UINT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_UINT_UINT_UINT_UINT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__UINT_UINT_UINT_UINT_UINT_UINT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__ULONG_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__ULONG_UINT_BOOLEAN(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.cclosure_marshal_VOID__ULONG_UINT_UINT(closure, return_value, n_param_values, param_values, invocation_hint, marshal_data)
Parameters:
Ags.complex_alloc()
Returns:a new Ags.Complex
Return type:Ags.Complex

Allocate Ags.Complex

New in version 3.0.0.

Ags.controller_resource_alloc(group_id, user_id, access_mode)
Parameters:
  • group_id (str) – the group id
  • user_id (str) – the user id
  • access_mode (int) – the access mode
Returns:

the newly allocated Ags.ControllerResource-struct

Return type:

object or None

Allocated Ags.ControllerResource-struct.

New in version 3.0.0.

Ags.controller_resource_free(controller_resource)
Parameters:controller_resource (object or None) – the Ags.ControllerResource-struct

Free controller_resource.

New in version 3.0.0.

Ags.controller_resource_ref(controller_resource)
Parameters:controller_resource (object or None) – the Ags.ControllerResource-struct

Increase ref-count of controller_resource.

New in version 3.0.0.

Ags.controller_resource_unref(controller_resource)
Parameters:controller_resource (object or None) – the Ags.ControllerResource-struct

Decrease ref-count of controller_resource and free it if ref-count drops to 0.

New in version 3.0.0.

Ags.destroy_entry_alloc(ptr, destroy_func)
Parameters:
Returns:

the allocated Ags.DestroyEntry

Return type:

object or None

Allocated a destroy entry.

New in version 3.0.0.

Ags.destroy_util_dispose_and_unref(gobject)
Parameters:gobject (GObject.Object) – the GObject.Object to destroy

Run dispose and unref gobject.

New in version 3.0.0.

Ags.endian_host_is_be()
Returns:True if BE, otherwise False
Return type:bool

Check host is Big Endian.

New in version 3.0.0.

Ags.endian_host_is_le()
Returns:True if LE, otherwise False
Return type:bool

Check host is Little Endian.

New in version 3.0.0.

Ags.endian_swap_float(x)
Parameters:x (float) – the float to swap
Returns:the byte-swapped float
Return type:float

Swaps the floating point numbers endianness.

New in version 3.0.0.

Ags.globals_get(key)
Parameters:key (str) – the key as string
Returns:the GObject.Value-struct if key found, otherwise None
Return type:GObject.Value

Get global value for key.

New in version 3.0.0.

Ags.globals_get_hash_table()
Returns:the GLib.HashTable containig globals
Return type:{str: GObject.Value}

Get globals hash table.

New in version 3.0.0.

Ags.globals_set(key, value)
Parameters:

Set global key/value.

New in version 3.0.0.

Ags.id_generator_create_uuid()
Returns:the UUID as string
Return type:str

Creates a new string containing an UUID.

New in version 3.0.0.

Ags.list_util_find_type(list, gtype)
Parameters:
Returns:

the next matching GLib.List-struct

Return type:

[GObject.Object]

Find gtype within list.

New in version 3.0.0.

Ags.login_info_alloc()
Returns:the newly allocated Ags.LoginInfo-struct
Return type:object or None

Alloc Ags.LoginInfo-struct.

New in version 3.0.0.

Ags.login_info_free(login_info)
Parameters:login_info (object or None) – the Ags.LoginInfo-struct

Free login_info.

New in version 3.0.0.

Ags.login_info_ref(login_info)
Parameters:login_info (object or None) – the Ags.LoginInfo-struct

Increase ref-count of login_info.

New in version 3.0.0.

Ags.login_info_unref(login_info)
Parameters:login_info (object or None) – the Ags.LoginInfo-struct

Decrease ref-count of login_info and free it if ref-count drops to 0.

New in version 3.0.0.

Ags.math_util_find_exponent_parenthesis(str)
Parameters:str (str) – the string
Returns:
exponent_open_position:
 exponent open position array return location
exponent_close_position:
 exponent close position array return location
exponent_open_position_count:
 exponent open position count return location
exponent_close_position_count:
 exponent close position count return location
Return type:(exponent_open_position: int, exponent_close_position: int, exponent_open_position_count: int, exponent_close_position_count: int)

Find exponent parenthesis.

New in version 3.2.0.

Ags.math_util_find_function(str)
Parameters:str (str) – the string
Returns:the string offset matching function, otherwise None
Return type:str

Find next function.

New in version 3.2.0.

Ags.math_util_find_function_parenthesis(str)
Parameters:str (str) – the string
Returns:
function_open_position:
 function open position array return location
function_close_position:
 function close position array return location
function_open_position_count:
 function open position count return location
function_close_position_count:
 function close position count return location
Return type:(function_open_position: int, function_close_position: int, function_open_position_count: int, function_close_position_count: int)

Find function parenthesis.

New in version 3.2.0.

Ags.math_util_find_parenthesis_all(str)
Parameters:str (str) – the string
Returns:
open_position:open position array return location
close_position:close position array return location
open_position_count:
 open position count return location
close_position_count:
 close position count return location
Return type:(open_position: int, close_position: int, open_position_count: int, close_position_count: int)

Find all parenthesis.

New in version 3.2.0.

Ags.math_util_find_symbol(str)
Parameters:str (str) – the string
Returns:the string offset matching symbol, otherwise None
Return type:str

Find next symbol.

New in version 3.2.0.

Ags.math_util_find_term_parenthesis(str)
Parameters:str (str) – the string
Returns:
term_open_position:
 term open position array return location
term_close_position:
 term close position array return location
term_open_position_count:
 term open position count return location
term_close_position_count:
 term close position count return location
Return type:(term_open_position: int, term_close_position: int, term_open_position_count: int, term_close_position_count: int)

Find term parenthesis.

New in version 3.2.0.

Ags.math_util_is_term(term)
Parameters:term (str) – the term
Returns:True on success, otherwise False
Return type:bool

Test if term is a term.

New in version 3.2.0.

Ags.math_util_split_polynomial(polynomial)
Parameters:polynomial (str) – the polynomial
Returns:
factor:the return location of factors
factor_exponent:
 the return location of factor exponents
Return type:(factor: str, factor_exponent: str)

Split polynomial into coefficient, powers of symbols and summand.

New in version 3.2.0.

Ags.math_util_split_sum(sum)
Parameters:sum (str) – the sum
Returns:the return location of summands
Return type:summand: str

Split sum into summands.

New in version 3.2.0.

Ags.plugin_read(file, node, plugin)
Parameters:

Read of file.

New in version 3.0.0.

Ags.plugin_write(file, parent, plugin)
Parameters:
Returns:

the new node you created

Return type:

libxml2.Node

Write to file.

New in version 3.0.0.

Ags.soundcard_helper_config_get_buffer_size(config)
Parameters:config (Ags.Config) – the Ags.Config
Returns:the buffer size
Return type:int

Get buffer size.

New in version 3.0.0.

Ags.soundcard_helper_config_get_dsp_channels(config)
Parameters:config (Ags.Config) – the Ags.Config
Returns:the count of dsp channels
Return type:int

Get dsp channels count.

New in version 3.0.0.

Ags.soundcard_helper_config_get_format(config)
Parameters:config (Ags.Config) – the Ags.Config
Returns:the format
Return type:int

Get format as Ags.SoundcardFormat-enum.

New in version 3.0.0.

Ags.soundcard_helper_config_get_pcm_channels(config)
Parameters:config (Ags.Config) – the Ags.Config
Returns:the count of pcm channels
Return type:int

Get pcm channels count.

New in version 3.0.0.

Ags.soundcard_helper_config_get_samplerate(config)
Parameters:config (Ags.Config) – the Ags.Config
Returns:the samplerate
Return type:float

Get samplerate.

New in version 3.0.0.

Ags.string_util_escape_single_quote(str)
Parameters:str (str) – the string to escape
Returns:the newly allocated string
Return type:str

Escape all occurence of single quotes.

New in version 3.0.0.

Ags.strv_contains(str_array, str)
Parameters:
  • str_array ([str]) – the string vector
  • str (str) – the string to match
Returns:

True if found, else False

Return type:

bool

Check occurence of str within str_array

New in version 3.0.0.

Ags.strv_equal(strv1, strv2)
Parameters:
  • strv1 (str) – the string vector
  • strv2 (str) – an other string vector
Returns:

True on success, otherwise False

Return type:

bool

Check strv1 and strv2 to be equal. The arrays don’t have to be sorted.

New in version 3.2.1.

Ags.strv_index(str_array, str)
Parameters:
  • str_array ([str]) – the string vector
  • str (str) – the string to match
Returns:

the first matching position or -1, if not found

Return type:

int

Check by comparing str against str_array items.

New in version 3.0.0.

Ags.strv_length(str_array)
Parameters:str_array ([str]) – the string vector
Returns:the length of the vector
Return type:int

Count the number of non-None entries in the array.

New in version 3.0.0.

Ags.time_get_uptime_from_offset(offset, bpm, delay, delay_factor)
Parameters:
  • offset (int) – the offset in tics
  • bpm (float) – the beats per minute
  • delay (float) – the buffer time as delay
  • delay_factor (float) – tact segmentation
Returns:

the string containing the time, a minus sign is prepend if factors are invalid

Return type:

str

Calculates uptime from offset by applying factors bpm, delay and delay_factor giving you the result as string.

New in version 3.0.0.

Ags.time_timeout_expired(start_time, timeout_delay)
Parameters:
  • start_time (object or None) – the start time #timespec-struct
  • timeout_delay (object or None) – the delay #timespec-struct
Returns:

True if timeout expired, otherwise False

Return type:

bool

Check start_time plus timeout_delay against current time.

New in version 3.0.0.

Ags.uuid_alloc()
Returns:a new Ags.UUID
Return type:Ags.UUID

Allocate Ags.UUID.

New in version 3.0.0.

Ags.uuid_from_string(str)
Parameters:str (str) – the UUID as string
Returns:the new Ags.UUID on success, otherwise None
Return type:Ags.UUID

Retrieve Ags.UUID by parsing str.

New in version 3.0.0.

Ags.woker_thread_do_poll_loop(ptr)
Parameters:ptr (object or None) – the Ags.WorkerThread
Return type:object or None

Do loop and invoke Ags.WorkerThread.do_poll() unless flag AGS_WORKER_THREAD_RUNNING was unset.

New in version 3.0.0.