AgsOscFrontController

AgsOscFrontController — OSC front controller

Functions

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── AgsOscController
        ╰── AgsOscFrontController

Includes

#include <ags/audio/osc/controller/ags_osc_front_controller.h>

Description

The AgsOscFrontController implements the OSC front controller.

Functions

AGS_OSC_FRONT_CONTROLLER_MESSAGE()

#define AGS_OSC_FRONT_CONTROLLER_MESSAGE(ptr) ((AgsOscFrontControllerMessage *)(ptr))

ags_osc_front_controller_test_flags ()

gboolean
ags_osc_front_controller_test_flags (AgsOscFrontController *osc_front_controller,
                                     guint flags);

Test flags to be set on osc_front_controller .

Parameters

osc_front_controller

the AgsOscFrontController

 

flags

the flags

 

Returns

TRUE if flags are set, else FALSE

Since: 2.1.0


ags_osc_front_controller_set_flags ()

void
ags_osc_front_controller_set_flags (AgsOscFrontController *osc_front_controller,
                                    guint flags);

Set flags.

Parameters

osc_front_controller

the AgsOscFrontController

 

flags

the flags

 

Since: 2.1.0


ags_osc_front_controller_unset_flags ()

void
ags_osc_front_controller_unset_flags (AgsOscFrontController *osc_front_controller,
                                      guint flags);

Unset flags.

Parameters

osc_front_controller

the AgsOscFrontController

 

flags

the flags

 

Since: 2.1.0


ags_osc_front_controller_message_sort_func ()

gint
ags_osc_front_controller_message_sort_func
                               (gconstpointer a,
                                gconstpointer b);

Compare a and b in view of timing.

Parameters

a

the AgsOscFrontControllerMessage

 

b

the other AgsOscFrontControllerMessage

 

Returns

-1 if a happens before b , 0 if at the very same time or 1 if after

Since: 2.1.0


ags_osc_front_controller_message_alloc ()

AgsOscFrontControllerMessage *
ags_osc_front_controller_message_alloc
                               ();

Allocate AgsOscFrontControllerMessage.

Returns

the newly allocated AgsOscFrontControllerMessage

Since: 2.1.0


ags_osc_front_controller_message_free ()

void
ags_osc_front_controller_message_free (AgsOscFrontControllerMessage *message);

Free message .

Parameters

message

the AgsOscFrontControllerMessage

 

Since: 2.1.0


ags_osc_front_controller_add_message ()

void
ags_osc_front_controller_add_message (AgsOscFrontController *osc_front_controller,
                                      AgsOscFrontControllerMessage *message);

Add message to osc_front_contrller .

Parameters

osc_front_controller

the AgsOscFrontController

 

message

the AgsOscFrontControllerMessage

 

Since: 2.1.0


ags_osc_front_controller_remove_message ()

void
ags_osc_front_controller_remove_message
                               (AgsOscFrontController *osc_front_controller,
                                AgsOscFrontControllerMessage *message);

Remove message from osc_front_contrller .

Parameters

osc_front_controller

the AgsOscFrontController

 

message

the AgsOscFrontControllerMessage

 

Since: 2.1.0


ags_osc_front_controller_start_delegate ()

void
ags_osc_front_controller_start_delegate
                               (AgsOscFrontController *osc_front_controller);

Start delegateing.

Parameters

osc_front_controller

the AgsOscFrontController

 

Since: 2.1.0


ags_osc_front_controller_stop_delegate ()

void
ags_osc_front_controller_stop_delegate
                               (AgsOscFrontController *osc_front_controller);

Stop delegateing.

Parameters

osc_front_controller

the AgsOscFrontController

 

Since: 2.1.0


ags_osc_front_controller_do_request ()

gpointer
ags_osc_front_controller_do_request (AgsOscFrontController *osc_front_controller,
                                     AgsOscConnection *osc_connection,
                                     unsigned char *packet,
                                     guint packet_size);

ags_osc_front_controller_new ()

AgsOscFrontController *
ags_osc_front_controller_new ();

Instantiate new AgsOscFrontController

Returns

the AgsOscFrontController

Since: 2.1.0


AGS_IS_OSC_FRONT_CONTROLLER()

#define AGS_IS_OSC_FRONT_CONTROLLER(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_OSC_FRONT_CONTROLLER))

AGS_OSC_FRONT_CONTROLLER()

#define AGS_OSC_FRONT_CONTROLLER(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_OSC_FRONT_CONTROLLER, AgsOscFrontController))

AGS_OSC_FRONT_CONTROLLER_CLASS()

#define AGS_OSC_FRONT_CONTROLLER_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_OSC_FRONT_CONTROLLER, AgsOscFrontControllerClass))

AGS_OSC_FRONT_CONTROLLER_GET_CLASS()

#define AGS_OSC_FRONT_CONTROLLER_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_OSC_FRONT_CONTROLLER, AgsOscFrontControllerClass))

ags_osc_front_controller_get_type ()

GType
ags_osc_front_controller_get_type ();

Types and Values

enum AgsOscFrontControllerFlags

Members

AGS_OSC_FRONT_CONTROLLER_DELEGATE_STARTED

   

AGS_OSC_FRONT_CONTROLLER_DELEGATE_RUNNING

   

AGS_OSC_FRONT_CONTROLLER_DELEGATE_TERMINATING

   

struct AgsOscFrontControllerMessage

struct AgsOscFrontControllerMessage {
  AgsOscConnection *osc_connection;
  
  gint32 tv_sec;
  gint32 tv_fraction;
  gboolean immediately;

  guint message_size;

  unsigned char *message;
};

AGS_TYPE_OSC_FRONT_CONTROLLER

#define AGS_TYPE_OSC_FRONT_CONTROLLER                (ags_osc_front_controller_get_type())

struct AgsOscFrontController

struct AgsOscFrontController;

struct AgsOscFrontControllerClass

struct AgsOscFrontControllerClass {
  AgsOscControllerClass osc_controller;

  void (*start_delegate)(AgsOscFrontController *osc_front_controller);
  void (*stop_delegate)(AgsOscFrontController *osc_front_controller);

  gpointer (*do_request)(AgsOscFrontController *osc_front_controller,
			 AgsOscConnection *osc_connection,
			 unsigned char *packet, guint packet_size);
};

Signal Details

The “do-request” signal

gpointer
user_function (AgsOscFrontController *osc_front_controller,
               GObject               *osc_connection,
               gpointer               packet,
               guint                  packet_size,
               gpointer               user_data)

The ::do-request signal is emited during do request of front controller.

Parameters

osc_front_controller

the AgsOscFrontController

 

osc_connection

the AgsOscConnection

 

packet

the packet received

 

packet_size

the packet size

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 2.1.0


The “start-delegate” signal

void
user_function (AgsOscFrontController *osc_front_controller,
               gpointer               user_data)

The ::start-delegate signal is emited during start of delegateing front.

Parameters

osc_front_controller

the AgsOscFrontController

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 2.1.0


The “stop-delegate” signal

void
user_function (AgsOscFrontController *osc_front_controller,
               gpointer               user_data)

The ::stop-delegate signal is emited during stop of delegateing front.

Parameters

osc_front_controller

the AgsOscFrontController

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 2.1.0