Library: Remote APIs for SageTV

[stuckless]

Originally Posted by routerunner

Hi,

I've been trying to use the Utility.GetWindowsRegistryNames (both local & remote calls) recently without success. For instance:

String list[] = Utility.GetWindowsRegistryNames("HKEY_LOCAL_MACHINE", "SYSTEM");

Tried with different HIVE/KEY combination, but always gets an empty list of string.

What am I doing wrong? Please advice...

Thanks
Eddy

I'm not a Windows user... but hopefully a windows developer can shed some light on this for you.

[razrsharpe]

Originally Posted by routerunner

Hi,

I've been trying to use the Utility.GetWindowsRegistryNames (both local & remote calls) recently without success. For instance:

String list[] = Utility.GetWindowsRegistryNames("HKEY_LOCAL_MACHINE", "SYSTEM");

Tried with different HIVE/KEY combination, but always gets an empty list of string.

What am I doing wrong? Please advice...

Thanks
Eddy

I've never used that method before but here are some thoughts from reading the sage api doc and firing up regedit. In my HKLM\SYSTEM there are no named values in the right hand pane. However, there are several keys under SYSTEM in the left pane. Perhaps this method only returns the names of values and not keys....

[routerunner]

Originally Posted by razrsharpe

I've never used that method before but here are some thoughts from reading the sage api doc and firing up regedit. In my HKLM\SYSTEM there are no named values in the right hand pane. However, there are several keys under SYSTEM in the left pane. Perhaps this method only returns the names of values and not keys....

Thanks for the quick reply....

I reckon, you're right, the documentation is talking about "names" and not "keys". What I was trying to achieve is exactly what you pointed out, hence gets a list of keys and according on what you're saying we should have something like:

Utility.GetWindowsRegistryKeys

Thanks
Eddy

[routerunner]

Hi Sean,

for a project I'm working on I need to use the following SageTV APIs below, however their behavior sounds not correct:

CaptureDeviceInputAPI.GetInputMinimumChannelNumber() -> always returns 0
CaptureDeviceInputAPI.AutoTuneChannelTest() -> always produces NULL pointer exception
MediaPlayerAPI.CloseAndWaitUntilClosed() -> stuck execution forever

I was wondering whether you could please double check those APIs when you've got time

Many thanks
Eddy

[Fuzzy]

Originally Posted by routerunner

Hi Sean,

for a project I'm working on I need to use the following SageTV APIs below, however their behavior sounds not correct:

CaptureDeviceInputAPI.GetInputMinimumChannelNumber() -> always returns 0
CaptureDeviceInputAPI.AutoTuneChannelTest() -> always produces NULL pointer exception
MediaPlayerAPI.CloseAndWaitUntilClosed() -> stuck execution forever

I was wondering whether you could please double check those APIs when you've got time

Many thanks
Eddy

Are you calling these with a UI context? I'm wondering if they are crashing out as they are basically server calls, so UI context shouldn't matter. Either way, the API Wrapper seems to be fine (if the output of the sage call is null or false, it returns false, if the output is true, it returns true). No real place in the sagex wrapper to generate a null pointer exception, which means it's more than likely a bug in the sage api itself. Is the tuner you are using configured in sage? is it being used for livetv at the time? These calls are not likely all that robust, as they are designed for very specific use cases in the core sagetv product.

[routerunner]

Originally Posted by Fuzzy

Are you calling these with a UI context? I'm wondering if they are crashing out as they are basically server calls, so UI context shouldn't matter. Either way, the API Wrapper seems to be fine (if the output of the sage call is null or false, it returns false, if the output is true, it returns true). No real place in the sagex wrapper to generate a null pointer exception, which means it's more than likely a bug in the sage api itself. Is the tuner you are using configured in sage? is it being used for livetv at the time? These calls are not likely all that robust, as they are designed for very specific use cases in the core sagetv product.

My mistake, forget about this a misleading function name was returning the "CaptureDevice" name instead of the "CaptureDeviceInput" name required by the "AutoTuneChannelTest()" method, however the "GetInputMinimumChannelNumber()" method is still returning zero every time.

Eddy

[stuckless]

Originally Posted by routerunner

My mistake, forget about this a misleading function name was returning the "CaptureDevice" name instead of the "CaptureDeviceInput" name required by the "AutoTuneChannelTest()" method, however the "GetInputMinimumChannelNumber()" method is still returning zero every time.

Eddy

Maybe you could post your code fragment so that I can see if you using the chain of apis correctly?

That API for this, http://download.sage.tv/api/sage/api...va.lang.String)

does require that you pass in the device input name, and I'm sure the return value is probably 0 if the input name is not correct.

As Fuzzy pointed out, these APIs do very little, except directly pass through to the sage.SageTV.api(name, args) method. You can quickly test if this is a sagex issue by simply calling,

