IpatchSLISample

IpatchSLISample — Spectralis audio sample

Functions

Properties

int fine-tune Read / Write
guint loop-end Read / Write
guint loop-start Read / Write
char * name Read / Write
int root-note Read / Write
IpatchSampleData * sample-data Read / Write
int sample-rate Read / Write

Object Hierarchy

    GObject
    ╰── IpatchItem
        ╰── IpatchSLISample

Description

Spectralis samples are children of IpatchSLI objects and are referenced by IpatchSLIZone objects. They define the audio which is synthesized.

Functions

ipatch_sli_sample_new ()

IpatchSLISample *
ipatch_sli_sample_new (void);

Create a new Spectralis sample object.

Returns

New Spectralis sample with a reference count of 1. Caller owns the reference and removing it will destroy the item, unless another reference is added (if its parented for example).


ipatch_sli_sample_first ()

IpatchSLISample *
ipatch_sli_sample_first (IpatchIter *iter);

Gets the first item in a sample iterator. A convenience wrapper for ipatch_iter_first().

[skip]

Parameters

iter

Patch item iterator containing IpatchSLISample items

 

Returns

The first sample in iter or NULL if empty.


ipatch_sli_sample_next ()

IpatchSLISample *
ipatch_sli_sample_next (IpatchIter *iter);

Gets the next item in a sample iterator. A convenience wrapper for ipatch_iter_next().

[skip]

Parameters

iter

Patch item iterator containing IpatchSLISample items

 

Returns

The next sample in iter or NULL if at the end of the list.


ipatch_sli_sample_set_name ()

void
ipatch_sli_sample_set_name (IpatchSLISample *sample,
                            const char *name);

Sets the name of a Spectralis sample.

Parameters

sample

Sample to set name of

 

name

Value to set name to.

[nullable]

ipatch_sli_sample_get_name ()

char *
ipatch_sli_sample_get_name (IpatchSLISample *sample);

Gets the name of a Spectralis sample.

Parameters

sample

Sample to get name of

 

Returns

Name of sample or NULL if not set. String value should be freed when finished with it.


ipatch_sli_sample_set_data ()

void
ipatch_sli_sample_set_data (IpatchSLISample *sample,
                            IpatchSampleData *sampledata);

Set a sample's sample data object.

Parameters

sample

Sample to set sample data of

 

sampledata

Sample data to set sample to

 

ipatch_sli_sample_get_data ()

IpatchSampleData *
ipatch_sli_sample_get_data (IpatchSLISample *sample);

Get the IpatchSampleData item of a sample. Sample data item is referenced before returning and caller is responsible for unreferencing it with g_object_unref() when finished with it.

Parameters

sample

Sample to get sample data from

 

Returns

Sample data object of sample or NULL if none. Remember to unreference with g_object_unref() when finished with it.

[transfer full]


ipatch_sli_sample_peek_data ()

IpatchSampleData *
ipatch_sli_sample_peek_data (IpatchSLISample *sample);

Get the IpatchSampleData item of a sample. Like ipatch_sli_sample_get_data() but sample data object is not referenced. This function should only be used if a reference of the sample data object is ensured or only the pointer value is of importance.

[skip]

Parameters

sample

Sample to get sample data from

 

Returns

Sample data object of sample or NULL if none. Remember that a reference is NOT added.


ipatch_sli_sample_set_blank ()

void
ipatch_sli_sample_set_blank (IpatchSLISample *sample);

Set the sample data of a sample item to blank data.

Parameters

sample

Sample to set to blank sample data

 

Property Details

The “fine-tune” property

  “fine-tune”                int

Fine tuning in cents.

Owner: IpatchSLISample

Flags: Read / Write

Allowed values: [-99,99]

Default value: 0


The “loop-end” property

  “loop-end”                 guint

Loop end in frames (after loop).

Owner: IpatchSLISample

Flags: Read / Write

Default value: 0


The “loop-start” property

  “loop-start”               guint

Start of loop in frames.

Owner: IpatchSLISample

Flags: Read / Write

Default value: 0


The “name” property

  “name”                     char *

Name.

Owner: IpatchSLISample

Flags: Read / Write

Default value: NULL


The “root-note” property

  “root-note”                int

Root MIDI note.

Owner: IpatchSLISample

Flags: Read / Write

Allowed values: [0,127]

Default value: 60


The “sample-data” property

  “sample-data”              IpatchSampleData *

Sample data.

Owner: IpatchSLISample

Flags: Read / Write


The “sample-rate” property

  “sample-rate”              int

Sampling rate in Hertz.

Owner: IpatchSLISample

Flags: Read / Write

Allowed values: [100,192000]

Default value: 44100

See Also

IpatchSLI, IpatchSLIZone