AgsChannelThread

AgsChannelThread — channel thread

Functions

Properties

AgsChannel * channel Read / Write
GObject * default-output-soundcard Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsThread
        ╰── AgsChannelThread

Implemented Interfaces

AgsChannelThread implements AgsConnectable.

Includes

#include <ags/audio/thread/ags_channel_thread.h>

Description

The AgsChannelThread acts as channel output thread to soundcard.

Functions

ags_channel_thread_test_status_flags ()

gboolean
ags_channel_thread_test_status_flags (AgsChannelThread *channel_thread,
                                      guint status_flags);

Test status_flags of channel_thread .

Parameters

channel_thread

the AgsChannelThread

 

status_flags

status flags

 

Returns

TRUE if status flags set, otherwise FALSE

Since: 3.0.0


ags_channel_thread_set_status_flags ()

void
ags_channel_thread_set_status_flags (AgsChannelThread *channel_thread,
                                     guint status_flags);

Set status flags.

Parameters

channel_thread

the AgsChannelThread

 

status_flags

status flags

 

Since: 3.0.0


ags_channel_thread_unset_status_flags ()

void
ags_channel_thread_unset_status_flags (AgsChannelThread *channel_thread,
                                       guint status_flags);

Unset status flags.

Parameters

channel_thread

the AgsChannelThread

 

status_flags

status flags

 

Since: 3.0.0


ags_channel_thread_set_sound_scope ()

void
ags_channel_thread_set_sound_scope (AgsChannelThread *channel_thread,
                                    gint sound_scope);

Set sound scope.

Parameters

channel_thread

the AgsChannelThread

 

sound_scope

the sound scope

 

Since: 3.0.0


ags_channel_thread_get_do_fx_staging ()

gboolean
ags_channel_thread_get_do_fx_staging (AgsChannelThread *channel_thread);

Get do fx staging.

Parameters

channel_thread

the AgsChannelThread

 

Returns

TRUE if set, otherwise FALSE

Since: 3.3.0


ags_channel_thread_set_do_fx_staging ()

void
ags_channel_thread_set_do_fx_staging (AgsChannelThread *channel_thread,
                                      gboolean do_fx_staging);

Set do fx staging.

Parameters

channel_thread

the AgsChannelThread

 

do_fx_staging

TRUE if do fx staging, else FALSe

 

Since: 3.3.0


ags_channel_thread_get_staging_program ()

guint *
ags_channel_thread_get_staging_program
                               (AgsChannelThread *channel_thread,
                                guint *staging_program_count);

Get staging program.

Parameters

channel_thread

the AgsChannelThread

 

staging_program_count

the staging program count.

[out]

Returns

the staging program.

[transfer full]

Since: 3.3.0


ags_channel_thread_set_staging_program ()

void
ags_channel_thread_set_staging_program
                               (AgsChannelThread *channel_thread,
                                guint *staging_program,
                                guint staging_program_count);

Set staging program.

Parameters

channel_thread

the AgsChannelThread

 

staging_program

the staging program.

[transfer none]

staging_program_count

the staging program count

 

Since: 3.3.0


ags_channel_thread_new ()

AgsChannelThread *
ags_channel_thread_new (GObject *default_output_soundcard,
                        GObject *channel);

Create a new AgsChannelThread.

Parameters

default_output_soundcard

the GObject

 

channel

the AgsChannel

 

Returns

the new AgsChannelThread

Since: 3.0.0


AGS_CHANNEL_THREAD()

#define AGS_CHANNEL_THREAD(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_CHANNEL_THREAD, AgsChannelThread))

AGS_CHANNEL_THREAD_CLASS()

#define AGS_CHANNEL_THREAD_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_CHANNEL_THREAD, AgsChannelThreadClass))

AGS_CHANNEL_THREAD_GET_CLASS()

#define AGS_CHANNEL_THREAD_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_CHANNEL_THREAD, AgsChannelThreadClass))

AGS_IS_CHANNEL_THREAD()

#define AGS_IS_CHANNEL_THREAD(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_CHANNEL_THREAD))

AGS_IS_CHANNEL_THREAD_CLASS()

#define AGS_IS_CHANNEL_THREAD_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE ((class), AGS_TYPE_CHANNEL_THREAD))

ags_channel_thread_get_type ()

GType
ags_channel_thread_get_type ();

Types and Values

AGS_CHANNEL_THREAD_DEFAULT_JIFFIE

#define AGS_CHANNEL_THREAD_DEFAULT_JIFFIE (ceil(AGS_SOUNDCARD_DEFAULT_SAMPLERATE / AGS_SOUNDCARD_DEFAULT_BUFFER_SIZE) + AGS_SOUNDCARD_DEFAULT_OVERCLOCK)

enum AgsChannelThreadFlags

Enum values to control the behavior or indicate internal state of AgsChannelThread by enable/disable as flags.

Members

AGS_CHANNEL_THREAD_STATUS_DONE

sync done parent thread, initial wait during AgsThread::run()

 

AGS_CHANNEL_THREAD_STATUS_WAIT

sync wait parent thread, initial wait during AgsThread::run()

 

AGS_CHANNEL_THREAD_STATUS_DONE_SYNC

sync done parent thread, signal completed during AgsThread::run()

 

AGS_CHANNEL_THREAD_STATUS_WAIT_SYNC

sync wait parent thread, signal completed during AgsThread::run()

 

AGS_TYPE_CHANNEL_THREAD

#define AGS_TYPE_CHANNEL_THREAD                (ags_channel_thread_get_type())

struct AgsChannelThread

struct AgsChannelThread;

struct AgsChannelThreadClass

struct AgsChannelThreadClass {
  AgsThreadClass thread;
};

Property Details

The “channel” property

  “channel”                  AgsChannel *

The assigned AgsChannel.

Owner: AgsChannelThread

Flags: Read / Write

Since: 3.0.0


The “default-output-soundcard” property

  “default-output-soundcard” GObject *

The assigned default soundcard.

Owner: AgsChannelThread

Flags: Read / Write

Since: 3.0.0