AgsPeakChannel

AgsPeakChannel — peaks channel

Functions

Properties

AgsPort * buffer-cleared Read / Write
AgsPort * buffer-computed Read / Write
guint buffer-size Read / Write
guint format Read / Write
AgsPort * peak Read / Write
guint samplerate Read / Write
AgsPort * scale-precision Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsRecall
        ╰── AgsRecallChannel
            ╰── AgsPeakChannel

Implemented Interfaces

AgsPeakChannel implements AgsConnectable, AgsPackable, AgsDynamicConnectable and AgsPlugin.

Includes

#include <ags/audio/recall/ags_peak_channel.h>

Description

The AgsPeakChannel class provides ports to the effect processor.

Functions

ags_peak_channel_buffer_add ()

void
ags_peak_channel_buffer_add (AgsPeakChannel *peak_channel,
                             void *buffer,
                             guint samplerate,
                             guint buffer_size,
                             guint format);

ags_peak_channel_buffer_add is deprecated and should not be used in newly-written code.


ags_peak_channel_retrieve_peak_internal ()

void
ags_peak_channel_retrieve_peak_internal
                               (AgsPeakChannel *peak_channel);

ags_peak_channel_new ()

AgsPeakChannel *
ags_peak_channel_new (AgsChannel *source);

Creates an AgsPeakChannel

Parameters

source

the AgsChannel as source

 

Returns

a new AgsPeakChannel

Since: 1.0.0


AGS_IS_PEAK_CHANNEL()

#define AGS_IS_PEAK_CHANNEL(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_PEAK_CHANNEL))

AGS_PEAK_CHANNEL()

#define AGS_PEAK_CHANNEL(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_PEAK_CHANNEL, AgsPeakChannel))

AGS_PEAK_CHANNEL_CLASS()

#define AGS_PEAK_CHANNEL_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_PEAK_CHANNEL, AgsPeakChannel))

AGS_PEAK_CHANNEL_GET_CLASS()

#define AGS_PEAK_CHANNEL_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_PEAK_CHANNEL, AgsPeakChannelClass))

ags_peak_channel_get_type ()

GType
ags_peak_channel_get_type ();

Types and Values

AGS_TYPE_PEAK_CHANNEL

#define AGS_TYPE_PEAK_CHANNEL                (ags_peak_channel_get_type())

struct AgsPeakChannel

struct AgsPeakChannel;

struct AgsPeakChannelClass

struct AgsPeakChannelClass {
  AgsRecallChannelClass recall_channel;
};

Property Details

The “buffer-cleared” property

  “buffer-cleared”           AgsPort *

The property indicating if buffer was cleared.

Flags: Read / Write

Since: 1.0.0


The “buffer-computed” property

  “buffer-computed”          AgsPort *

The property indicating if buffer was computed.

Flags: Read / Write

Since: 1.0.0


The “buffer-size” property

  “buffer-size”              guint

The buffer size to be used.

Flags: Read / Write

Default value: 0


The “format” property

  “format”                   guint

The format to be used.

Flags: Read / Write

Default value: 0


The “peak” property

  “peak”                     AgsPort *

The peak of the channel.

Flags: Read / Write

Since: 1.0.0.7


The “samplerate” property

  “samplerate”               guint

The samplerate to be used.

Flags: Read / Write

Default value: 0


The “scale-precision” property

  “scale-precision”          AgsPort *

The property indicating if scale was precision.

Flags: Read / Write

Since: 1.0.0