IpatchSampleStoreROM

IpatchSampleStoreROM — ROM sample store object

Synopsis




                    IpatchSampleStoreROM;
                    IpatchSampleStoreROMClass;
#define             IPATCH_SAMPLE_STORE_ROM_UNUSED_FLAG_SHIFT
IpatchSampleStore*  ipatch_sample_store_ROM_new         (void);
void                ipatch_sample_store_ROM_set_location
                                                        (IpatchSampleStore *store,
                                                         guint location);
guint               ipatch_sample_store_ROM_get_location
                                                        (IpatchSampleStore *store);

Object Hierarchy


  GObject
   +----IpatchItem
         +----IpatchSampleStore
               +----IpatchSampleStoreROM

Properties


  "location"                 guint                 : Read / Write

Description

A sample storage type that stores a ROM location of sample data. This sample store type does not provide any way to access this data, its only purpose is to keep track of the location of ROM samples found in some patch formats (e.g., SoundFont). New types could be derived from this in order to provide additional functionality (for a specific ROM chip for example).

Details

IpatchSampleStoreROM

typedef struct _IpatchSampleStoreROM IpatchSampleStoreROM;


IpatchSampleStoreROMClass

typedef struct {
  IpatchSampleStoreClass parent_class;
} IpatchSampleStoreROMClass;


IPATCH_SAMPLE_STORE_ROM_UNUSED_FLAG_SHIFT

#define             IPATCH_SAMPLE_STORE_ROM_UNUSED_FLAG_SHIFT

Shift value of next unused IpatchItem flag (for derived types).


ipatch_sample_store_ROM_new ()

IpatchSampleStore*  ipatch_sample_store_ROM_new         (void);

Creates a new ROM sample store.

Returns : New ROM sample store

ipatch_sample_store_ROM_set_location ()

void                ipatch_sample_store_ROM_set_location
                                                        (IpatchSampleStore *store,
                                                         guint location);

Sets the location in ROM of stored sample data of a IpatchSampleStoreROM. Can only be set during inactive construction stage of sample store and is required before it can be activated.

store : A ROM sample store to set location of
location : Offset in ROM of stored sample data, in bytes

ipatch_sample_store_ROM_get_location ()

guint               ipatch_sample_store_ROM_get_location
                                                        (IpatchSampleStore *store);

Gets the location in the SoundFont ROM of a ROM sample store.

store : IpatchSampleStoreROM to get ROM location from
Returns : Offset, in bytes, in the ROM of the sample data.

Property Details

The "location" property

  "location"                 guint                 : Read / Write

Location in a ROM of the sample data.

Default value: 0

See Also

IpatchSampleStoreRAM, IpatchSampleStoreFile, IpatchSampleStoreSwap