Integer val = (Integer)sage.SageTV.api("GetInputMinimumChannelNumber", new Object[] {DeviceInputName});

And see if you get a different result. I suspect the root of the issue if the device input name parameter.

[routerunner]

Originally Posted by stuckless

Maybe you could post your code fragment so that I can see if you using the chain of apis correctly?

That API for this, http://download.sage.tv/api/sage/api...va.lang.String)

does require that you pass in the device input name, and I'm sure the return value is probably 0 if the input name is not correct.

As Fuzzy pointed out, these APIs do very little, except directly pass through to the sage.SageTV.api(name, args) method. You can quickly test if this is a sagex issue by simply calling,

Integer val = (Integer)sage.SageTV.api("GetInputMinimumChannelNumber", new Object[] {DeviceInputName});

And see if you get a different result. I suspect the root of the issue if the device input name parameter.

Code snippet below:

CDI (CaptureDeviceInput)

Integer channel = CaptureDeviceInputAPI.GetInputMinimumChannelNumber(CDI);
MediaPlayerAPI.LockTuner(CDI);
CaptureDeviceInputAPI.AutoTuneChannelTest(CDI, channel.toString());
MediaPlayerAPI.CloseAndWaitUntilClosed();

The function now returns "1" for each tuner. Please note that effectively "1" is the minimum channel for one tuner only, for the other tuner the minimum channel is "100", however I think I need to normalize the second tuner to its lineup channel range...I thought SageTV would do it automatically...

Eddy

[stuckless]

Originally Posted by routerunner

Code snippet below:

CDI (CaptureDeviceInput)

Integer channel = CaptureDeviceInputAPI.GetInputMinimumChannelNumber(CDI);
MediaPlayerAPI.LockTuner(CDI);
CaptureDeviceInputAPI.AutoTuneChannelTest(CDI, channel.toString());
MediaPlayerAPI.CloseAndWaitUntilClosed();

The function now returns "1" for each tuner. Please note that effectively "1" is the minimum channel for one tuner only, for the other tuner the minimum channel is "100", however I think I need to normalize the second tuner to its lineup channel range...I thought SageTV would do it automatically...

Eddy

I think you are right... I think you'll need to use the linuep and ChannelAPI to get the "real" channel number string.

[Fuzzy]

The CaptureDevice API is used for interacting directly with the tuner, not the channel lineup. I can't think of a single tuner out there that won't accept a tune to channel 1, so that is likely why it reports as so, regardless of whether the lineup has a channel 1 in it. You are, instead, going to have to retrieve the list of channels from the lineup, and simply select the lowest enabled channel, if that is what you are trying to achieve.

[routerunner]

Originally Posted by Fuzzy

The CaptureDevice API is used for interacting directly with the tuner, not the channel lineup. I can't think of a single tuner out there that won't accept a tune to channel 1, so that is likely why it reports as so, regardless of whether the lineup has a channel 1 in it. You are, instead, going to have to retrieve the list of channels from the lineup, and simply select the lowest enabled channel, if that is what you are trying to achieve.

Unfortunately it looks like you cannot get the list of channels from a specific lineup, instead you have to get the whole channel list, which can be pretty big, and use a function to check whether a channel belongs to the desired lineup then, the first that matches is the one being used, not ideal, but it works and is only at start-up so no big deal.

Eddy

[Opus4]

Originally Posted by routerunner

Unfortunately it looks like you cannot get the list of channels from a specific lineup

Do you mean:

GetChannelsOnLineup(Lineup)?

- Andy

[routerunner]

Originally Posted by Opus4

Do you mean:

GetChannelsOnLineup(Lineup)?

- Andy

Hi Andy,

I know you're using that function in studio for the channel testing procedure, but that API is not published anywhere (AFAIK), I think is internal?

It could be useful indeed if made public...

Thanks
Eddy

[stuckless]

Originally Posted by routerunner

Hi Andy,

I know you're using that function in studio for the channel testing procedure, but that API is not published anywhere (AFAIK), I think is internal?

It could be useful indeed if made public...

Thanks
Eddy

It's a part of the Database API
http://download.sage.tv/api/sage/api...va.lang.String)

Keep in mind that ANY api called from the STV can be called from Java... (even if you have to use the sage.SageTV.api() method to call it)

[routerunner]

Originally Posted by stuckless

It's a part of the Database API
http://download.sage.tv/api/sage/api...va.lang.String)

Keep in mind that ANY api called from the STV can be called from Java... (even if you have to use the sage.SageTV.api() method to call it)

Ahaaaa!!!! Thank you so much...strange place to put that function call though

Eddy

[routerunner]

