krähemann.com

AgsNavigation

AgsNavigation — control audio object's playback.

Stability Level

Stable, unless otherwise indicated

Properties

GObject * soundcard Read / Write

Signals

void change-position Run Last

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBox
                    ╰── AgsNavigation

Implemented Interfaces

AgsNavigation implements AtkImplementorIface, GtkBuildable, GtkOrientable and AgsConnectable.

Includes

#include <ags/X/ags_navigation.h>

Description

AgsNavigation is a composite widget to control playback of AgsAudio objects. It can start AgsMachine in bulk mode or position the stream.

Functions

ags_navigation_tact_to_time_string ()

gchar *
ags_navigation_tact_to_time_string (gdouble tact,
                                    gdouble bpm,
                                    gdouble delay_factor);

Convert tact unit to time.

Parameters

tact

the new position

 

bpm

the BPM

 

delay_factor

the delay factor

 

Returns

tact as time string

Since: 3.0.0


ags_navigation_relative_tact_to_time_string ()

gchar *
ags_navigation_relative_tact_to_time_string
                               (gchar *timestr,
                                gdouble delay,
                                gdouble bpm,
                                gdouble delay_factor);

ags_navigation_absolute_tact_to_time_string ()

gchar *
ags_navigation_absolute_tact_to_time_string
                               (gdouble tact,
                                gdouble bpm,
                                gdouble delay_factor);

ags_navigation_update_time_string ()

void
ags_navigation_update_time_string (double tact,
                                   gdouble bpm,
                                   gdouble delay_factor,
                                   gchar *time_string);

Updates time as string.

Parameters

tact

the new position

 

bpm

the BPM

 

delay_factor

the delay factor

 

time_string

the pointer location to set

 

Since: 3.0.0


ags_navigation_set_seeking_sensitive ()

void
ags_navigation_set_seeking_sensitive (AgsNavigation *navigation,
                                      gboolean enabled);

ags_navigation_change_position ()

void
ags_navigation_change_position (AgsNavigation *navigation,
                                gdouble tact);

Change tact position of editor. The scrollbar is adjustet and its playback position seeked.

Parameters

navigation

the AgsNavigation

 

tact

the new position

 

Since: 3.0.0


ags_navigation_duration_time_queue_draw ()

gboolean
ags_navigation_duration_time_queue_draw
                               (GtkWidget *widget);

ags_navigation_new ()

AgsNavigation *
ags_navigation_new ();

Create a new instance of AgsNavigation to control the tree.

Returns

the new AgsNavigation

Since: 3.0.0


AGS_IS_NAVIGATION()

#define AGS_IS_NAVIGATION(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_NAVIGATION))

AGS_IS_NAVIGATION_CLASS()

#define AGS_IS_NAVIGATION_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE ((class), AGS_TYPE_NAVIGATION))

AGS_NAVIGATION()

#define AGS_NAVIGATION(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_NAVIGATION, AgsNavigation))

AGS_NAVIGATION_CLASS()

#define AGS_NAVIGATION_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_NAVIGATION, AgsNavigationClass))

AGS_NAVIGATION_GET_CLASS()

#define AGS_NAVIGATION_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_NAVIGATION, AgsNavigationClass))

ags_navigation_get_type ()

GType
ags_navigation_get_type (void);

Types and Values

AGS_NAVIGATION_DEFAULT_TACT_STEP

#define AGS_NAVIGATION_DEFAULT_TACT_STEP (1.0)

AGS_NAVIGATION_SEEK_STEPS

#define AGS_NAVIGATION_SEEK_STEPS (1.0)

AGS_NAVIGATION_REWIND_STEPS

#define AGS_NAVIGATION_REWIND_STEPS (4.0)

enum AgsNavigationFlags

Members

AGS_NAVIGATION_CONNECTED

   

AGS_NAVIGATION_BLOCK_TACT

   

AGS_NAVIGATION_BLOCK_PLAY

   

AGS_NAVIGATION_BLOCK_TIC

   

AGS_TYPE_NAVIGATION

#define AGS_TYPE_NAVIGATION                (ags_navigation_get_type())

struct AgsNavigation

struct AgsNavigation;

struct AgsNavigationClass

struct AgsNavigationClass {
  GtkBoxClass box;

  void (*change_position)(AgsNavigation *navigation,
			  gdouble tact);
};

Property Details

The “soundcard” property

  “soundcard”                GObject *

The assigned AgsSoundcard to use as default sink.

Owner: AgsNavigation

Flags: Read / Write

Since: 3.0.0

Signal Details

The “change-position” signal

void
user_function (AgsNavigation *navigation,
               gdouble        tact,
               gpointer       user_data)

The ::change-position seeks the stream.

Parameters

navigation

the AgsNavigation

 

tact

the new position

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0