AgsOscClient

AgsOscClient — the OSC client

Stability Level

Stable, unless otherwise indicated

Functions

Types and Values

Includes

#include <ags/audio/osc/ags_osc_client.h>

Description

AgsOscClient your OSC client.

Functions

AGS_OSC_CLIENT_GET_OBJ_MUTEX()

#define AGS_OSC_CLIENT_GET_OBJ_MUTEX(obj) (&(((AgsOscClient *) obj)->obj_mutex))

ags_osc_client_test_flags ()

gboolean
ags_osc_client_test_flags (AgsOscClient *osc_client,
                           guint flags);

Test flags to be set on osc_client .

Parameters

osc_client

the AgsOscClient

 

flags

the flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_osc_client_set_flags ()

void
ags_osc_client_set_flags (AgsOscClient *osc_client,
                          guint flags);

Set flags.

Parameters

osc_client

the AgsOscClient

 

flags

the flags

 

Since: 3.0.0


ags_osc_client_unset_flags ()

void
ags_osc_client_unset_flags (AgsOscClient *osc_client,
                            guint flags);

Unset flags.

Parameters

osc_client

the AgsOscClient

 

flags

the flags

 

Since: 3.0.0


ags_osc_client_resolve ()

void
ags_osc_client_resolve (AgsOscClient *osc_client);

Resolve OSC client.

Parameters

osc_client

the AgsOscClient

 

Since: 3.0.0


ags_osc_client_connect ()

void
ags_osc_client_connect (AgsOscClient *osc_client);

Connect OSC client.

Parameters

osc_client

the AgsOscClient

 

Since: 3.0.0


ags_osc_client_read_bytes ()

unsigned char *
ags_osc_client_read_bytes (AgsOscClient *osc_client,
                           guint *data_length);

Read bytes.

Parameters

osc_client

the AgsOscClient

 

data_length

the return location of byte array's length

 

Returns

byte array read or NULL if no data available

Since: 3.0.0


ags_osc_client_write_bytes ()

gboolean
ags_osc_client_write_bytes (AgsOscClient *osc_client,
                            guchar *data,
                            guint data_length);

Write data using OSC client.

Parameters

osc_client

the AgsOscClient

 

data

the byte array

 

data_length

the length of byte array

 

Returns

TRUE if all bytes written, otherwise FALSE

Since: 3.0.0


ags_osc_client_new ()

AgsOscClient *
ags_osc_client_new ();

Creates a new instance of AgsOscClient

Returns

the new AgsOscClient

Since: 3.0.0

Types and Values

AGS_OSC_CLIENT_DEFAULT_MAX_ADDRESS_LENGTH

#define AGS_OSC_CLIENT_DEFAULT_MAX_ADDRESS_LENGTH (2048)

AGS_OSC_CLIENT_DEFAULT_SERVER_PORT

#define AGS_OSC_CLIENT_DEFAULT_SERVER_PORT (9000)

AGS_OSC_CLIENT_DEFAULT_DOMAIN

#define AGS_OSC_CLIENT_DEFAULT_DOMAIN "localhost"

AGS_OSC_CLIENT_DEFAULT_INET4_ADDRESS

#define AGS_OSC_CLIENT_DEFAULT_INET4_ADDRESS "127.0.0.1"

AGS_OSC_CLIENT_DEFAULT_INET6_ADDRESS

#define AGS_OSC_CLIENT_DEFAULT_INET6_ADDRESS "::1"

AGS_OSC_CLIENT_DEFAULT_MAX_RETRY

#define AGS_OSC_CLIENT_DEFAULT_MAX_RETRY (16)

AGS_OSC_CLIENT_CHUNK_SIZE

#define AGS_OSC_CLIENT_CHUNK_SIZE (131072)

AGS_OSC_CLIENT_DEFAULT_CACHE_DATA_LENGTH

#define AGS_OSC_CLIENT_DEFAULT_CACHE_DATA_LENGTH (256)

enum AgsOscClientFlags

Enum values to configure OSC client.

Members

AGS_OSC_CLIENT_INET4

use IPv4 socket

 

AGS_OSC_CLIENT_INET6

use IPv6 socket

 

AGS_OSC_CLIENT_UDP

use UDP transport protocol

 

AGS_OSC_CLIENT_TCP

used TCP transport protocol