AgsNavigation

AgsNavigation — control audio object's playback.

Stability Level

Stable, unless otherwise indicated

Functions

gchar * ags_navigation_tact_to_time_string ()
gchar * ags_navigation_relative_tact_to_time_string ()
gchar * ags_navigation_absolute_tact_to_time_string ()
void ags_navigation_update_time_string ()
void ags_navigation_set_seeking_sensitive ()
void ags_navigation_change_position ()
gboolean ags_navigation_duration_time_queue_draw_timeout ()
AgsNavigation * ags_navigation_new ()

Properties

GObject * soundcard Read / Write

Signals

void change-position Run Last

Types and Values

#define AGS_NAVIGATION_DEFAULT_BPM
#define AGS_NAVIGATION_DEFAULT_TACT_STEP
#define AGS_NAVIGATION_SEEK_STEPS
#define AGS_NAVIGATION_REWIND_STEPS
#define AGS_NAVIGATION_DURATION_ZERO
#define AGS_NAVIGATION_MAX_POSITION_TACT
#define AGS_NAVIGATION_MAX_POSITION_TICS
enum AgsNavigationFlags

Object Hierarchy

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

Includes

#include <ags/app/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_timeout ()

gboolean
ags_navigation_duration_time_queue_draw_timeout
                               (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

Types and Values

AGS_NAVIGATION_DEFAULT_BPM

#define AGS_NAVIGATION_DEFAULT_BPM (120.0)

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)

AGS_NAVIGATION_DURATION_ZERO

#define AGS_NAVIGATION_DURATION_ZERO "0000:00.000"

AGS_NAVIGATION_MAX_POSITION_TACT

#define AGS_NAVIGATION_MAX_POSITION_TACT (16 * 1200)

AGS_NAVIGATION_MAX_POSITION_TICS

#define AGS_NAVIGATION_MAX_POSITION_TICS (16 * 16 * 1200)

enum AgsNavigationFlags

Members

AGS_NAVIGATION_CONNECTED

    

AGS_NAVIGATION_BLOCK_TACT

    

AGS_NAVIGATION_BLOCK_PLAY

    

AGS_NAVIGATION_BLOCK_TIC

    

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,
               double         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

Generated by GTK-Doc V1.33.1