PS04RhythmPatternEvent

PS04RhythmPatternEvent — Event in a rhythm pattern

Synopsis


#include <PS04-rhythm-pattern-event.h>


            PS04RhythmPatternEvent;
PS04RhythmPatternEvent* ps04_rhythm_pattern_event_new
                                            (guint tick_offset);
const PS04RhythmNote* ps04_rhythm_pattern_event_get_note
                                            (const PS04RhythmPatternEvent *self);
const char* ps04_rhythm_pattern_event_get_note_as_string
                                            (const PS04RhythmPatternEvent *self);
gboolean    ps04_rhythm_pattern_event_is_bass
                                            (const PS04RhythmPatternEvent *self);
gboolean    ps04_rhythm_pattern_event_is_drum
                                            (const PS04RhythmPatternEvent *self);
gboolean    ps04_rhythm_pattern_event_is_end
                                            (const PS04RhythmPatternEvent *self);
void        ps04_rhythm_pattern_event_set_note
                                            (PS04RhythmPatternEvent *self,
                                             PS04RhythmNote *note);
void        ps04_rhythm_pattern_event_set_tick_offset
                                            (PS04RhythmPatternEvent *self,
                                             guint tick_offset);

Object Hierarchy


  GObject
   +----PS04RhythmEvent
         +----PS04RhythmPatternEvent

Description

The PS04RhythmPatternEvent struct represents an event in a PS04RhythmPattern.

Details

PS04RhythmPatternEvent

typedef struct _PS04RhythmPatternEvent PS04RhythmPatternEvent;

ps04_rhythm_pattern_event_new ()

PS04RhythmPatternEvent* ps04_rhythm_pattern_event_new
                                            (guint tick_offset);

Creates a new rhythm pattern event.

tick_offset : The tick offset of the new event.
Returns : a new PS04RhythmPatternEvent.

ps04_rhythm_pattern_event_get_note ()

const PS04RhythmNote* ps04_rhythm_pattern_event_get_note
                                            (const PS04RhythmPatternEvent *self);

Gets the note of the event.

self : a PS04RhythmPatternEvent.
Returns : the PS04RhythmNote.

ps04_rhythm_pattern_event_get_note_as_string ()

const char* ps04_rhythm_pattern_event_get_note_as_string
                                            (const PS04RhythmPatternEvent *self);

self :
Returns :

ps04_rhythm_pattern_event_is_bass ()

gboolean    ps04_rhythm_pattern_event_is_bass
                                            (const PS04RhythmPatternEvent *self);

self :
Returns :

ps04_rhythm_pattern_event_is_drum ()

gboolean    ps04_rhythm_pattern_event_is_drum
                                            (const PS04RhythmPatternEvent *self);

Checks if the event is a drum note.

self : a PS04RhythmPatternEvent.
Returns : TRUE if the event is a drum note, otherwise FALSE.

ps04_rhythm_pattern_event_is_end ()

gboolean    ps04_rhythm_pattern_event_is_end
                                            (const PS04RhythmPatternEvent *self);

self :
Returns :

ps04_rhythm_pattern_event_set_note ()

void        ps04_rhythm_pattern_event_set_note
                                            (PS04RhythmPatternEvent *self,
                                             PS04RhythmNote *note);

Sets the note associated with the event. If not NULL, the notes are referenced by the event, so the caller should unref it afterwards if it's not needed elsewhere.

self : A PS04RhythmPatternEvent.
note : A PS04RhythmNote, or NULL.

ps04_rhythm_pattern_event_set_tick_offset ()

void        ps04_rhythm_pattern_event_set_tick_offset
                                            (PS04RhythmPatternEvent *self,
                                             guint tick_offset);

self :
tick_offset :