OggPlayJavascriptAPI - Revision history

Ogg.k.ogg.k: /* Kate streams */

2008-05-09T12:25:58Z

Kate streams

← Older revision		Revision as of 12:25, 9 May 2008
Line 380:		Line 380:

	[[Kate]] is a codec carrying text to be overlayed on video, eg as subtitles.		[[Kate]] is a codec carrying text to be overlayed on video, eg as subtitles.

			A patch has been sent to the ogg-dev list with the following API:

	long getNumKateTracks();		long getNumKateTracks();

Ogg.k.ogg.k: /* Kate streams */

2008-05-09T12:16:02Z

Kate streams

← Older revision		Revision as of 12:16, 9 May 2008
Line 443:		Line 443:
	0: do not render anything (if a callback is registered, text will		0: do not render anything (if a callback is registered, text will
	still be sent to it,		still be sent to it,
	useful if one wants to not display anything but send the text to		useful if one wants to not display anything but send the text to
	text-to-speech)		text-to-speech)
	1: render as text		1: render as text

Ogg.k.ogg.k: add proposed kate stream api to the suggested changes list

2008-05-09T12:13:33Z

add proposed kate stream api to the suggested changes list

← Older revision		Revision as of 12:13, 9 May 2008
Line 375:		Line 375:

	* suggestion: Include audio capture (and Speex encoding) in the API		* suggestion: Include audio capture (and Speex encoding) in the API


			==Kate streams==

			[[Kate]] is a codec carrying text to be overlayed on video, eg as subtitles.

			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.

Laser13: /* Individual movies */

2008-01-25T06:56:16Z

Individual movies

