Plugins: Document API for JukePlugSys

[AussieJuke]

This idea came from the other thread about Idea:.
WaitTimeInMS=Juke_Command("JUKE_SONG_FINISH","")
A song is played finish and it wait this number of MS, before it start the next song.

This mean a Sound FX, ads or other can been played before the next song from a plugin.

This works when there's only one plugin, but what happens when there's more than one?
Each of the plugins could return a different value. Which one does the juke app use? The largest?

[Space Fractal]

Typical this should only been needed by one plugin.

But you right.

If two plugins return a value, the software should of course use the largest value. If a plugin return a 0 and there is allready a ongoing timer, it should not reset that value.

Mightbeen this is not a good idea and should been dropped. Other idea doing a addation?

I guess the  filename addation (first idea) to these 4 commands is a good idea throuch.

[AussieJuke]

The filename addition is a good idea and won't break anything.
I just added it to Aussie Juke. Very easy. Only a few lines of code.

Using the return value of Juke_Command("JUKE_SONG_FINISH","") will require more thought.

[Space Fractal]

the major problem is what it would do if a user press a key to try to start a new song, pause ETC? I think the return value should been dropped, since that have some pitfalls and not easy to mainstream. Instead this should up to the jukebox author, if they want to add this feature them self.

I add the filename addation to my software, I hope Uncle'T like that idea. In MultiJuke this was only required 3 code lines for all 3 commands. Theses is:

 JUKE_SONGLIST_ADD_SONG
 JUKE_SONG_START
 JUKE_SONG_NEXT

When I got a green light from UncleT (if it ok with him) I change the first post.

[AussieJuke]

I already have an option in Aussie Juke to wait for n seconds between queued songs.
If the ads / FX were all the same length that would work.

The only other way is for the plugin to signal the juke app to stop/pause as soon as
soon as the song finished. It would then have to restart the play queue when it had
finished playing the ad / FX. This would be hard to implement in existing juke apps.

[AussieJuke]

I add the filename addation to my software, I hope Uncle'T like that idea. In MultiJuke this was only required 3 code lines for all 3 commands. Theses is:

 JUKE_SONGLIST_ADD_SONG
 JUKE_SONG_START
 JUKE_SONG_NEXT

I've been meaning to ask; when should the juke app send the JUKE_SONG_NEXT command?
Is it as soon as a new song moves to the top of the play queue?

[Space Fractal]

It could pause the song directly after a new song through a KeyEvent, if it have been defined by the software. If so, it would been possible to do a pause/unpause tricks instead, which would do the same. If the user try to unpause while playing a sound from the plug-in, tell the jukebox software to pause that song again.

Of course this is required the jukebox software to have defined such a command to been used trough PLUGIN_EVENT command.

Because of that, this idea is dropped.


JUKE_SONG_NEXT:
Yes, it used by Sound Wav as well, so the plug-in doesn't need to perform the queue/playlist the software use.

And yes, Its practical the same as the first song in the queue.

In MultiJuke it actuelly the second song, since I use a different songlist system, hence JUKE_SONGLIST_CURRENTPOSITION is set to 1 here. Not all JB software does need that JUKE_SONGLIST_CURRENTPOSITION command yet.

[unclet]

Sorry, I Have been quite busy lately ...... I will try to look at this tonight when I get home, but it might have to wait until this weekend possibly.

It seems you are requesting the filename path be added as the last parameter to the following commands

  JUKE_SONGLIST_ADD_SONG
  JUKE_SONG_START
  JUKE_SONG_NEXT

Is this correct?

As for the JUKE_SONG_NEXT command being sent ...... my software sends this command any time a new "next song" exists.

[Space Fractal]

also filename with full path, otherwice you correct. Should I add this to SDK?

[unclet]

You can add it to the SDK if you want.  If I have trouble supplying the path for some reason then I would simply supply a "nullstring" instead of the file path.  I would assume I would be able to supply the path though, but I have been wrong before so I need to check first 

[loadman]

You can add it to the SDK if you want.  If I have trouble supplying the path for some reason then I would simply supply a "nullstring" instead of the file path.  I would assume I would be able to supply the path though, but I have been wrong before so I need to check first 

 

[Space Fractal]