Sorry, another minor thing, the utility method "GetWindowsRegistryStringValue()" is supposed to return a "String" and not an "Integer".

The API specification are wrong, however I now you cannot do anything about it, just thought worth mention it.

Thanks
Eddy

[dvd_maniac]

I installed the plugin but I can't access the url to initiate an imported library scan.
I keep getting a 404 ERROR: Not Found.
So I enabled Sage logging and found this in it:
SageTVPlugin[sagex-api state=Failed name=sagex-api - SageTV API Extensions version=7.1.9.26 type=Library desc=SageTV API Wrappers with Remote API capabilities

I'm running SageTV 7.1.9.256
I also have Jetty Web Server 2.3.0.14 and SageTV Web Interface 2.43 installed.
Another note in case it matters, is that I installed SageTV to a non-default location: S:\SageTV\SageTV
I can get to the web server fine but not to the sagex APIs
http://127.0.0.1:8080/sage/Home/

[ranger]

A few weeks ago my SageTV server started some bizarre behavior so I did a full re-install of Sage and the plugins. I had Phoenix Core Services installed at the rebuild, but just today installed Jetty web server and BMT Web services. After installing the BMT web services Phoenix Core Services shows a "Failed" state on the installed plugins page. The BMT web page seems to work fine. So far I cannot get the Sage plugin for Plex working, but that is the only visible problem I have found so far.

I've tried uninstalling and re-installing, but I get the same problem. I have changed the jetty tcp port and the username and password, but that is all the custom changes I have made. I'm not sure where to look for issues, so if you could point me to any logs or requirements I might have missed, it would be appreciated.

[hvymetal]

Not sure if this will get fixed but posting for other that might have issues. Sagex services are not working with java16 and latest jetty updated by jusjoken.

Using the example sagex service

http://192.168.10.176:8080/sagex/api?c=sagex:Echo&1=Bill&encoder=json

#####JAVA 16#####

{"sagexVersion":"9.2.6.1","exception":"java.lang.RuntimeException: java.lang.NullPointerException: Cannot invoke \"javax.script.ScriptEngine.getBindings(int)\" because \"engine\" is null\n\tat sagex.remote.api.ApiHandler.callService(ApiHandler.java:195)\n\tat sagex.remote.api.ApiHandler.handleRequest(ApiHandler.java:129)\n\tat sagex.remote.SagexServlet.doPost(SagexServlet.java:120)\n\tat sagex.remote.SagexServlet.doGet(SagexServlet.java:58)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:687)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:790)\n\tat org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:799)\n\tat org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:550)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:143)\n\tat org.eclipse.jetty.security.SecurityHandler.handle(SecurityHandler.java:560)\n\tat org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:127)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:235)\n\tat org.eclipse.jetty.server.session.SessionHandler.doHandle(SessionHandler.java:1624)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:233)\n\tat org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:1434)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:188)\n\tat org.eclipse.jetty.servlet.ServletHandler.doScope(ServletHandler.java:501)\n\tat org.eclipse.jetty.server.session.SessionHandler.doScope(SessionHandler.java:1594)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:186)\n\tat org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:1349)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:141)\n\tat org.eclipse.jetty.server.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:234)\n\tat org.eclipse.jetty.server.handler.HandlerCollection.handle(HandlerCollection.java:146)\n\tat org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:127)\n\tat org.eclipse.jetty.server.Server.handle(Server.java:516)\n\tat org.eclipse.jetty.server.HttpChannel.lambda$handle$1(HttpChannel.java:400)\n\tat org.eclipse.jetty.server.HttpChannel.dispatch(HttpChannel.java:645)\n\tat org.eclipse.jetty.server.HttpChannel.handle(HttpChannel.java:392)\n\tat org.eclipse.jetty.server.HttpConnection.onFillable(HttpConnection.java:277)\n\tat org.eclipse.jetty.io.AbstractConnection$ReadCallback.succeeded(AbstractConnection.java:311)\n\tat org.eclipse.jetty.io.FillInterest.fillable(FillInterest.java:105)\n\tat org.eclipse.jetty.io.ChannelEndPoint$1.run(ChannelEndPoint.java:104)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.runTask(EatWhatYouKill.java:338)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.doProduce(EatWhatYouKill.java:315)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.tryProduce(EatWhatYouKill.java:173)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.run(EatWhatYouKill.java:131)\n\tat org.eclipse.jetty.util.thread.ReservedThreadExecutor$ReservedThread.run(ReservedThreadExecutor.java:409)\n\tat org.eclipse.jetty.util.thread.QueuedThreadPool.runJob(QueuedThreadPool.java:883)\n\tat org.eclipse.jetty.util.thread.QueuedThreadPool$Runner.run(QueuedThreadPool.java:1034)\n\tat java.base/java.lang.Thread.run(Thread.java:831)\nCaused by: java.lang.NullPointerException: Cannot invoke \"javax.script.ScriptEngine.getBindings(int)\" because \"engine\" is null\n\tat sagex.remote.api.ServiceFactory.addGlobals(ServiceFactory.java:89)\n\tat sagex.remote.api.ServiceFactory.callService(ServiceFactory.java:49)\n\tat sagex.remote.api.ApiHandler.callService(ApiHandler.java:193)\n\t... 39 more\n","error":"java.lang.NullPointerException: Cannot invoke \"javax.script.ScriptEngine.getBindings(int)\" because \"engine\" is null"}

#####JAVA 11#####

{"Result":"Bill"}

[jusjoken]

Originally Posted by hvymetal

Not sure if this will get fixed but posting for other that might have issues. Sagex services are not working with java16 and latest jetty updated by jusjoken.

Using the example sagex service

http://192.168.10.176:8080/sagex/api?c=sagex:Echo&1=Bill&encoder=json

#####JAVA 16#####

{"sagexVersion":"9.2.6.1","exception":"java.lang.RuntimeException: java.lang.NullPointerException: Cannot invoke \"javax.script.ScriptEngine.getBindings(int)\" because \"engine\" is null\n\tat sagex.remote.api.ApiHandler.callService(ApiHandler.java:195)\n\tat sagex.remote.api.ApiHandler.handleRequest(ApiHandler.java:129)\n\tat sagex.remote.SagexServlet.doPost(SagexServlet.java:120)\n\tat sagex.remote.SagexServlet.doGet(SagexServlet.java:58)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:687)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:790)\n\tat org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:799)\n\tat org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:550)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:143)\n\tat org.eclipse.jetty.security.SecurityHandler.handle(SecurityHandler.java:560)\n\tat org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:127)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:235)\n\tat org.eclipse.jetty.server.session.SessionHandler.doHandle(SessionHandler.java:1624)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:233)\n\tat org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:1434)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:188)\n\tat org.eclipse.jetty.servlet.ServletHandler.doScope(ServletHandler.java:501)\n\tat org.eclipse.jetty.server.session.SessionHandler.doScope(SessionHandler.java:1594)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:186)\n\tat org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:1349)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:141)\n\tat org.eclipse.jetty.server.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:234)\n\tat org.eclipse.jetty.server.handler.HandlerCollection.handle(HandlerCollection.java:146)\n\tat org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:127)\n\tat org.eclipse.jetty.server.Server.handle(Server.java:516)\n\tat org.eclipse.jetty.server.HttpChannel.lambda$handle$1(HttpChannel.java:400)\n\tat org.eclipse.jetty.server.HttpChannel.dispatch(HttpChannel.java:645)\n\tat org.eclipse.jetty.server.HttpChannel.handle(HttpChannel.java:392)\n\tat org.eclipse.jetty.server.HttpConnection.onFillable(HttpConnection.java:277)\n\tat org.eclipse.jetty.io.AbstractConnection$ReadCallback.succeeded(AbstractConnection.java:311)\n\tat org.eclipse.jetty.io.FillInterest.fillable(FillInterest.java:105)\n\tat org.eclipse.jetty.io.ChannelEndPoint$1.run(ChannelEndPoint.java:104)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.runTask(EatWhatYouKill.java:338)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.doProduce(EatWhatYouKill.java:315)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.tryProduce(EatWhatYouKill.java:173)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.run(EatWhatYouKill.java:131)\n\tat org.eclipse.jetty.util.thread.ReservedThreadExecutor$ReservedThread.run(ReservedThreadExecutor.java:409)\n\tat org.eclipse.jetty.util.thread.QueuedThreadPool.runJob(QueuedThreadPool.java:883)\n\tat org.eclipse.jetty.util.thread.QueuedThreadPool$Runner.run(QueuedThreadPool.java:1034)\n\tat java.base/java.lang.Thread.run(Thread.java:831)\nCaused by: java.lang.NullPointerException: Cannot invoke \"javax.script.ScriptEngine.getBindings(int)\" because \"engine\" is null\n\tat sagex.remote.api.ServiceFactory.addGlobals(ServiceFactory.java:89)\n\tat sagex.remote.api.ServiceFactory.callService(ServiceFactory.java:49)\n\tat sagex.remote.api.ApiHandler.callService(ApiHandler.java:193)\n\t... 39 more\n","error":"java.lang.NullPointerException: Cannot invoke \"javax.script.ScriptEngine.getBindings(int)\" because \"engine\" is null"}

#####JAVA 11#####

{"Result":"Bill"}

Makes sense. Java 16+ doesn't include Javascript so these processes will fail.

There are solutions that I will probably look at but we have Java 8 and 11 at this time.

Is there a specific need for 16?

K