Library: Remote APIs for SageTV

[stuckless]

Originally Posted by babgvant

Does the service expose a WSDL? Or something like it that could use to autogenerate a proxy class?

I'd like to integrate with a c# application, and it would save a ton of time...

Short answer is no. The Rest API is not a web services api.

That being said, much the of the code in the api is autogenerated from the SageTV javadocs. The code currently parses the javadoc and creates a metadata for the SageAPI, from that, java apis, jsp tags, and http apis are generated. So, you could create a generator, and generate .cs files that proxy the the http calls.

[babgvant]

I'm having a hard time getting this installed using the Jetty method. I have Jetty running for the mobile interface, so it seems to be configured properly.

I have sagex.xml in C:\Program Files\SageTV\SageTV\jetty\contexts & sagex.api-6.4.8-11.jar in C:\Program Files\SageTV\SageTV\JARs

but http://localhost:8181/sagex/rpcXml/Global/GetOS gives me a 404.

Any suggestions?

Thanks.

[stuckless]

If you've previously installed the remote apis under nielm's server, then remove the servlet entry from his servlets.properties file before installing it into jetty.

Could you check your sagetv_0.txt log file (in the sagetv home directory) and see if it
contains the following entries.

Wed 12/24 15:39:50.885 Remote API Servlet initializing.
Wed 12/24 15:39:50.887 Sage Provider Implementation: sagex.remote.EmbeddedSageAPIProvider; sage://embedded
Wed 12/24 15:39:50.907 Sage Xml RPC Servlet Created.
Wed 12/24 15:39:50.908 Sage Java RPC Servlet Created.
Wed 12/24 15:39:50.909 Sage Json RPC Servlet Created.
Wed 12/24 15:39:50.911 Media Servlet Handler Created.
Wed 12/24 15:39:50.913 Sage Xbox Xml RPC Servlet Created.
Wed 12/24 15:39:50.914 Registered Handlers.
Wed 12/24 15:39:50.914 Configuring Remote Broadcast Services...
Wed 12/24 15:39:50.915 Properties not found: /opt/sagetv/server/sagex-api.properties; using defaults.
Wed 12/24 15:39:50.917 Sage Remote Api Info: Server: mediaserver; Rmi Port: 1098; Http Port: 8081
Wed 12/24 15:39:50.958 Starting Sage RMI Server...
Wed 12/24 15:39:51.069 Sage Java RMI Server ready
Wed 12/24 15:39:51.104 Annoucing Remote Sage API Server availability....
Wed 12/24 15:39:51.105 2008-12-24 15:39:51.625::INFO:  Deploy /opt/sagetv/server/jetty/contexts/sagex.xml -> org.mortbay.jetty.servlet.Context@324ff{/,null}

And I apologize in advance for the next question.... but I assume that since you are using "localhost", then are running the browser on the same machine on which the sagetv server is running?

Also, make sure that in your JARs directory, that you only have a 1 copy of the sagex.api jar file. If there multiple copies, with diferrent versions, then delete all other copies, except the latest version.

What's your java version?

[babgvant]

Closest thing I have in the sagetx_0.log is

Fri 12/26 22:27:20.355 Loading startup runnable:sagex.jetty.starter.Main
Fri 12/26 22:27:20.358 Loaded startup runnable:sagex.jetty.starter.Main

localhost was on the sage server.

only 1 of the sagex.api files is present (I had previously deleted *-9)

Version 6 Update 11.

Thanks

[jreichen]

Uncomment the

DEBUG=true

line in JettyStarter.properties and restart SageTV. Then see if there is any additional logging in sagetv_0.txt.

[babgvant]

no difference.

[jreichen]

I forgot to ask you to make the API request again after turning on debug logging. Did you try that and then check the logs?

[babgvant]

I did. I also did a request to the mobile app; neither caused any logging.

[stuckless]

Would you mind restarting SageTV, then posting your sagetv_0.txt log file from the server. Wait a few minutes after you restart before sending the log file to be sure that jetty extracts and starts everything. It seems odd that you don't have more relevant information in your log file.

[babgvant]

pm'd you a link to the file.

Thanks for looking at it

[stuckless]

Added rpcXbmc handler (contributed by mikwilli) and jreichen found an issue with the sage context, so there's a new context file.

[rotten]

I am wondering how you are able to assign the http rpcXml to a button and then have it not return the xml but just display the page the button was originally clicked on?

[stuckless]

Originally Posted by rotten

I am wondering how you are able to assign the http rpcXml to a button and then have it not return the xml but just display the page the button was originally clicked on?

