krähemann.com

AgsEnvelopeUtil

AgsEnvelopeUtil — Boxed type of envelope util

Stability Level

Stable, unless otherwise indicated

Object Hierarchy

    GBoxed
    ╰── AgsEnvelopeUtil

Includes

#include <ags/audio/ags_envelope_util.h>

Description

Boxed type of envelope util data type.

Functions

ags_envelope_util_alloc ()

AgsEnvelopeUtil *
ags_envelope_util_alloc ();

Allocate AgsEnvelopeUtil

Returns

a new AgsEnvelopeUtil

Since: 3.9.2


ags_envelope_util_copy ()

gpointer
ags_envelope_util_copy (AgsEnvelopeUtil *ptr);

Create a copy of ptr .

Parameters

ptr

the original AgsEnvelopeUtil

 

Returns

a pointer of the new AgsEnvelopeUtil

Since: 3.9.2


ags_envelope_util_free ()

void
ags_envelope_util_free (AgsEnvelopeUtil *ptr);

Free the memory of ptr .

Parameters

ptr

the AgsEnvelopeUtil

 

Since: 3.9.2


ags_envelope_util_get_destination ()

gpointer
ags_envelope_util_get_destination (AgsEnvelopeUtil *envelope_util);

Get destination buffer of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

Returns

the destination buffer

Since: 3.9.2


ags_envelope_util_set_destination ()

void
ags_envelope_util_set_destination (AgsEnvelopeUtil *envelope_util,
                                   gpointer destination);

Set destination buffer of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

destination

the destination buffer

 

Since: 3.9.2


ags_envelope_util_get_destination_stride ()

guint
ags_envelope_util_get_destination_stride
                               (AgsEnvelopeUtil *envelope_util);

Get destination stride of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

Returns

the destination buffer stride

Since: 3.9.2


ags_envelope_util_set_destination_stride ()

void
ags_envelope_util_set_destination_stride
                               (AgsEnvelopeUtil *envelope_util,
                                guint destination_stride);

Set destination stride of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

destination_stride

the destination buffer stride

 

Since: 3.9.2


ags_envelope_util_get_source ()

gpointer
ags_envelope_util_get_source (AgsEnvelopeUtil *envelope_util);

Get source buffer of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

Returns

the source buffer

Since: 3.9.2


ags_envelope_util_set_source ()

void
ags_envelope_util_set_source (AgsEnvelopeUtil *envelope_util,
                              gpointer source);

Set source buffer of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

source

the source buffer

 

Since: 3.9.2


ags_envelope_util_get_source_stride ()

guint
ags_envelope_util_get_source_stride (AgsEnvelopeUtil *envelope_util);

Get source stride of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

Returns

the source buffer stride

Since: 3.9.2


ags_envelope_util_set_source_stride ()

void
ags_envelope_util_set_source_stride (AgsEnvelopeUtil *envelope_util,
                                     guint source_stride);

Set source stride of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

source_stride

the source buffer stride

 

Since: 3.9.2


ags_envelope_util_get_buffer_length ()

guint
ags_envelope_util_get_buffer_length (AgsEnvelopeUtil *envelope_util);

Get buffer length of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

Returns

the buffer length

Since: 3.9.2


ags_envelope_util_set_buffer_length ()

void
ags_envelope_util_set_buffer_length (AgsEnvelopeUtil *envelope_util,
                                     guint buffer_length);

Set buffer_length of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

buffer_length

the buffer length

 

Since: 3.9.2


ags_envelope_util_get_format ()

guint
ags_envelope_util_get_format (AgsEnvelopeUtil *envelope_util);

Get format of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

Returns

the format

Since: 3.9.6


ags_envelope_util_set_format ()

void
ags_envelope_util_set_format (AgsEnvelopeUtil *envelope_util,
                              guint format);

Set format of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

format

the format

 

Since: 3.9.6


ags_envelope_util_get_audio_buffer_util_format ()

guint
ags_envelope_util_get_audio_buffer_util_format
                               (AgsEnvelopeUtil *envelope_util);

Get audio buffer util format of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

Returns

the audio buffer util format

Since: 3.9.2


ags_envelope_util_set_audio_buffer_util_format ()