I guess you doesn't have full path saved to the database? This might because you require the users to have attract same folder structure as you have... But, you should take advance about it and simply "join" them again. Something like this:

Code: [Select]

...\MusicDirectoryPath1
      \Artist1                   
         \Album1
            \01 - Song1.mp3

to

MusicDirectoryPath1\Artist1\Album1\01 - Song1.mp3

So it should been no problem.

SDK updated to v1.05 with  the filename addation. I also wrote not all software might send this.

[unclet]

Made the updates you requested ........

Version 03.13

Added: The JUKE_SONGLIST_ADD_SONG, JUKE_SONG_START and JUKE_SONG_NEXT plugin commands were updated to include the full filename path of the song file.

[Space Fractal]

The hompage have been updated. I got my friend to create a little logo for the JPS. The logo is not 100% finalized (but about 95%). When then, I upload a bigger version of it as well.

[Space Fractal]

The homepage have been changed with my own code instead using WordPres. This allow a much easier to upload plugins from diffecents authors, and then pick automatich from the php script. I do not do someting to the frame, but the content was a higher priotity by now.

I do need to create category when needed and requested.

Soon I pm all JPS "masters" for a account to been upload thiers plugins (and update them). Now it pretty simple and cant nearly do anything wrong. That part need to been created first throuch.

Hope your folks like it.

NB. All content from the wordpres version, includning accounts have been deleted, and I have not saved anything about names, emails etc info.

[ANOTHER EDIT]
I have updated webpage again and have little distription on own page. Since I removed the last database I have rewrote it again. I might add some mistakes. Please verify the text and the screenshot is OK.

[loadman]

You have been busy 

[AussieJuke]

Well done Space Fractal, it looks great! 

[Space Fractal]

thanks. Its php site

Im also going to create some sort of admin script, so you guys can upload plugins yourself. Until then just PM me with details, and I'm are happy to include any plugins and updates.

Any plugin writes can until then also info me about coming soon plugins, if any.

I might have missed some (I guess one plugin from AussieJuke)?

.... and no, I have of course not tried to promote my own products throuch the site more than others.

[loadman]

It's growing on me 

[Space Fractal]

api updated to 1.06 to destription how Directory Format should been used (which we all was agree in the another post).

Other few mistakes is corrected which is found while (and still) doing a WebInfo plugin (finally test all JUKE_SONGLIST and JUKE_SONG commands in a real useable plugin which is my second one).

Of course since these commands is still not tested in a plugin, it accoured some bugs in MultiJuke too, which I got fixed and then soon update as long with this plugin.

I do need to test with Uncle'T Jukebox and Aussie Juke as well.

[loadman]

Nice work as always 

[Space Fractal]

how goes it about writing plugins? I diddint have time to write on my WebInfo in this week, since I have some other work done first. I do should been finsish with this plugin in the next week.

[AussieJuke]

I've just uploaded version 1.2.0.0 of the JPSAttractSounds plugin.

Fixed: Was giving an error when triggered with no sound files in directory.
Improved: Status bar shows a countdown of the attract and gap timing.
New: Can be set to also start attract sounds upon JUKE_SONG_PAUSE.


Space Fractal:
Is there a way for us to upload new plugins and update the JPS pages yet?

[Space Fractal]

No, I diddent have time to look on the admin part of the JPS in this week too. I update your very soon (DONE).

I have send PM for a temporary method for youself to upload.

[AussieJuke]

Can't see any new messages. Anyway, thanks for updating it for me. 

Still working on the JPS Sound FX plugin. Just have that issue where it crashes if you shut it down while a sound is playing. 

[Space Fractal]

just sent now (but I actuelly not sure I got the PM sent? Otherwice I try again, if you diddent have). You is a to bit to fast 

... can you not close down all played files when the software send a Juke_Shutdown function?

Do you use DirectShow or such? I did have simular issue when used the sound commands from PureBasic directly, which used DirectShow. It was also crash on exits too, and got it workaround with using a seperate thread. Hence I changed to bass when I created SoundWav which diddent have that issue.

[Space Fractal]