Sorry, but I'm going to need some more information. I don't really know what you are asking? Maybe you can give some specifics about what is you are trying to do.

Thanks.

[rotten]

When I send a hfref command via a button on an html page such as:

http://10.0.1.1:8080/sagex/rpcXml/Gl...OCESS_LOCAL_UI

I get back an xml display like:

<response>
<header>
</header>
<body>
</body>
</response>

Is there a tag to redirect back to the page where the button was clicked or is there a smarter way to attach the command to a button?

Thanks

[stuckless]

Originally Posted by rotten

When I send a hfref command via a button on an html page such as:

http://10.0.1.1:8080/sagex/rpcXml/Gl...OCESS_LOCAL_UI

I get back an xml display like:

<response>
<header>
</header>
<body>
</body>
</response>

Is there a tag to redirect back to the page where the button was clicked or is there a smarter way to attach the command to a button?

Thanks

Typically, you would use an ajax scripting engine to make these calls, or manually do it yourself using the XmlHttpRequest object in the browser. Either way, it's javascript.

Check out the "testJson.html" page in my test area

You'll need both the testJson.html and the jquery js files.

Hope this helps.

[babgvant]

How do you use the API when it requires an object as an argument?

For e.g. I'm trying to pull the MediaFile reference for a path via GetMediaFileForFilePath which requires a java.io.File. I've tried passing in the path to the file (what I get back when calling GetSegmentFiles, which returns a java.io.File).

Thanks

[stuckless]

Originally Posted by babgvant

How do you use the API when it requires an object as an argument?

For e.g. I'm trying to pull the MediaFile reference for a path via GetMediaFileForFilePath which requires a java.io.File. I've tried passing in the path to the file (what I get back when calling GetSegmentFiles, which returns a java.io.File).

Thanks

I don't know exactly what your question is... but here's a snippet that shows how to get a MediaFile reference using a known file, and then it prints out the title and watched status.

package test;

import java.io.File;

import sagex.api.AiringAPI;
import sagex.api.MediaFileAPI;

public class TestMisc {
    public static void main(String args[]) {
        Object mediafile = MediaFileAPI.GetMediaFileForFilePath(new File("/var/media/tv/Futurama-SpacePilot3000-2007144-0.ts"));
        System.out.printf("     Title: %s\n", MediaFileAPI.GetMediaTitle(mediafile));
        System.out.printf("Is Watched: %s\n", AiringAPI.IsWatched(mediafile)); 
    }
}

The Remote API mirrors the SageTV api... which means that when you get a MediaFile reference, you can't actually call any methods on that object. You must then continue to use the MediaFileAPI methods to extract data from the media file reference.

If this isn't what you were asking then my apologies not understanding the question.

[babgvant]

Originally Posted by stuckless

I don't know exactly what your question is... but here's a snippet that shows how to get a MediaFile reference using a known file, and then it prints out the title and watched status.

package test;

import java.io.File;

import sagex.api.AiringAPI;
import sagex.api.MediaFileAPI;

public class TestMisc {
    public static void main(String args[]) {
        Object mediafile = MediaFileAPI.GetMediaFileForFilePath(new File("/var/media/tv/Futurama-SpacePilot3000-2007144-0.ts"));
        System.out.printf("     Title: %s\n", MediaFileAPI.GetMediaTitle(mediafile));
        System.out.printf("Is Watched: %s\n", AiringAPI.IsWatched(mediafile)); 
    }
}

The Remote API mirrors the SageTV api... which means that when you get a MediaFile reference, you can't actually call any methods on that object. You must then continue to use the MediaFileAPI methods to extract data from the media file reference.

If this isn't what you were asking then my apologies not understanding the question.

I'm using the rpcXml methods, how do I "new File("/var/media/tv/Futurama-SpacePilot3000-2007144-0.ts")"?

[stuckless]

Download the latest jar, which fixes a bug when file parameters are used.

Then use the following syntax for passing file parameters

http://mediaserver:8081/sagex/rpcXml/MediaFileAPI?command=GetMediaFileForFilePath&1=/var/media/tv/Futurama-SpacePilot3000-2007144-0.ts

It will return a media file object reference id, which you then use in other calls.

<response>
<header>
</header>
<body>
<objectRef ref="25756944"/>
</body>
</response>

In this case, 25756944, is the mediafile object reference id.

http://mediaserver:8081/sagex/rpcXml/MediaFileAPI/GetMediaTitle/25756944

Hope this helps...

[babgvant]

Perfect, thanks.