AgsPlayback

AgsPlayback — Outputting to soundcard context

Functions

Properties

guint audio-channel Read / Write
GObject * playback-domain Read / Write
GObject * source Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsPlayback

Implemented Interfaces

AgsPlayback implements AgsConnectable.

Includes

#include <ags/audio/ags_playback.h>

Description

AgsPlayback represents a context to output.

Functions

ags_playback_set_channel_thread ()

void
ags_playback_set_channel_thread (AgsPlayback *playback,
                                 AgsThread *thread,
                                 guint scope);

Set channel thread of appropriate scope.

Parameters

playback

the AgsPlayback

 

thread

the AgsChannelThread

 

scope

the scope of the thread to set

 

Since: 1.0.0.7


ags_playback_get_channel_thread ()

AgsThread *
ags_playback_get_channel_thread (AgsPlayback *playback,
                                 guint scope);

Get channel thread of appropriate scope.

Parameters

playback

the AgsPlayback

 

scope

the scope of the thread to get

 

Returns

the matching AgsThread or NULL

Since: 1.0.0.7


ags_playback_set_iterator_thread ()

void
ags_playback_set_iterator_thread (AgsPlayback *playback,
                                  AgsThread *thread,
                                  guint scope);

Set iterator thread of appropriate scope.

Parameters

playback

the AgsPlayback

 

thread

the AgsIteratorThread

 

scope

the scope of the thread to set

 

Since: 1.0.0.7


ags_playback_get_iterator_thread ()

AgsThread *
ags_playback_get_iterator_thread (AgsPlayback *playback,
                                  guint scope);

Get iterator thread of appropriate scope.

Parameters

playback

the AgsPlayback

 

scope

the scope of the thread to get

 

Returns

the matching AgsThread or NULL

Since: 1.0.0.7


ags_playback_set_recycling_thread ()

void
ags_playback_set_recycling_thread (AgsPlayback *playback,
                                   AgsThread *thread,
                                   guint scope);

Set recycling thread of appropriate scope.

Parameters

playback

the AgsPlayback

 

thread

the AgsRecyclingThread

 

scope

the scope of the thread to set

 

Since: 1.0.0.7


ags_playback_get_recycling_thread ()

AgsThread *
ags_playback_get_recycling_thread (AgsPlayback *playback,
                                   guint scope);

Get recycling thread of appropriate scope.

Parameters

playback

the AgsPlayback

 

scope

the scope of the thread to get

 

Returns

the matching AgsThread or NULL

Since: 1.0.0.7


ags_playback_set_recall_id ()

void
ags_playback_set_recall_id (AgsPlayback *playback,
                            AgsRecallID *recall_id,
                            guint scope);

Set recall id of appropriate scope.

Parameters

playback

the AgsPlayback

 

recall_id

the AgsRecallID

 

scope

the scope of the recall id to set

 

Since: 1.0.0.7


ags_playback_get_recall_id ()

AgsRecallID *
ags_playback_get_recall_id (AgsPlayback *playback,
                            guint scope);

Get recall id of appropriate scope.

Parameters

playback

the AgsPlayback

 

scope

the scope of the recall id to get

 

Returns

the matching AgsRecallID or NULL

Since: 1.0.0.7


ags_playback_find_source ()

AgsPlayback *
ags_playback_find_source (GList *playback,
                          GObject *source);

ags_playback_new ()

AgsPlayback *
ags_playback_new ();

Creates an AgsPlayback, refering to application_context .

Returns

a new AgsPlayback

Since: 1.0.0


AGS_IS_PLAYBACK()

#define AGS_IS_PLAYBACK(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_PLAYBACK))

AGS_PLAYBACK()

#define AGS_PLAYBACK(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_PLAYBACK, AgsPlayback))

AGS_PLAYBACK_CLASS()

#define AGS_PLAYBACK_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_PLAYBACK, AgsPlayback))

AGS_PLAYBACK_GET_CLASS()

#define AGS_PLAYBACK_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_PLAYBACK, AgsPlaybackClass))

ags_playback_get_type ()

GType
ags_playback_get_type ();

Types and Values

enum AgsPlaybackFlags

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

Members

AGS_PLAYBACK_CONNECTED

indicates the playback was connected by calling AgsConnectable::connect()

 

AGS_PLAYBACK_DONE

done doing playback

 

AGS_PLAYBACK_REMOVE

does remove playback

 

AGS_PLAYBACK_CHANNEL

play channel

 

AGS_PLAYBACK_PAD

play pad

 

AGS_PLAYBACK_AUDIO

play audio

 

AGS_PLAYBACK_PLAYBACK

do playback

 

AGS_PLAYBACK_SEQUENCER

do sequencer

 

AGS_PLAYBACK_NOTATION

do notation

 

AGS_PLAYBACK_SINGLE_THREADED

single threaded

 

AGS_PLAYBACK_SUPER_THREADED_CHANNEL

super threaded channel

 

AGS_PLAYBACK_SUPER_THREADED_RECYCLING

super threaded recycling

 

enum AgsPlaybackScope

Members

AGS_PLAYBACK_SCOPE_PLAYBACK

   

AGS_PLAYBACK_SCOPE_SEQUENCER

   

AGS_PLAYBACK_SCOPE_NOTATION

   

AGS_TYPE_PLAYBACK

#define AGS_TYPE_PLAYBACK                (ags_playback_get_type())

struct AgsPlayback

struct AgsPlayback;

struct AgsPlaybackClass

struct AgsPlaybackClass {
  GObjectClass gobject;
};

Property Details

The “audio-channel” property

  “audio-channel”            guint

The assigned audio channel.

Flags: Read / Write

Default value: 0

Since: 1.0.0.7


The “playback-domain” property

  “playback-domain”          GObject *

The parent playback domain.

Flags: Read / Write

Since: 1.0.0.7


The “source” property

  “source”                   GObject *

The assigned source.

Flags: Read / Write

Since: 1.0.0.7