ogg dev - May 2008 - [PATCH] browser_plugin - kate support, build fixes, and misc

where is the latest javascript api documented? it does not look like 
http://wiki.xiph.org/index.php/OggPlayJavascriptAPI has been updated 
recently.

I had trouble getting oggplay to run at all on my machine ubuntu (7.10) 
But I would be interested in revisiting the issue...

--michael

Conrad Parker wrote:
> 2008/5/1 ogg.k.ogg.k at googlemail.com <ogg.k.ogg.k at
googlemail.com>:
>   
>>>>   - kate support (what else) - this bumps the Javascript API to
1.1
>>>>         
>>  >
>>  > I've not yet committed this to trunk. It does sound pretty
cool
>>
>>  Can you let me know the reasons (eg, wanting to test first, concerns
>>  over the substance of the changes, or other) ?
>>     
>
> sure, the main reason is that we're trying to stabilize the trunk, and
> you described this as a work in progress. The other reason is that
> it'd be good to get some other feedback -- I'm not so familiar with
> the internals of oggplay, though I'm happy to do maintenance and am
> trying to learn my way around the code too :-)
>
> If you like I'll push it into a branch, and we can encourage some more
> testing from there.
>
>   
>>  There were no comments so far about the changes to the Javascript
>>  API, so I'll assume people have no problem with those ?
>>     
>
> It'd be good to get feedback from shane and mdale on that ...
>
> Conrad.
>

> where is the latest javascript api documented? it does not look like
> http://wiki.xiph.org/index.php/OggPlayJavascriptAPI has been updated
> recently.
Well, I was aware of that page, but I wasn't going to change it by myself
before the patch would be accepted :)
If it is, I'll update the page.

Here's an overview for now:

+  long getNumKateTracks();

returns the number of Kate tracks found in the current stream.

+  long getCurrentKateTrack();

returns the index of the currently selected Kate track (-1 if none is)

+  string getKateTrackLanguage(in long track);

returns the language (eg, "en", or "en_GB") of the trackth
Kate track
in the current stream
(may be empty if none specified in the stream)

+  string getKateTrackCategory(in long track);

returns the category (eg, "subtitles") of the trackth Kate track in
the current stream
(may be empty if none specified in the stream)

+  void selectKateTrack(in long track);

selects the trackth Kate track in the stream, -1 to select no track at all.

+  void registerKateCallback(in nsILibOggCallbackString callback);

sets a routine to be called with any Kate text from the currently selected track
(if any) as its presentation time is reached.

+  void setKateFont(in string font);

sets the font to use for displaying text (a string, eg "arial"). This
should be the
name of a font without path and without ".ttf" appended. If such a
font isn't
found, a default font will be used.

+  string getKateFont();

returns the font being used - actually, this is what it should do, I
just realized
it returns the font you requested if you requested one, rather than the default
if the requested one isn't found - I'll fix that.

+  void setKateFontSize(in float relsize);

sets a font size multiplier to be used. The default is to use a font
size based on
the size of the video, but all fonts do not appear as large with the
same "point"
size, so this can be used to increase/decrease font size - also useful
for people
who prefer larger fonts.

+  float getKateFontSize();

returns the current font size multiplier.

+  void setKateRendering(in long method);

sets how to render the currently selected Kate stream (if any):
0: do not render anything (if a callback is registered, text will
still be sent to it,
  useful if one wants to not display anything but send the text to
text-to-speech)
1: render as text
2: render as overlay (YUV data from liboggplay, not implemented yet)

+  long getKateRendering();

returns the current render method being used.


I thought of adding a setKateColor/getKateColor pair as well, as different
colors would be better for different video backgrounds. Not sure about this.
> I had trouble getting oggplay to run at all on my machine ubuntu (7.10)
> But I would be interested in revisiting the issue...
Anything to do with my changes ? Error messages ?

Cheers

> where is the latest javascript api documented? it does not look like
I've added the list I posted to the suggested modifications list on the
wiki.