Kinoma - Support - Tech Note 7

Tech Note 7: Using the Kinoma Play ActiveX Control

Initial Version: December 18, 2008

Summary

Kinoma Play provides an ActiveX Control, AXKinoma, to allow web pages viewed using Internet Explorer on Windows Mobile phones to detect and interact with Kinoma Play.

AXKinoma is automatically installed along with Kinoma Play and Kinoma FreePlay.

Using AXKinoma

To use AXKinoma, the first step is to instantiate an instance of the object:

var Kinoma = new ActiveXObject("Kinoma.KinomaCtl")

Instantiating AXKinoma is fast and lightweight.

Get version

The AXKinoma instance can be used to retrieve information about the version of Kinoma Play installed:

var version = Kinoma.application

The version string consists of the application name (e.g. “Kinoma Play” or “Kinoma FreePlay”) followed by a slash and then the version number. For example: “Kinoma Play/5.0.35” or “Kinoma FreePlay/5.0.35”.

Play a URL

To request that Kinoma Play play a URL, use the play function:

Kinoma.play("http://www.hoddie.net/t1.mp3");

The play function launches Kinoma Play (if it’s not already running) and brings it to the foreground. The play function works with any URL that accepted by the Open URL command in Kinoma Play, including YouTube URLs.

In addition to standard URLs the play function also accepts “short-cut URLs”, which are special URLs to access specific areas within Kinoma Play. Short-cut URLs have the form:

x-kp5://open?what=[destination]

The following table shows the values for [destination]:

[destination]	Location in Kinoma Play
Pictures	My Media Files > Pictures
Movies	My Media Files > Movies
Music	My Media Files > Music
Panoramas	My Media Files > Panoramas
Audiobooks	My Media Files > Audiobooks
Playlists	My Media Files > Playlists
Audible	Services > Audible
Flickr	Services > Flickr
KinomaGuide	Kinoma Guide
Live365	Services > Live365
Orb	Services > Orb
Shoutcast	Services > SHOUTcast
YouTube	Services > YouTube

Test if running and activate

To determine if Kinoma Play is currently running, and to bring it to the foreground:

if (Kinoma.running)
	Kinoma.activate()

Sample web page

The following is a complete example of a simple HTML web page that uses AXKinoma to play an MP3 stream.

<html>
<head><title>Kinoma ActiveX Sample</title></head>
<body>
<script language="JScript">
	function play(uri)
	{
		try {
			var Kinoma = new ActiveXObject("Kinoma.KinomaCtl")
			Kinoma.play(uri)
		}
			catch (e) {
		}
	}
</script>
<form>
    <input type="button" value="Play YouTube Video" 
        onclick="play('http://www.youtube.com/watch?v=49jKeGyUCJE')">  
    <input type="button" value="Go to Kinoma Play > Pictures" 
        onclick="play('x-kp5://open?what=Pictures')">  
</form>
</body>
</html>

The exception handling on the instantiation of AXKinoma is necessary to avoid errors on phones where Kinoma Play is not yet installed.

You can see this code in action by going to http://kinoma.com/m/activex/ with your phone.