JPSAttractSounds works fine... a least in MultiJuke v1.1.5 I release later today. I release very soon with comply of bug fixes to JPS). Auto Attract is not necessity to show to the user. a normal user does not known what these commands does. Event it send a JUKE_SONG_FINISH or not, it should of course been enabled directly from the start. This should been a normal behavior. Just my cent here.

You could even create a option to use the JUKE_SONGLIST_SUGGESTION command instead using your own player routine (a user chooice in the config). But normally these sounds is not been used in the music database. Hence this plug-in would been a good show chase for get this command to work.

[loadman]

Can't see any new messages. Anyway, thanks for updating it for me. 

Still working on the JPS Sound FX plugin. Just have that issue where it crashes if you shut it down while a sound is playing. 

How is that going anyways ?

[Space Fractal]

I havent have the time to finishe mine, due to the mala website and playing to much Xbox in the past ;-). I do hope do I finally release the web based plugin last in this or next month.

[Space Fractal]

Since I turning MultiJuke into a FE, but I want to keep JPS for all part.

So I thinking if I could add these 2 commands for that (args not covered yet):

JUKE_GAMESTART
JUKE_GAMEEND

I dosen't think I ever would need other commands than these, due any other features can been coved in the plugin communaction set as well?

[AussieJuke]

Can you give us an example of their usage? 

[Space Fractal]

Juke_Command("JUKE_GAMESTART", "romname|title|company|year|genre|category|players|nrbuttons|controller|button help")

This command is used when a game is launced by the user in the frontend part. Some tags above might require controls.dat and catver files, but not all info is not required to send.

When the user exists the game with ESC or such button, JUKE_GAMEEND is simply invoked with no argument.

These commands have no use in a dedicated jukebox application, but these combinered jukebox & frontend applications (like MultiJuke will turn into with all music part intact).

Oterhwice I would create a external file can been invoked for smartLCD application (or other apps), even this would been included or not..... So no big issue if not included.

[loadman]

You could adopt the MaLa Plug-in concept.  The data is sent on game select.

EG
Juke_Command("JUKE_GAMESELECT", "romname|title|company|year|genre|category|players|nrbuttons|controller|button help")

Juke_Command("JUKE_GAMESTART",)

Juke_Command("JUKE_GAMESTOP",)

That way the plug-in (like a LCD display for example) can update before you start the game.
You also need an option to either send the updated details as you scroll through the game list OR just send these details when you stop scrolling like MaLa does.

[Space Fractal]

JUKE_GAMESELECT is not a option, due I can't use this command, and event not have a use of that command as well, due my FE actually work very different than MaLa do.

So I do still think these 2 commands cover all for using with Jukebox software with addition FE (and not the other way).

But, if I do want MaLa concept, I think its better to support MaLa Plugins directly (which I might support, but not in first version).

[SORRY for many edit]

[Space Fractal]

after developing future in the MultiFE, it look like i only need one new command at all:

Its JUKE_GAMESTART.

The rest can been used using PLUGIN_EVENT commands, since they either only use on and off statement, or a number. The above is needed, because there is no string can been sent trough by PLUGIN_EVENT. A Another way could also been able to send string to these events as well, by no only one letter or number can been used. Would been nice if STRING can been used.

NB. I can't really use the Mala Plug-In, due that way I use the list, and it even directly impossible when Jukebox GUI is used. MultiFE is of course different than Mala and Mamewah, otherwise I diddent started to write this one.

NB. If this command is not added to the official SDK, I do add this command else Wise, but I do warn about this to plug-in writes as this is NOT a standard command, not used in the official SDK. Any plugins that is only MultiFE compatible, would not been downloadable from the official JPS site (but only from the MultiFE site).

[Space Fractal]

I just think how I can send a string to a plugin without broke the SDK with new commands at all:

I simply use send a adress pointer to a NUMBER defined PLUGIN_EVENT where the string is in the memory. The string itself in memory use a OGG formatted TAGS about various info about the game.

More Info soon how to use strings in PLUGIN_EVENTS when I document that in the MulfiFE F.A.Q. Section (soon).

I hope I dosent got any memory invaild issues, since it not tested yet....

[loadman]

What about this for an idea:

http://forum.arcadecontrols.com/index.php?topic=84049.0

[loadman]

A plugin to trigger a mirror ball and light (via a relay)

very 70's