← Older revision		Revision as of 06:56, 25 January 2008
Line 106:		Line 106:

	Use null if you want to deregister the callback without setting a new one.		Use null if you want to deregister the callback without setting a new one.

			=== registerOnMouseClickCallback ===

			To have the plugin call a javascript method when user click in plugin area:

			registerOnMouseClickCallback(function callback(void))

			''See [[#Callback_functions\|Callback functions]] for details on setting up a Javascript callback function.''


	=== setVolume ===		=== setVolume ===

Mdale: /* insertMovieBefore */

2007-09-14T18:59:43Z

insertMovieBefore

← Older revision		Revision as of 18:59, 14 September 2007
Line 241:		Line 241:

	=== insertMovieBefore ===		=== insertMovieBefore ===
			'''suggested alteration''' have it be insertMovieBefore(string url, [pos])
			so that the pos is optional and if missing just inserts before the current clip in the playlist

	To insert a movie before a specified position in the playlist:		To insert a movie before a specified position in the playlist:

Mdale: /* getDuration */ getMovieLength

2007-07-14T16:52:04Z

getDuration: getMovieLength

← Older revision		Revision as of 16:52, 14 July 2007
Line 342:		Line 342:
	a function to begin loading the current clip without playing it back.		a function to begin loading the current clip without playing it back.

	~~== getDuration ==~~
	~~get the clips duration~~

	== getBufferedTime ==		== getBufferedTime ==
	Its unclear if get Buffered time gives you the milliseconds buffered from the beaning of the clip, but thats what it should do. To enable the display of a progress bar for the full clip. Ie getBufferedTime / getDuration		Its unclear if get Buffered time gives you the milliseconds buffered from the beaning of the clip, but thats what it should do. To enable the display of a progress bar for the full clip. Ie getBufferedTime / getDuration

Tahn: Added description for passing callback functions

2007-07-09T12:39:18Z

Added description for passing callback functions

← Older revision		Revision as of 12:39, 9 July 2007
Line 79:		Line 79:
	registerCMMLCallback(function callback(string))		registerCMMLCallback(function callback(string))

	''See ~~the "~~Callback functions~~" section~~ for details on setting up a Javascript callback function.''		''See [[#Callback_functions\|Callback functions]] for details on setting up a Javascript callback function.''

	Use null if you want to deregister the callback without setting a new one.		Use null if you want to deregister the callback without setting a new one.
Line 89:		Line 89:
	boolean success <- retrieveAnnotations(function callback(string))		boolean success <- retrieveAnnotations(function callback(string))

	''See ~~the "~~Callback functions~~" section~~ for details on setting up a Javascript callback function.''		''See [[#Callback_functions\|Callback functions]] for details on setting up a Javascript callback function.''

	This is an asynchronous call; the plugin will create a new http connection to retrieve the annotations. The callback function will be invoked with the annotation string after the annotations have been retrieved.		This is an asynchronous call; the plugin will create a new http connection to retrieve the annotations. The callback function will be invoked with the annotation string after the annotations have been retrieved.
Line 103:		Line 103:
	registerEndPlayCallback(function callback(void))		registerEndPlayCallback(function callback(void))

	''See ~~the "~~Callback functions~~" section~~ for details on setting up a Javascript callback function.''		''See [[#Callback_functions\|Callback functions]] for details on setting up a Javascript callback function.''

	Use null if you want to deregister the callback without setting a new one.		Use null if you want to deregister the callback without setting a new one.
Line 198:		Line 198:
	registerPlaylistCallback(function callback(void))		registerPlaylistCallback(function callback(void))

	''See ~~the "~~Callback functions~~" section~~ for details on setting up a Javascript callback function.''		''See [[#Callback_functions\|Callback functions]] for details on setting up a Javascript callback function.''

	Use this function to register a javascript function that will get called by the plugin at the end of each movie in the playlist - i.e. when the playlist changes tracks. The last track does '''not''' trigger a call; the end play callback, if registered, will be invoked instead.		Use this function to register a javascript function that will get called by the plugin at the end of each movie in the playlist - i.e. when the playlist changes tracks. The last track does '''not''' trigger a call; the end play callback, if registered, will be invoked instead.
Line 286:		Line 286:
	boolean success <- retrieveAnnotationsAt(int position, function callback(string))		boolean success <- retrieveAnnotationsAt(int position, function callback(string))

	''See ~~the "~~Callback functions~~" section~~ for details on setting up a Javascript callback function.''		''See [[#Callback_functions\|Callback functions]] for details on setting up a Javascript callback function.''

	As per retrieveAnnotations, this function is an asynchronous call and will not return any annotations if the server does not support out-of-band annotation retrieval.		As per retrieveAnnotations, this function is an asynchronous call and will not return any annotations if the server does not support out-of-band annotation retrieval.
Line 302:		Line 302:
	== Callback functions ==		== Callback functions ==

	(to do)		Since Javascript functions are not first-class objects, you can't pass one directly to the plugin as a callback. You need to wrap your callback in an anonymous object with a single member, 'call':

			// Use this form for callbacks with a string argument, shown as ''function callback(string)'':
			plugin.registerCMMLCallback(
			{
			call: function(s) { yourCMLLCallback(s); }
			}
			);

			// Use this form for callbacks with no arguments, shown as ''function callback(void)'':
			plugin.registerEndPlayCallback(
			{
			call: function() { yourEndPlayCallback(); }
			}
			);

			Technically, you can inline your callback handling code directly in the 'call' function, but it's much cleaner to just redirect to a stand-alone function for each callback, as shown above.

			Deregistering a callback is quite simple:

			plugin.registerPlaylistCallback(null);

	= Suggested modifications =		= Suggested modifications =

Tahn: Updated to match the released liboggplay 1.0 api, plus some extra versioning functions that will be added real soon now

2007-07-09T12:14:05Z

Updated to match the released liboggplay 1.0 api, plus some extra versioning functions that will be added real soon now

Show changes

Tahn: Added removeMovieAt

2007-06-28T01:59:08Z

Added removeMovieAt

← Older revision		Revision as of 01:59, 28 June 2007
Line 231:		Line 231:

	boolean success <- insertMovieBefore(int position, string url)		boolean success <- insertMovieBefore(int position, string url)

			This function will return false if the position points to a slot outside the bounds of the playlist.

			=== removeMovieAt ===

			To remove a movie from the playlist:

			boolean success <- removeMovieAt(int position)

	This function will return false if the position points to a slot outside the bounds of the playlist.		This function will return false if the position points to a slot outside the bounds of the playlist.

Conrad: /* play */ typo

2007-06-02T13:00:39Z

play: typo

← Older revision		Revision as of 13:00, 2 June 2007
Line 275:		Line 275:
	if current state is NULL set state to LOADING else if already in loading state than a second call to play will force playback of what is available.		if current state is NULL set state to LOADING else if already in loading state than a second call to play will force playback of what is available.

	when a user hits play internally we store a separate state that reports as LOADING but is really LOAD_TO_PLAY state which uses download rate control to predict when we should switch into playing mode. ie if the clip's duration is 60 seconds and after one second we have buffered 10 seconds of the clip we can safely immediately switch to play mode. In ~~diffrent~~ instance if after 10 seconds we have downloaded 5 seconds of the clip we should wait until we have buffered 40 seconds as it will take around 40 seconds to download the last 20 seconds of video.		when a user hits play internally we store a separate state that reports as LOADING but is really LOAD_TO_PLAY state which uses download rate control to predict when we should switch into playing mode. ie if the clip's duration is 60 seconds and after one second we have buffered 10 seconds of the clip we can safely immediately switch to play mode. In a different instance if after 10 seconds we have downloaded 5 seconds of the clip we should wait until we have buffered 40 seconds as it will take around 40 seconds to download the last 20 seconds of video.

	if the clip is a LIVE stream then it will begin playback after a few seconds have been buffered. Controllable by:		if the clip is a LIVE stream then it will begin playback after a few seconds have been buffered. Controllable by: