Library: Remote APIs for SageTV

[cncb]

Originally Posted by stuckless

Have you tested the it to see if works or not?

I use it in the Windows Gadget (via "/sagex/media/logo/CHANNELNAME") and noticed that it stopped working after I started using the new logos. The new logos seem to be downloaded to the "GeneratedThumbnails" directory so they are somewhat "local".

[jreichen]

When I use that URL, I get a logo if it's stored in ChannelLogos but not if it's a default Sage logo. In that case I get an HTTP 404 "No Image" page.

[stuckless]

In the next build, I've made some changes...

You can now use...
/media/logo/STATIONID instead of /media/log/CHANNELNAME.

using /media/log/STATIONID will use the new 7.1 apis for resolving logs, and you can also pass, type=small|medium|large, index=0|1|2, fallback=true|false (as per the API documentation).

Also, I've added a new encoder to /sagex/api, called 'image'. You can use this when calling an API method that returns an image. The onus is on YOU to tell sagex that you want an image, otherwise you'll get an encoded json/xml representation of the image (which is usually empty). I didn't want to add to much overhead to the existing processing to support this, so you'll need to pass encoder=image on the url.

http://localhost:8080/sagex/api?c=GetChannelLogo&1=channel:10092&2=Large&3=1&4=true&encoder=image

This should work for any api that returns an image (Image File, BufferedImage or SageTV MetaImage), such as MediaFileAPI.GetThumbnail

Also a few builds back I added image scaling to sages, so you can scale the images on the fly as well, using

http://localhost:8080/sagex/api?c=GetThumbnail&1=mediafile:845111&encoder=image&scalex=50&scaley=25

[bradvido]

Is there any way to make the sagex-api.log recycle? It's consuming my hard drive because I use the api so much:

[stuckless]

If you have 24 gb log file, then there is probably an issue somewhere. Can you send me a portion of the log file... I suspect there must a large repeating section in the log.

But to answer your question, yes, you can reconfigure the logging, even turn it off if you want, but it requires tweaking the log4j settings.

You'll need to change the "Appender" to something like the org.apache.log4j.RollingFileAppender and then add a new configuration options to set the max size, # of backups, etc. You can configure this from the bmt web ui Configuration -> Log4j Logging -> Logging, and if you search the guide that is linked from that configuration page, for "RollingFileAppender Options", then you find the options.

I suspect you'll want to add options like...
log4j.appender.SAGEX.MaxFileSize=10MB
log4j.appender.SAGEX.MaxBackupIndex=1

I've attached a screenshot of the configuration page in bmt, and I've highlighted the sections that you'll need change/edit. And don't forget to click Save.

[cncb]

Originally Posted by stuckless

In the next build, I've made some changes...

You can now use...
/media/logo/STATIONID instead of /media/log/CHANNELNAME.

What is the "STATIONID"?

[stuckless]

Originally Posted by cncb

What is the "STATIONID"?

StationID is the unique id assigned to a channel.

It's the only way I can lookup a channel.

[cncb]

Originally Posted by stuckless

StationID is the unique id assigned to a channel.

Is there any way the StationID could be provided with the Airing XML (with GetScheduledRecordings)?

[Fonceur]

Originally Posted by cncb

Is there any way the StationID could be provided with the Airing XML (with GetScheduledRecordings)?

Well, just use airing.GetChannel().GetStationID()...

[cncb]

Originally Posted by Fonceur

Well, just use airing.GetChannel().GetStationID()...

Can't really do that with the http api so it would be best for it to be in the XML for each airing like ChannelName is now.

[stuckless]

Originally Posted by cncb

Is there any way the StationID could be provided with the Airing XML (with GetScheduledRecordings)?

Originally I was excluding the serialization of the Channel object in airings because I didn't support it... but since I've added channel support, the airing xml will now return the serialized channel as well, which will contain the stationid (and other channel object fields, such as name, network, etc).

That'll be in the next build, which will likely go out today.

[cncb]

Originally Posted by stuckless

That'll be in the next build, which will likely go out today.

Thanks!

[bradvido]

Thanks for the fix on the log size stuckless.
There aren't any errors, just excessive use

[bradvido]

When a method asks for a Sage Favorite object, what do i pass in as the parameter?

Edit, I see there is a favorite ID for favorites. So how can i obtain this ID? I know both the media file id and airing id, how do i get favorite id from that?
Currently the only way i see is to call getFavorites() and search for a match through all that junk.

[Slugger]

FavoriteAPI.GetFavoriteForAiring(Airing)

[bradvido]

Is that possible to call using this remote API?

Edit: Doh. Just saw it. That FavoriteAPI part threw me off.
It's just under api?c=GetFavoriteForAiring


Thanks!

[bradvido]

What would be the best way to determine what recorded episodes are currently available for a given favorite. I see that it give me a list of airings, but i need to know which shows are currently available to watch for a favorite.

[Slugger]

I don't use the HTTP interface too often so you'll have to massage this somehow into an appropriate HTTP call, but this call should do it:

FilterByMethod(GetFavoriteAirings(GetFavoriteForID(12345)), "GetMediaFileForAiring", null, false)

That call should return all the recordings of the favorite. Replace the 12345 with the favourite id number.

[Slugger]

In case anyone is interested, I actually derived the above Studio call from the Groovy script below:

def fav = FavoriteAPI.GetFavoriteForID(153502)
def airings = FavoriteAPI.GetFavoriteAirings(fav)
def recordings = Database.FilterByMethod(airings, "GetMediaFileForAiring", null, false)
println "Found ${airings.size()} airing(s) and ${recordings.size()} recording(s) of favourite '${FavoriteAPI.GetFavoriteDescription(fav)}'"

// Equivalent Studio expression should be:
// FilterByMethod(GetFavoriteAirings(GetFavoriteForID(153502)), "GetMediaFileForAiring", null, false)

Output:

Found 74 airing(s) and 1 recording(s) of favourite 'The Office First Runs'

And, indeed, I have one recording of The Office on my system right now.

[stuckless]

Originally Posted by Slugger

In case anyone is interested, I actually derived the above Studio call from the Groovy script below:

def fav = FavoriteAPI.GetFavoriteForID(153502)
def airings = FavoriteAPI.GetFavoriteAirings(fav)
def recordings = Database.FilterByMethod(airings, "GetMediaFileForAiring", null, false)
println "Found ${airings.size()} airing(s) and ${recordings.size()} recording(s) of favourite '${FavoriteAPI.GetFavoriteDescription(fav)}'"

// Equivalent Studio expression should be:
// FilterByMethod(GetFavoriteAirings(GetFavoriteForID(153502)), "GetMediaFileForAiring", null, false)

Output:

Found 74 airing(s) and 1 recording(s) of favourite 'The Office First Runs'

And, indeed, I have one recording of The Office on my system right now.

FYI... you could probably use the EvaluateExpression api if you wanted to do it all one line...

EvaluateExpression("FilterByMethod(GetFavoriteAirings(GetFavoriteForID(153502)), \"GetMediaFileForAiring\", null, false)");