API questions

[wayner]

From within Java or Groovy what call can I use to find the SageTV install path (usually something like "C:\Program Files\SageTV") and also the root Fanart folder? I am guessing the latter is from the Phoenix API? Or did that become part of the core system with V7?

Are there docs posted for the Phoenix API? I tried looking but couldn't find anything other than Sagex stuff.

[stuckless]

Originally Posted by wayner

From within Java or Groovy what call can I use to find the SageTV install path (usually something like "C:\Program Files\SageTV") and also the root Fanart folder? I am guessing the latter is from the Phoenix API? Or did that become part of the core system with V7?

Are there docs posted for the Phoenix API? I tried looking but couldn't find anything other than Sagex stuff.

Phoenix Javadoc
https://code.google.com/p/sagephoeni...q=#makechanges

SageTV JavaDoc
http://download.sage.tv/api/index.ht...e-summary.html

As a URL can you get the central fanart folder by calling...
http://192.168.1.10:8080/sagex/phoen...tCentralFolder

As as url you can probably get your local sagetv server directory using...
http://192.168.1.10:8080/sagex/api?c...uteFilePath&1=

[wayner]

So from within Java/Groovy can I just use:

FanartFolder=phoenix.fanart.GetFanartCentralFolder() ?

And then the Sage folder would be:

SageFolder=Utility.GetAbsoluteFilePath()

I was looking for it in the Global and Configuration trees rather than in Utility.

Thanks - I am using these for the creation of Fanart for Home Videos, but hopefully you can add that functionality to BMT.

[stuckless]

Originally Posted by wayner

So from within Java/Groovy can I just use:

FanartFolder=phoenix.fanart.GetFanartCentralFolder() ?

And then the Sage folder would be:

SageFolder=Utility.GetAbsoluteFilePath()

I was looking for it in the Global and Configuration trees rather than in Utility.

Thanks - I am using these for the creation of Fanart for Home Videos, but hopefully you can add that functionality to BMT.

I've never used groovy, but I think the answer is yes for both of those API uses. (The latter assumes you are using sagex api... otherwise you have to use the SageAPI.call() way of calling the API)

[wayner]

The GetAbsoluteFilePath works with Sagex from a URL but when I try to call it from Java it seems to want an argument of type file. Here is the doc for that call:

GetAbsoluteFilePath

public java.lang.String GetAbsoluteFilePath(java.io.File FilePath)
Returns the full path name from the specified file path..
Parameters:
FilePath - the filepath to get the full path from
Returns:
the full path from the specified file path
Since:
7.0

[wayner]

You seem to have been anticipating Google's purchase of Nest as it looks like you have already integrated Nest functionality into Sage!

[Slugger]

If you want to get the Sage install dir, I'd just access it via (in Groovy syntax):

def sageHome = System.getProperty('user.dir')
println sageHome

On most Windows systems, this should print C:\Program Files (x86)\SageTV\SageTV\

(Less the x86 on 32bit systems.)

SageTV.exe always launches its JVM instance from the dir containing the exe so the user.dir sys property is always going to be set to the root directory of the Sage install.

[wayner]

Thanks Slugger - I guess the downside is that when I run this in the Groovy Console I get the path of the Groovy folder.

Any ideas on the issue that I mention above for the Fanart folder? Can I hook into the phoenix api from Groovy? I have tried to do so from the Groovy Console, installing the phoenix jar in the lib folder and restarting the console. What would the syntax be for a call to phoenix - do I have it right above in post 3?

[Slugger]

Make me put my thinking cap on tonight... To always get your server's root install dir, farm the getProp() call to the Sage server via sagex using the WidgetAPI (again, in Groovy):

def sageHome = WidgetAPI.EvaluateExpression('java_lang_System_getProperty("user.dir")')
println sageHome

Regardless of where you call that from (remote, local, GroovyConsole, Eclipse, whereever...), that snippet should always print the Sage root install dir.

As for phoenix, after copying the jar, did you import it into your script? The SageGroovy console only auto imports the sagex APIs. Additional external APIs will have to be explicitly imported. The syntax looks a little off (to me) just because it looks like you're missing the class. The link to the javadocs is a zip, which I wasn't dloading and installing locally at this hour, sorry. But anyway, it'll work, it's just a matter of installing the jar, importing the proper class(es) and then properly calling the methods you want.

Happy scripting!

[wayner]

I think I forgot to import it into my script. That will do it.

[stuckless]

Originally Posted by wayner

You seem to have been anticipating Google's purchase of Nest as it looks like you have already integrated Nest functionality into Sage!

Yeah I bought a NEST some time ago, and then I added API support for it into phoenix in case someone wanted to play around with it. It's limited at the moment.

Originally Posted by wayner

The GetAbsoluteFilePath works with Sagex from a URL but when I try to call it from Java it seems to want an argument of type file. Here is the doc for that call:

GetAbsoluteFilePath

public java.lang.String GetAbsoluteFilePath(java.io.File FilePath)
Returns the full path name from the specified file path..
Parameters:
FilePath - the filepath to get the full path from
Returns:
the full path from the specified file path
Since:
7.0

GetAbsoluteFilePaht("")

or

GetAbsoluteFilePaht(new java.io.File(""))

[wayner]

OK, I am still having trouble using Phoenix calls in Groovy. Here is my code:

import sagex.phoenix.*
println (fanart.LocalFanartSupport.GetFanartCentralFolder())

And here is the error message:

groovy.lang.MissingMethodException: No signature of method: static sagex.phoenix.fanart.LocalFanartSupport.GetFanartCentralFolder() is applicable for argument types: () values: []
Possible solutions: GetFanartCentralFolder(), SetFanartCentralFolder(java.lang.String)

What am I f'n up?

[wayner]

Originally Posted by stuckless

GetAbsoluteFilePaht("")

or

GetAbsoluteFilePaht(new java.io.File(""))

Method 1 didn't work - you need to pass a file as an argument. But method two did - thanks for the help!

[stuckless]

Originally Posted by wayner

OK, I am still having trouble using Phoenix calls in Groovy. Here is my code:

import sagex.phoenix.*
println (fanart.LocalFanartSupport.GetFanartCentralFolder())

And here is the error message:

groovy.lang.MissingMethodException: No signature of method: static sagex.phoenix.fanart.LocalFanartSupport.GetFanartCentralFolder() is applicable for argument types: () values: []
Possible solutions: GetFanartCentralFolder(), SetFanartCentralFolder(java.lang.String)

What am I f'n up?

Ok, the ONLY package you need to be concerned with in the java docs, is the "phoenix" package, since that is the Phoenix API (everything else is just supporting code).

under the phoenix package, there are packages for each sub package (ie, fanart, metadata, menus, media, etc).

to call it, you probably don't need any imports... and just use...

String folder = phoenix.fanart.GetFanartCentralFolder();

for each phoenix api, it's 'phoenix' dot 'apigroup' dot 'ApiName'... pretty much exactly like it's laid out in the "phoenix" package in the javadoc.