[gmpi] Re: Topic 3: Cross platform

  • From: Marcus Clements <marcus@xxxxxxxxxxxxxxxxx>
  • To: gmpi@xxxxxxxxxxxxx
  • Date: Wed, 05 Mar 2003 18:54:09 +0000

API Language:

Maybe the definitive API should not be written in code but in English (+other human languages!). A sample implementation on the host side and the plugin side could be provided as part of the SDK, initially in ANSI C but later with Delphi and C++ versions (or wrappers). If the API documentation was carefully written in a platform neutral way it should be clear for developers using any language/compiler combination how it works at a fundamental level.

For example:

**********************************
Function Name: FunctionExample
Parameters: 32-bit IEEE Float "Parameter1"
Return Values: 32-bit IEEE Float "Result"
Notes:
blah blah
**********************************

This is pretty clear to a C developer or a Delphi developer.

IMHO the docs are *more* important than an implementation in any particular language. This may help keep the documentation as the primary point of reference, a key issue to help keep things platform neutral.


Marcus Clements




----------------------------------------------------------------------
Generalized Music Plugin Interface (GMPI) public discussion list
Participation in this list is contingent upon your abiding by the
following rules:  Please stay on topic.  You are responsible for your own
words.  Please respect your fellow subscribers.  Please do not
redistribute anyone else's words without their permission.

Archive: //www.freelists.org/archives/gmpi
Email gmpi-request@xxxxxxxxxxxxx w/ subject "unsubscribe" to unsubscribe

Other related posts: