Rockbox.org home
Downloads
Release release
Dev builds dev builds
Extras extras
themes themes
Documentation
Manual manual
Wiki wiki
Device Status device status
Support
Forums forums
Mailing lists mailing lists
IRC IRC
Development
Bugs bugs
Patches patches
Dev Guide dev guide
Search



Donate

Rockbox Technical Forums


Login with username, password and session length
Home Help Search Staff List Login Register
News:

Rockbox Ports are now being developed for various digital audio players!

+  Rockbox Technical Forums
|-+  Rockbox Development
| |-+  Starting Development and Compiling
| | |-+  API list of commands?
« previous next »
  • Print
Pages: [1]

Author Topic: API list of commands?  (Read 2320 times)

Offline slecta

  • Member
  • *
  • Posts: 6
API list of commands?
« on: May 06, 2009, 04:48:08 PM »
Hello everyone,

Am starting to work on a plugin, from what I understand the plugin programming is using APIs that have already done a lot of the hard work of commicating with the player(s)..

What I wanted to know is, is there a list of commands that the (different?) API understands?  let's say I want to use the command
pcm_play_data()

where do I find out what to put between the brackets?  i assume it's more complicated than just writing the name of a raw file. 

i don't specifically need that answer, i am looking for a general help file for commands that work for plugins, such as to play an .mp3 or make a graphic list or simple-ish things like that.

any help would be greatly appreciated!  i am finishing up a book on programming in C but i don't know where i stand with the API business etc. is there any help files as for programming plugins for rockbox (ie: list of commands, etc)? 

thanks + sorry for restating the same question 3 different ways.

selectohh
Logged

Offline saratoga

  • Developer
  • Member
  • *
  • Posts: 8974
Re: API list of commands?
« Reply #1 on: May 06, 2009, 04:57:35 PM »
The header files in which the command is declared.   In this case plugin.h.
Logged

Offline slecta

  • Member
  • *
  • Posts: 6
Re: API list of commands?
« Reply #2 on: May 06, 2009, 05:04:39 PM »
sorry, i'm a bit stupid, where exactly is this list of functions and their explanations?  where is plugin.h?

thanks again
Logged

Offline saratoga

  • Developer
  • Member
  • *
  • Posts: 8974
Re: API list of commands?
« Reply #3 on: May 06, 2009, 05:22:59 PM »
In the apps folder.  If you're not familiar with the grep command, you may want to look into it.
Logged

Offline slecta

  • Member
  • *
  • Posts: 6
Re: API list of commands?
« Reply #4 on: May 06, 2009, 07:02:56 PM »
thanks for your help, that helped a lot.  as you suspected i'm not familiar with the grep command, if you have any links it would be appreciated, i searched google for grep and for grep +rockbox and didn't find much, other than the fact that it's a search tool.  how that would be useful in this context i don't know.

otherwise, i will hack away at what you've helped me find, thank you again
Logged

Offline saratoga

  • Developer
  • Member
  • *
  • Posts: 8974
Re: API list of commands?
« Reply #5 on: May 06, 2009, 07:23:48 PM »
Quote from: selectohh on May 06, 2009, 07:02:56 PM
i searched google for grep and for grep +rockbox and didn't find much, other than the fact that it's a search tool.  how that would be useful in this context i don't know.

You can use it to see where functions are declared, and thus find their arguments.
Logged

Offline slecta

  • Member
  • *
  • Posts: 6
Re: API list of commands?
« Reply #6 on: May 06, 2009, 08:08:24 PM »
thanks saratoga you're a lifesaver.
Logged

  • Print
Pages: [1]
« previous next »
+  Rockbox Technical Forums
|-+  Rockbox Development
| |-+  Starting Development and Compiling
| | |-+  API list of commands?
 

  • SMF 2.0.17 | SMF © 2019, Simple Machines
  • Rockbox Privacy Policy
  • XHTML
  • RSS
  • WAP2

Page created in 0.062 seconds with 14 queries.