STV Import: Alon24Utils

[alon24]

I have updated my first STVI in the download section

This STVI is for the regular SageStv, it assumes you have enabled the Unofficial secrets (in the the system information screen).
another prerequisit: Nielms dynamic menu.

0.2.5 is out - 08/19/06

New significant change is the new commands in Stvutils:
suggestLinkCommand - create a text file with a suggest set of commands that will gurentee linking to the spot where the widget is.

• doesWidgetExist - help you to determine if the wisget path you have specified is legal.
• isCommandLeagal - helps to identify f the command you want to add is legal(a legal alon24Utils command that is placed in the imported widgets)

What these options allow you is to ease the transfer from code in the stv into an stvi.
If you add an Action widget with the name: alon24_Stvutils_suggestLinkCommand() and then evaluate it, it will create a txt file with the following:

1. Full path - so that you know where you are (and not have to start coping)
2. Full path beutified - if you do not want to use the new automatic commands, then there are rules for beutifications, the important thing is: You do not need to remember them!!!.
3. Suggestions for commands - These are suggestions for automatic commands

• linkMe - Add this to your import and then when you run the automatic commands, the widget will change and a link to the existing widget will replace it.

• LinkParent - Use this to insert your code to a specific place (to, before or after an existing widget)

• Also check out parentsChildren command - This command will link all the children of the parent to the specified location. This is usefull for adding LIsteners,Hooks and such to a location of your choosing (so look at the STVI and handleLinkOperation and handleAllLinkOperation.

Utils changes:

• renameExistingWidget - rename a widget from the existing widgets pool
• renameImportWidget - rename a widget from the imported widgets pool
• handleReplaceTheams - Replace all the themes starting with ReplaceMe with the appropriate theme.
• Many bug fixes

STV changes:

1. NTE search for Video library
2. Added option to Recorded programs screen (malor) to change the name and subtitle of the program (usefull if you did a time recording, or want to give an episode name).

General:

New Toolkit, allows to add An action to the imported widdget with the location to link to.

Before using the functions you must call init()
When done with the Import Actions, and work related to the toolkit, please call finish().

static void init(java.lang.Object[] existing, java.lang.Object imported)
Initalize so that the util can start working
finish() - Call to do final cleanup

deleteWidgetTree(java.lang.Object widget) - Delete the tree of widgets, starting from widget.

deleteWidgetTree(java.lang.Object parent, java.lang.String pathToDelete, java.lang.String type)
Delete the tree of widgets, starting from pathToDelete.
forceEPGUpdate() - Utility function to force an EPG update
getChild(java.lang.Object widget, java.lang.Integer index)
Giet the widget's child at location index.
getChildren(java.lang.Object widget) - Return the widgets children
getElementatIndex(java.lang.Object arr, java.lang.String index)
Get the element from an array of arrays
Useful in a case when getting an array of arrays in return to a query.

static java.util.HashSet getImportActionsByID(java.lang.Integer id)
Retrieve a list of ImportedActions based on the id given to them by the user.

getImportedMenu(java.lang.String menuName)
Search in the list of Imported widgets and return a Menu by name.
static java.lang.Object[] getImportedWidgetByUniquePath(java.lang.String path, java.lang.String type)
Get the Widget by a stating a unique path (does not have to start at from the root of the menus).
Searches in the Imported Items.

getLocationInChildren(java.lang.Object parent, java.lang.Object child)
Search for the location of a widget in a parent.
Usefull for adding widgets after another one, when the parent is known.

getName(java.lang.Object widget) - Return the widget's name

static java.lang.Object[] getParents(java.lang.Object widget)
Get an array of the widget\s children.

static java.lang.Object[] getWidgetsByUniquePath(java.lang.Object widgets, java.lang.String path, java.lang.String type)
Get a widget based on a path (seperated by /)
Can be a path not stemming from the Main Menu.
For instance if we know that our unique path is simple, and a small part can represent it, we do not have to give that as a paramater, only the small part.

static void handleAllLinkOperation()
Iterate over all the Import Actions, and act on them.

static void handleLinkOperation(java.lang.Integer id)
Search for all the ImportActions by ID, and act on them.

static java.lang.Object linkMe(java.lang.Object linkWidget, java.lang.String linkLocationPath, java.lang.String linkLocationType)
Link the widget to the widget at the end of the location path, and of type LinkLocationType.
After this, remove the child-parent connection of the widget from its previous parent.

static java.lang.Object[] linkWidgetToLocation(java.lang.Object linkWidget, java.lang.String linkLocationPath, java.lang.String linkLocationType)
Link the linkWidget to the parent in the ExistingWidgets

static java.lang.Object[] linkWidgetToLocation(java.lang.String linkWidgetPath, java.lang.String linkWidgetLocationType, java.lang.String linkLocationPath, java.lang.String linkLocationType)
Link the linkWidget from importedWidgets to the parent in ExistingWidgets.

static void log(java.lang.String msg)

static java.lang.String pathToString(java.lang.Object[] path)
Run on the path of Objects and crate a String repesentation, seperated byt a coma.

static void printChildren(java.lang.Object parent)
Log print the a list of the widget's children.

static java.lang.Object renameExistingWidget(java.lang.String path, java.lang.String type, java.lang.String newName)
Rename the widget

static java.lang.Object renameImportWidget(java.lang.String path, java.lang.String type, java.lang.String newName)
Rename the widget
void setDebugState(boolean state)
State the debug state,
static java.lang.Object[] superLinkWidget(java.lang.Object linkWidget, java.lang.String linkLocationPath, java.lang.String linkLocationType, java.lang.String where)

static java.lang.Object[] superLinkWidget(java.lang.String linkWidgetPath, java.lang.String linkWidgetType, java.lang.String linkLocationPath, java.lang.String linkLocationType, java.lang.String where)
Link linkWidget to linkLocation following these rules:

The new thing is that you are able to give the path to the widget and type instead of having to find it in the first place.
2. you always get a return value either only the widget, or all the widgets leading to the widget.
3.Automatic handling of Imported Actions which are there to make life easier.

0.2.3 07/19/06
changed code so that user can add multipule widgets with different id to the same parent, so that, the user can select wether to run this or that id if he needs to compily say with MCE or Regular STV. (java doc explains better)...

0.2.2 07/18/06

1.Added support for "On The Fly" file searching in the Video Folders View, just go there and start typing, and look at the choices deplete. This is usefull if you are like me and have everything together and its just a mess.

2.Now support a new ToolKit to help write STVi's in a much nicer way.
Please read the Javadocs.

3.forceEPGUpdate changed case (used to be ForceEPGYpdate)

0.1
Benefits:

• force epg update from cmd line. there are 2 files:updateserver.bar and updateclient.bat. After you run your epg getter (whichever), run one of these files and sage will import the epg on the spot. No longer do you have to wait for the next epg update by sage, you can force. This is most helpull especially when there were changes and you had to get the EPG on the spot to capture them. now you can just run the batch file and not have to mess with Sage's UI.
• Added record icon to osd - I realy missed the record Icon in the liveTV OSD, so I added it.
• Added support for epg update from epg screen (extended malor) -
• Force EPG update from sage with one button.
• Added support for videoredo from recording menus
• Added support to do VideRedo from sage, no need to check the path and then load it in VideReo, just go tho the Recordings Menu and right click the program to ViedoReDo it.

http://forums.sagetv.com/forums/down...?do=file&id=88

Edit:
I just wanted to thank all the people that wrote all the utils and previous STVI, from which I shamelessly copy code

[evilpenguin]

What are you doing with video redo? Cutting out commericals?

[alon24]

I am cutting the begining and ending of the file (I do it manually), because I record 2 mins before and 2 after.

I would be adding support for Joining the files (if you have multipul parts).

After that I compress the files to XVId and archive them others to view on a regular Divx, DVD.

[slowpoke]

Originally Posted by alon24

I have added my first STVI so to the download section

This STVI is for the regular SageStv, it assumes you have enabled the Unofficial secrets (in the the system information screen).
another prerequisit: Nielms dynamic menu.

Benefits:
1.force epg update from cmd line. there are 2 files:updateserver.bar and updateclient.bat.
after you run your epg getter (whichever), run one of these files and sage will import the epg on the spot. No longer do you have to wait for the next epg update by sage, you can force.
This is most helpull especially when there were changes and you had to get the EPG on the spot to capture them. now you can just run the batch file and not have to mess with Sage's UI.
2. add record icon to osd - I realy missed the record Icon in the liveTV OSD, so I added it.
3. add support for epg update from epg screen (extended malor) -
force EPG update from sage with one button.
4. add support for videoredo from recording menues
Added support to do VideRedo from sage, no need to check the path and then load it in VideReo, just go tho the Recordings Menu and right click the program to ViedoReDo it.

Edit:
The Stv assumes that there is a file called c:\redo.bat which calls the videoReDo software with the param.

This batch file is not in right now, It will be added later.
http://forums.sagetv.com/forums/down...?do=file&id=88

I'm really interested in the command line epg import; is there any way I would be able to install just that or do you have an import for just that? I'm new to SageTV and haven't tried programming stvi's yet - although I do progran so I don't think there should be much trouble learning it - do you have a function for the EPG update that I could use in my first attempts at an import?

Thanks.

[alon24]

if you install my STVI you will get all the current features.
If you look at the stvi you will see I just listen for the Custom2 event which you can send to sage using sthe sendEvent mechnizem (read the sage.pdf).
and then I progrematicly do 1.get channels, deactivate all channels, reactivate chhannels, home)
this code tells sage to refresh (its in the jar), its baisiclly a copy from nielms force EPG update code from the Server.

[slowpoke]

Originally Posted by alon24

if you install my STVI you will get all the current features.
If you look at the stvi you will see I just listen for the Custom2 event which you can send to sage using sthe sendEvent mechnizem (read the sage.pdf).
and then I progrematicly do 1.get channels, deactivate all channels, reactivate chhannels, home)
this code tells sage to refresh (its in the jar), its baisiclly a copy from nielms force EPG update code from the Server.

Awesome - thanks for the explanation.

[kricker]

Can you explain how you did the Video Redo button. I want to add this option for SageMC and I have no idea where to even start.

[alon24]

I will be publishiing my own toolkit which will help doing regular linking between widgets with its ownset of functions.

This set of functions is inspired by the one that flachbar wrote (http://forums.sagetv.com/forums/showthread.php?t=17063) but with a few tweaks of my own (all new code), so this should help with actually linking the widgets.

Now for the VideoReDo, I got the name of the show that is currently highlighted, got how many parts and basicly run the VideoReDo prog.
I may not understand your question fully, so please take a look at the STVI in Studio and ask a more specific question.

I will be happy to answer...

[reboot_this]

Am I understanding this correctly?...

I have yet to install Sagetv v5.x due to having to rebuild XP before doing so. (So at this time cannot do any testing) But am curious about your STV, alon24.

If I had Sagetv v5.x, your stvi, and videoredo (currently have this)... that I can somehow click on a video and have the commercials automatically removed without further input from myself?

One reason I ask is that, having videoredo to test with, I cannot seem to get it to "automatically" (without additional input) remove commercials, even when I use the batch manager, which I thought was supposed to automate the process but it just creates a *.prj file that I have to manually open and process.

(because if this is true, I just might have to take off work to rebuild XP and start using this stvi!)

[alon24]

Sorry my stvi currently does not allow for this.
what it does is just load the video re do on the current file, no more
There shouldn't be a problem doing automatic scanning for commercials, but 2 things come to mind
1. you need to have an stv that supports the resulting files (projects) and will show in sage that output.

Or do you mean just cut the file, and replace it automatically?

if you chose opt1, then why not go the comskip and dir mon route???

[reboot_this]

1. you need to have an stv that supports the resulting files (projects) and will show in sage that output.

Or do you mean just cut the file, and replace it automatically?

I was talking about the "just cut and replace" method, would your stvi have this capabilty?

Another question... is there a way to have videoredo "just cut and replace" video files? if so, I have been unsuccessful in finding this option. I don't mind jumping out of sage to implement this.

I just started with videoredo, and every file I have thrown at it in testing has been accurately "commercial free"!!! It's awesome.

[alon24]

well videoredo employes a script file in its installation directory.
check that file out.

Just create a simple script (like when u add to a batch job for instance), that will cut the commercials, delete the original and copy the new one.
save that to c:\redo.bat.

I am pretty sure that this should do the trick for now, but sage will still show the old length (with commerical) but should play ok.

Try it out (on an irrelevent file first) and see if it works

[alon24]

I have posted a new version 0.2.2.
now added a new toolkit and lots of functions.,

Also added, search on the fly for video files in video libray.

Check out the first message and please let me know if things do not work, or your opininon.

alon24

[alon24]

I added a new version 0.2.3 which now gives a way to handle more difficult scenarios where the STVi needs to do x if import for say MCE STV and another for Regular STV.

Check out the download and my example there, and the Javadocs.

[alon24]

0.2.5 is out - 08/19/06

New significant change is the new commands in Stvutils:
suggestLinkCommand - create a text file with a suggest set of commands that will gurentee linking to the spot where the widget is.

doesWidgetExist - help you to determine if the wisget path you have specified is legal.

isCommandLeagal - helps to identify f the command you want to add is legal(a legal alon24Utils command that is placed in the imported widgets)

What these options allow you is to ease the transfer from code in the stv into an stvi.
If you add an Action widget with the name: alon24_Stvutils_suggestLinkCommand() and then evaluate it, it will create a txt file with the following:
Full path - so that you know where you are (and not have to start coping)
Full path beutified - if you do not want to use the new automatic commands, then there are rules for beutifications, the important thing is: You do not need to remember them!!!

Suggestions for commands - These are suggestions for automatic commands
linkMe - Add this to your import and then when you run the automatic commands, the widget will change and a link to the existing widget will replace it.

LinkParent - Use this to insert your code to a specific place (to, before or after an existing widget)

Also check out parentsChildren command - This command will link all the children of the parent to the specified location. This is usefull for adding LIsteners,Hooks and such to a location of your choosing (so look at the STVI and handleLinkOperation and handleAllLinkOperation.


Utils changes:
* renameExistingWidget - rename a widget from the existing widgets pool

* renameImportWidget - rename a widget from the imported widgets pool
* handleReplaceTheams - Replace all the themes starting with ReplaceMe with the appropriate theme.


*Many bug fixes

STV changes:
**NTE search for Video library
**Added option to Recorded programs screen (malor) to change the name and subtitle of the program (usefull if you did a time recording, or want to give an episode name).

As always check the javadoc for help.

P.S
Look at the first post for more details.

[alon24]

I see people are downloading this, but nobody is writing...


Does anyone have anything to comment on this toolkit I built?

[rsagetv99]

Originally Posted by alon24

I see people are downloading this, but nobody is writing...


Does anyone have anything to comment on this toolkit I built?

Maybe because not a lot of people know what it can do other than the features that you have included. Or maybe that's just my excuse.

What is a widget?

I have been looking for a way to add options to the recordings screen, specifically I would like to be able to add options that allow Sage to pass the filename of a show to a batch file for some external processing. Kind of like your VideoRedo button. One thing that comes to mind is a button that you could click to delete the comskip txt and edl files for a show so that it could be re-comskipped.

Will this toolkit allow me to add buttons like that?

[alon24]

First I refer you to the studio documention, there you will learn all about widgets. http://forums.sage.tv/forums/showthread.php?t=13677

The toolkit gives you api, for us in building a STVi.
It is not a end user interface, but rather a simplification of some very tedius tasks, you had to do by hand, in order to build an STVi of your own.

The main problem with building an STVi is getting all your stuff into the correct place, on everybodys current STV.

During that, you have to find where to add widgets, find the widgets that you are importing, and link them, u will need to delte and replace, and many other things that are in use by stuido.

I also refer you to Nielms dynamic menu STVi, so that you can add menues at will, very simply. http://forums.sage.tv/forums/showthread.php?t=13527

[rsagetv99]

I loaded your STVi, but I do not see any of the buttons you describe - E.G. EPG Update, Video Redo, etc.

Do I need to configure something to get it to work?

[alon24]

did u happen to see the prerequisits:

This STVI is for the regular SageStv, it assumes you have enabled the Unofficial secrets (in the the system information screen).
another prerequisit: Nielms dynamic menu.



btw, I will be putting out a version soon that does not need these pre requisits, but currently, they are needed.