void
ags_envelope_util_set_audio_buffer_util_format
                               (AgsEnvelopeUtil *envelope_util,
                                guint audio_buffer_util_format);

Set audio_buffer_util_format of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

audio_buffer_util_format

the audio buffer util format

 

Since: 3.9.2


ags_envelope_util_get_volume ()

gdouble
ags_envelope_util_get_volume (AgsEnvelopeUtil *envelope_util);

Get volume of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

Returns

the volume

Since: 3.9.2


ags_envelope_util_set_volume ()

void
ags_envelope_util_set_volume (AgsEnvelopeUtil *envelope_util,
                              gdouble volume);

Set volume of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

volume

the volume

 

Since: 3.9.2


ags_envelope_util_get_amount ()

gdouble
ags_envelope_util_get_amount (AgsEnvelopeUtil *envelope_util);

Get amount of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

Returns

the amount

Since: 3.9.2


ags_envelope_util_set_amount ()

void
ags_envelope_util_set_amount (AgsEnvelopeUtil *envelope_util,
                              gdouble amount);

Set amount of envelope_util .

Parameters

envelope_util

the AgsEnvelopeUtil

 

amount

the amount

 

Since: 3.9.2


ags_envelope_util_compute_s8 ()

void
ags_envelope_util_compute_s8 (AgsEnvelopeUtil *envelope_util);

Compute envelope of signed 8 bit data.

Parameters

envelope_util

the AgsEnvelopeUtil

 

Since: 3.9.2


ags_envelope_util_compute_s16 ()

void
ags_envelope_util_compute_s16 (AgsEnvelopeUtil *envelope_util);

Compute envelope of signed 16 bit data.

Parameters

envelope_util

the AgsEnvelopeUtil

 

Since: 3.9.2


ags_envelope_util_compute_s24 ()

void
ags_envelope_util_compute_s24 (AgsEnvelopeUtil *envelope_util);

Compute envelope of signed 24 bit data.

Parameters

envelope_util

the AgsEnvelopeUtil

 

Since: 3.9.2


ags_envelope_util_compute_s32 ()

void
ags_envelope_util_compute_s32 (AgsEnvelopeUtil *envelope_util);

Compute envelope of signed 32 bit data.

Parameters

envelope_util

the AgsEnvelopeUtil

 

Since: 3.9.2


ags_envelope_util_compute_s64 ()

void
ags_envelope_util_compute_s64 (AgsEnvelopeUtil *envelope_util);

Compute envelope of signed 64 bit data.

Parameters

envelope_util

the AgsEnvelopeUtil

 

Since: 3.9.2


ags_envelope_util_compute_float ()

void
ags_envelope_util_compute_float (AgsEnvelopeUtil *envelope_util);

Compute envelope of floating point data.

Parameters

envelope_util

the AgsEnvelopeUtil

 

Since: 3.9.2


ags_envelope_util_compute_double ()

void
ags_envelope_util_compute_double (AgsEnvelopeUtil *envelope_util);

Compute envelope of double floating point data.

Parameters

envelope_util

the AgsEnvelopeUtil

 

Since: 3.9.2


ags_envelope_util_compute_complex ()

void
ags_envelope_util_compute_complex (AgsEnvelopeUtil *envelope_util);

Compute envelope of complex floating point data.

Parameters

envelope_util

the AgsEnvelopeUtil

 

Since: 3.9.2


ags_envelope_util_compute ()

void
ags_envelope_util_compute (AgsEnvelopeUtil *envelope_util);

Compute envelope.

Parameters

envelope_util

the AgsEnvelopeUtil

 

Since: 3.9.2

Types and Values

AGS_ENVELOPE_UTIL_DEFAULT_FORMAT

#define AGS_ENVELOPE_UTIL_DEFAULT_FORMAT (AGS_SOUNDCARD_SIGNED_16_BIT)

AGS_ENVELOPE_UTIL_DEFAULT_AUDIO_BUFFER_UTIL_FORMAT

#define AGS_ENVELOPE_UTIL_DEFAULT_AUDIO_BUFFER_UTIL_FORMAT (AGS_AUDIO_BUFFER_UTIL_S16)