Webservice API to support Android App development

[Barsk]

I have been thinking about creating an Android App that is tailor made for N-PVR.

I was thinking of asking Sub to create a webservice kind of API that one can tap for feeding data and events to the app. I am thinking an app which would do the following (at least):

• Login to N-PVR's webservice over LAN/WLAN (maybe 3G?)
  
• Work as a full featured remote with extras. Accessing all the functionality a normal remote could.
  
• Access the EPG and select shows to record or view with choice to view on the main display or the Android device.
  
• Stream music and video and even live TV to the Android device
  
• Watch photos
  
• Display tuner status, pending recordings, current TV channel etc
  
• More...?
  

All this with a pleasing look-and-feel and easy-of-use.

Maybe there are ways to intercept NEWA to get the data I need. But I think a proper webservice type of API is the way to go. I am thinking RESTful and JSON or XML to keep the API lean and effective.
I do think such an API would benefit the community as a whole. Just imagine the kinds of plugins and external apps that can be easily created. Someone with Apple iOS knowledge could build an iPhone or iPAD app easy as that.

I am thinking this as a project to learn Android App development, and as a fan of N-PVR for many years I would probably fine tune this App for a long time to come. I am a Java developer today, so the learning curve would not be that great.

As I remember Martin (mvallevand) started the NMT integration project a while ago as a project learning .NET programming and look where that brought him.

Sub, would this be possible? I guess we would have to work out the specifications of the API. But once the foundation is done in N-PVR, adding functionality to the API would not be that time consuming.

[McBainUK]

Maybe there are ways to intercept NEWA to get the data I need

NEWA uses all public APIs as it's developed by UncleJohnsBand, not sub.

But I think a proper webservice type of API is the way to go. I am thinking RESTful and JSON or XML to keep the API lean and effective.

You could use the NEWA API a bit like the SearchLite plugin uses are write your own web API that the android app could use. TBH I can't see sub adding any kind of "web API", although might be open to adding some general hooks like he's done for EWA/NEWA in the past.

Work as a full featured remote with extras. Accessing all the functionality a normal remote could.

This could be done with simulated keystrokes.

[Barsk]

NEWA uses all public APIs as it's developed by UncleJohnsBand, not sub.

Not sure what you mean here. I have not looked into the plugin APIs yet. Neither how NEWA works. So I am not up-to-date with what programming support ther actually is. But your reply seems to indicate that UJB is developing the public APIs? I thought Sub did all the programming himself. I must have misunderstood?

You could use the NEWA API a bit like the SearchLite plugin uses are write your own web API that the android app could use.

Well, I need to look into that more. I have seen some posts from Martin suggesting he is actually doing SQL to the DB itself. If I was Sub I would not like others to write code that used the database directly. If the DB schema needs to be redesigned all that external code would fail. Now, I am only speculating and this is not based on facts really. And I am not Sub either
If the database is open for general use, that is of course one way to go. To develop my own webservice API tapping into the plugins API and the database.

TBH I can't see sub adding any kind of "web API", although might be open to adding some general hooks like he's done for EWA/NEWA in the past.

Yes, I can only wish for a general webservice API for everybodys use. I think it would be beneficial for all that are extending N-PVR in some way. One could even build another NEWA on top of it.

But if course Subs time and what he wants to put his efforts on is not my decision to make. If the webservice is not to be, I'll investigate other options.

This could be done with simulated keystrokes.

Yes, but I need something on the PC to enter them. In my original plan the webservice API would be the target for the actions. If the webservice is not to be I guess I could develop a plugin that serves as the "server backend" for my Andriod app.

[mvallevand]

I think NEWA's web service API can be expanded to do what you want. It does use Windows-centric security which is fairly limiting on access but I think it can make for a good client.

NEWA on my Android doesn't look too bad http://forums.gbpvr.com//showthread.php?...post390828 and I can even stream audio by patching it.

I have also started working on two Android apps. I can get the NPVR main screen on my Android using the MVP protocol (without gyro support) and hope that sub add a couple of mouse VNC extensions so I can see how navigation goes.

I also have an Android remote for the (unreleased) MusicBox plugin, so far I have art xfering and I hope to get the music playlist and playlist navigation working by remote. I use this for control of my PCH not for streaming to my tablet.

Martin

[Barsk]

Ah, so I was not first on Android Apps. Darn!
Ok, just kidding. I am sure we can have different approaches on the subject without interfering or overlapping too much.

I didn't think of using the MVP protocol. That is of course a brilliant idea. But since you are THE master of that art I better leave that part to you. At least for now. What I am aming for is a totally different GUI that is tailor made for the properties of an Android device. With enough background data I could recreate the GUI and EPG the android way. That is my plan. Not to do another MVP extender.

For starters though I need to dig into the Android SDK and learn what can be done and how. I can probably create a mock webservice backend that feeds me data for the app during initial phases. When I have a working app up and running the actual integration with N-PVR can commence. If it is by Newa, my own plugin as a server backend or that illustrious webservice by Sub we will have to see...

Thanks for all the good suggestions from everybody!