Library: Remote APIs for SageTV

[tmiranda]

Sean,

That fixed it. Thanks.

Tom

[broconne]

Is it possible to get the Channel Logo using the remote API?

I read the docs and searched this thread - but couldn't figure out how to do it. When I do what I think is the correct thing by looking at the API, I get the following error:

 curl "http://10.0.0.11:8080/sagex/api?c=GetLogo&1=WTVDDT"
<error sagex-version="7.0.15.0"><message><![CDATA[Unknown Object Type: sage.cx for Sage Object: MetaImage[C:\Program Files\SageTV\SageTV\ChannelLogos\WTVDDT.png#0 264x198 javaImage=false javaMem=0 jref=0]]]></message><exception><![CDATA[java.lang.Exception: Unknown Object Type: sage.cx for Sage Object: MetaImage[C:\Program Files\SageTV\SageTV\ChannelLogos\WTVDDT.png#0 264x198 javaImage=false javaMem=0 jref=0]
        at sagex.remote.builder.SimpleXmlBuilder.handleError(SimpleXmlBuilder.java:38)
        at sagex.remote.builder.SageAPIBuilder.build(SageAPIBuilder.java:63)
        at sagex.remote.api.XmlReplyEncoder.encodeReply(XmlReplyEncoder.java:26)
        at sagex.remote.api.ApiHandler.hanleRequest(ApiHandler.java:158)
        at sagex.remote.SagexServlet.doPost(SagexServlet.java:63)
        at sagex.remote.SagexServlet.doGet(SagexServlet.java:41)
        at javax.servlet.http.HttpServlet.service(HttpServlet.java:707)
        at javax.servlet.http.HttpServlet.service(HttpServlet.java:820)
        at org.mortbay.jetty.servlet.ServletHolder.handle(ServletHolder.java:502)
        at org.mortbay.jetty.servlet.ServletHandler.handle(ServletHandler.java:389)
        at org.mortbay.jetty.handler.ContextHandler.handle(ContextHandler.java:765)
        at org.mortbay.jetty.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:230)
        at org.mortbay.jetty.handler.HandlerCollection.handle(HandlerCollection.java:114)
        at org.mortbay.jetty.handler.HandlerWrapper.handle(HandlerWrapper.java:152)
        at org.mortbay.jetty.handler.rewrite.RewriteHandler.handle(RewriteHandler.java:230)
        at org.mortbay.jetty.handler.HandlerWrapper.handle(HandlerWrapper.java:152)
        at org.mortbay.jetty.Server.handle(Server.java:326)
        at org.mortbay.jetty.HttpConnection.handleRequest(HttpConnection.java:534)
        at org.mortbay.jetty.HttpConnection$RequestHandler.headerComplete(HttpConnection.java:864)
        at org.mortbay.jetty.HttpParser.parseNext(HttpParser.java:539)
        at org.mortbay.jetty.HttpParser.parseAvailable(HttpParser.java:212)
        at org.mortbay.jetty.HttpConnection.handle(HttpConnection.java:404)
        at org.mortbay.io.nio.SelectChannelEndPoint.run(SelectChannelEndPoint.java:409)
        at org.mortbay.thread.QueuedThreadPool$PoolThread.run(QueuedThreadPool.java:520)
Caused by: java.lang.Exception: Unknown Object Type: sage.cx for Sage Object: MetaImage[C:\Program Files\SageTV\SageTV\ChannelLogos\WTVDDT.png#0 264x198 javaImage=false javaMem=0 jref=0]
        ... 23 more

I see one post in here about how to get thumbnails using the /media method. Is there a similar method for channel logos?

[stuckless]

Originally Posted by broconne

Is it possible to get the Channel Logo using the remote API?

I read the docs and searched this thread - but couldn't figure out how to do it. When I do what I think is the correct thing by looking at the API, I get the following error:

 curl "http://10.0.0.11:8080/sagex/api?c=GetLogo&1=WTVDDT"
<error sagex-version="7.0.15.0"><message><![CDATA[Unknown Object Type: sage.cx for Sage Object: MetaImage[C:\Program Files\SageTV\SageTV\ChannelLogos\WTVDDT.png#0 264x198 javaImage=false javaMem=0 jref=0]]]></message><exception><![CDATA[java.lang.Exception: Unknown Object Type: sage.cx for Sage Object: MetaImage[C:\Program Files\SageTV\SageTV\ChannelLogos\WTVDDT.png#0 264x198 javaImage=false javaMem=0 jref=0]
        at sagex.remote.builder.SimpleXmlBuilder.handleError(SimpleXmlBuilder.java:38)
        at sagex.remote.builder.SageAPIBuilder.build(SageAPIBuilder.java:63)
        at sagex.remote.api.XmlReplyEncoder.encodeReply(XmlReplyEncoder.java:26)
        at sagex.remote.api.ApiHandler.hanleRequest(ApiHandler.java:158)
        at sagex.remote.SagexServlet.doPost(SagexServlet.java:63)
        at sagex.remote.SagexServlet.doGet(SagexServlet.java:41)
        at javax.servlet.http.HttpServlet.service(HttpServlet.java:707)
        at javax.servlet.http.HttpServlet.service(HttpServlet.java:820)
        at org.mortbay.jetty.servlet.ServletHolder.handle(ServletHolder.java:502)
        at org.mortbay.jetty.servlet.ServletHandler.handle(ServletHandler.java:389)
        at org.mortbay.jetty.handler.ContextHandler.handle(ContextHandler.java:765)
        at org.mortbay.jetty.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:230)
        at org.mortbay.jetty.handler.HandlerCollection.handle(HandlerCollection.java:114)
        at org.mortbay.jetty.handler.HandlerWrapper.handle(HandlerWrapper.java:152)
        at org.mortbay.jetty.handler.rewrite.RewriteHandler.handle(RewriteHandler.java:230)
        at org.mortbay.jetty.handler.HandlerWrapper.handle(HandlerWrapper.java:152)
        at org.mortbay.jetty.Server.handle(Server.java:326)
        at org.mortbay.jetty.HttpConnection.handleRequest(HttpConnection.java:534)
        at org.mortbay.jetty.HttpConnection$RequestHandler.headerComplete(HttpConnection.java:864)
        at org.mortbay.jetty.HttpParser.parseNext(HttpParser.java:539)
        at org.mortbay.jetty.HttpParser.parseAvailable(HttpParser.java:212)
        at org.mortbay.jetty.HttpConnection.handle(HttpConnection.java:404)
        at org.mortbay.io.nio.SelectChannelEndPoint.run(SelectChannelEndPoint.java:409)
        at org.mortbay.thread.QueuedThreadPool$PoolThread.run(QueuedThreadPool.java:520)
Caused by: java.lang.Exception: Unknown Object Type: sage.cx for Sage Object: MetaImage[C:\Program Files\SageTV\SageTV\ChannelLogos\WTVDDT.png#0 264x198 javaImage=false javaMem=0 jref=0]
        ... 23 more

I see one post in here about how to get thumbnails using the /media method. Is there a similar method for channel logos?

Unfortunately, no. I have not added support for channel logos, although it would actually be fairly easy to do, and an extension of the media handler.

[broconne]

Originally Posted by stuckless

Unfortunately, no. I have not added support for channel logos, although it would actually be fairly easy to do, and an extension of the media handler.

Ok - Thanks. I submitted a request for enhancement on the project site. Thanks for providing these APIs.

[stuckless]

Originally Posted by broconne

Ok - Thanks. I submitted a request for enhancement on the project site. Thanks for providing these APIs.

Thanks. My time is pretty thin lately, but I'll see if I can quickly add in support for channel logos over the weekend.

[stuckless]

A little later than I had hoped... but I've updated the sagex-apis to 7.0.19, and there is a media handler for getting logos. You can use it like,

/sagex/media/logo/LOGONAME

If there is a logo, it will call GetLog(LOGONAME) and return the image, if it exists.

[broconne]

Originally Posted by stuckless

A little later than I had hoped... but I've updated the sagex-apis to 7.0.19, and there is a media handler for getting logos. You can use it like,

/sagex/media/logo/LOGONAME

If there is a logo, it will call GetLog(LOGONAME) and return the image, if it exists.

Thanks for adding this!

[broconne]

Stuckless -
Thanks again for these awesome remote APIs. I do come with another question and an RFE :-)

Question: Does /media support cover art for music? I have music that has cover art, but I don't seem to be able to get it with /thumbnail - should I be able to?

RFE: If a media file does not exist, could the handler for the /media set the response code to 404 instead of 200?

[PLUCKYHD]

Originally Posted by broconne

Stuckless -
Thanks again for these awesome remote APIs. I do come with another question and an RFE :-)

Question: Does /media support cover art for music? I have music that has cover art, but I don't seem to be able to get it with /thumbnail - should I be able to?

RFE: If a media file does not exist, could the handler for the /media set the response code to 404 instead of 200?

Never personally handled music but I think you want the Album Api more specifically GetAlbumArt() for music

cheers

[broconne]

Originally Posted by PLUCKYHD

Never personally handled music but I think you want the Album Api more specifically GetAlbumArt() for music

cheers

I think when using the remote API, I need to invoke one of the /media handlers if I want an actual image returned to me, at least that is how it worked for logos and video thumbnails. Under the covers, it will be resolving the request into an Album object, and then extracting the image from the resulting sage.MetaImage and returning that.

But I am just speculating - I am sure stuckless can end the speculation.

[PLUCKYHD]

Originally Posted by broconne

I think when using the remote API, I need to invoke one of the /media handlers if I want an actual image returned to me, at least that is how it worked for logos and video thumbnails. Under the covers, it will be resolving the request into an Album object, and then extracting the image from the resulting sage.MetaImage and returning that.

But I am just speculating - I am sure stuckless can end the speculation.

Curious why you need the actual image as Studio just needs the sage.MetaImage to work. I call GetThumbnail and such all the time in sagex and display in studio without invoking any of the media handlers.

Are you doing something to the image in java?

[broconne]

Originally Posted by PLUCKYHD

Curious why you need the actual image as Studio just needs the sage.MetaImage to work. I call GetThumbnail and such all the time in sagex and display in studio without invoking any of the media handlers.

Are you doing something to the image in java?

I am requesting the image using HTTP to the jetty servlet for use in a C# application. I am building a free driver for Elve (Home automation software) to connect to Sage.

[PLUCKYHD]

Originally Posted by broconne

I am requesting the image using HTTP to the jetty servlet for use in a C# application. I am building a free driver for Elve (Home automation software) to connect to Sage.

Okay gotcha now

[stuckless]

Originally Posted by broconne

I think when using the remote API, I need to invoke one of the /media handlers if I want an actual image returned to me, at least that is how it worked for logos and video thumbnails. Under the covers, it will be resolving the request into an Album object, and then extracting the image from the resulting sage.MetaImage and returning that.

But I am just speculating - I am sure stuckless can end the speculation.

The /media/ handler is essentially a "Fanart" handler. Which is why it supports /poster, /background, etc. I don't have fanart for music items, yet.

But, the default handler /thumbnail/ should actually work for music, as long as GetMediaFileImage return an image for a music item.

I think that when I add music support, i'll probably need a specialized /music handler to support getting covers and possibly artists.

And I agree, the, /media handlers (all handlers actually) should return a 404 if the images does not exist.

I've added 2 issues for these requests.

[broconne]

Originally Posted by stuckless

The /media/ handler is essentially a "Fanart" handler. Which is why it supports /poster, /background, etc. I don't have fanart for music items, yet.

But, the default handler /thumbnail/ should actually work for music, as long as GetMediaFileImage return an image for a music item.

I think I am making the right call:

http://10.0.0.11:8080/sagex/thumbnail/205731

Where 205731 is the media ID of currently playing song that has album art.
I get this response:

<h1>sagex.api (7.0.19.0): Media Handler Error</H1>
<h2>No Image</H2><pre>
java.lang.Exception: No Image
.....

So, unless I misunderstood you, I don't think the default thumbnail handler is working for embedded music cover art.

I think that when I add music support, i'll probably need a specialized /music handler to support getting covers and possibly artists.

And I agree, the, /media handlers (all handlers actually) should return a 404 if the images does not exist.

I've added 2 issues for these requests.

Great!

[stuckless]

Originally Posted by broconne

I think I am making the right call:

http://10.0.0.11:8080/sagex/thumbnail/205731

Where 205731 is the media ID of currently playing song that has album art.
I get this response:

<h1>sagex.api (7.0.19.0): Media Handler Error</H1>
<h2>No Image</H2><pre>
java.lang.Exception: No Image
.....

So, unless I misunderstood you, I don't think the default thumbnail handler is working for embedded music cover art.

I didn't know if it would work or not... I thought it might... but it looks like, your testing shows that it doesn't work.

I guess I need a specialized media handler for music.... since you have the sagex-code, and you see how I added the /logo handler... you could add in the music handler, if you wanted

[broconne]

Originally Posted by stuckless

I didn't know if it would work or not... I thought it might... but it looks like, your testing shows that it doesn't work.

I guess I need a specialized media handler for music.... since you have the sagex-code, and you see how I added the /logo handler... you could add in the music handler, if you wanted

Sure, I don't mind adding it.. I just didn't want to step on any toes.

Could you PM me your build.properties file so I see what entries you have? I didn't look too hard at the build.xml but it seemed like that was required, wasn't in SVN, and I was hoping to not reverse engineer it.

[stuckless]

Originally Posted by broconne

Sure, I don't mind adding it.. I just didn't want to step on any toes.

Could you PM me your build.properties file so I see what entries you have? I didn't look too hard at the build.xml but it seemed like that was required, wasn't in SVN, and I was hoping to not reverse engineer it.

I will try to remember to send you an email, tonight, on what should be in the build.properties. The build.properties, if i recall, contain the location of your sage.jar, google code credentials, etc. ie, things that are specific to your environment. I'll dig up mine, share the baseic structure, where to put it, etc.

[stuckless]

I've just released 7.0.23.2 of the sagex-apis (Remote APIs for Sage TV). While this release is "minor" from the version #, there are number of significant changes.

1. I've removed the remote interfaces for legacy xml, json, xbmc, and java. This means that the http interfaces for /sagex/xmlrpc, /sagex/javarpc, /sagex/jsonrpc and /sagex/xbmcrpc no long exist. The xml and json interfaces were no longer needed, since they have been a part of the /sagex/api servlet. The Xmbc and Java interfaces were removed because i no longer want to supprt them. If you are using RMI or the /sagex/api interfaces for accessing the remote apis, then things will still work the same.

2. Under the RMI interface, I used to cache objects on the server, and that cache would never expire. Basically you'd eventually get an out of memory on the server, if you were constantly using sagex apis over rmi. This was never an issue, since the RMI access was mainly used by myself in development, and there were no external plugins that used the RMI interfaces... until now. Slugger has released (or is releasing) a new version of SJQ that will use the rmi interface for accessing calling the sage apis from remote clients. Because of this a new "reaper" thread has been added that cleans up stale objects after a given amount of time.

These changes probably will not affect anyone, since they relate to adding a new feature, and removing 4 obsolete features.

Bottom line, if you have no idea what I'm talking about here... you are probably not affected by these changes And don't confuse #1 with the complete removal of xml and json... the remote xml and json interfaces still exist, as they have for long time, under the /sagex/api thread.

[bradvido]

I've got a question on how to use the api. I'm trying to get XML over http.

Say, for example, I want to call GetFileDuration, which takes 1 parameter:

1; MediaFile:sage.MediaFile

What should i use for this MediaFile parameter? Do i just pass in the mediafileID? I tried that like so, where my MediaFileID is 86533:

http://localhost:8080/sagex/api?c=GetFileDuration&1=86533

but it returned

<Result>0</Result>

Is the media file ID not the right thing to pass in? How can i pass a MedaiFile object in?