EZK scripting from A to Z

EZK Main Object

This documentation is still being developed.
Objects, parameters and other functions may differ from final version.

Functions and calls:

EZK.CreateObject (ObjectName)
Enables creation of other ActiveX object

EZK.EndScript
Ends execution of script

EZK.Flush
Flushes the buffer contents to the client.
Same as ASP's "response.flush"

EZK.InsertXMLHeader
Includes a valid XML header for XML/KML pages.
Future versions probably validate XML before sending to client.

EZK.Output data
Adds the following data (string) to the output buffer.
Example: EZK.Output "Hello world"

EZK.QuickInfo (variable as string)
A quick way to get some global information. Variables such as: serverip, clientip, server version, etc is available. It can also report query strings if specified with a leading $. Example: if the script requested is something like: http://server:8888/ezk/file.ezk?test=abc , then ezk.quickinfo("$test") will report "abc"

EZK.RedirectTo (newurl as string)
Redirects the client to the new url.
Works for both KML and HTML.

EZK.WorkingOn "Something"
For debugging purposes.
Specifies what the code will do next, and if an error happens, EZK will report the last workingon definition.
Can also be used by inserting a veritcal bar in the begining of the line, example:
| Running the sql query
is the same as
EZK.WorkingOn "Running the sql query"

EZK Objects

EZK.Client
Client object

EZK.Client.ClientIP - String containing the remote IP of the client (ex: "192.168.0.100")
EZK.Client.PlayerID - String containing the remote player ID, if detected
EZK.Client.Language - String containing the remote player language setting, if detected
EZK.Client.LanguageID - Integer containing the remote player language number, if detected
EZK.Client.PlayerModel - String containing the remote player model, if detected
EZK.Client.isPlayer - Boolean that returns true if the remote client is a player (ex: DP-500
EZK.Client.isKMLBrowser - Boolean that returns true if the remote client is a KML Browser (ex: EzLink's KML Browser PRO)
EZK.Client.isWEBBrowser - Boolean that returns true if the remote client is a standard web browser (ex: Internet Explorer, Netscape)
EZK.Client.PlayerVersion - String - Firmware version of the player, if detected
EZK.Client.PlayerMaker - String - Brand name of the player, if detected
EZK.Client.Width - Long - Available screen width (returns -1 if not detected or dynamic)
EZK.Client.Height - Long - Available screen height (returns -1 if not detected or dynamic)

EZK.Configuration
Custom configuration settings object

EZK.Configuration.SetValue (varname, value) - Sets the variable name varname as having the corresponding value.
EZK.Configuration.GetValue (varname) - String - Returns the value of a previous 'SetValue' of this varname

EZK.Cookies
KML Server side cookies implementation

EZK.Cookies.SetCookie(varname, value) - Sets the variable name varname as having the corresponding value.
EZK.Cookies.GetCookie(varname) - String - Returns the value of a previous 'SetValue' of this varname
EZK.Cookies.ClearCookie(varname)- Sets the variable name varname as having the corresponding value.

EZK.CreateEncoder
Custom settings for Video Re-encoding on the fly - TBD

EZK.CreateImage ([width], [height])
Server side image handling object with optional width and height

BackColor - RGB 32-Bit color for background
ClearAll - Clears the image and resets with specified backcolor
DrawCircle (x,y,radius,Color,[aspect]) - Draws a circle using (x,y) as center.
DrawDesktop (x1,y1,[width],[height]) - Draws the user's desktop in specified coordenates. This function is disabled by default for security reasons
DrawFile (File, x,y,[width],[height]) - Draws the specified image file using specified coordenates. JPG,GIF,TGA, and other formats are accepted.
DrawFill (x1,y1,x2,y2, Color) - Draws a solid rectangle/square using specified coordenates and color
DrawImage (ImageObj as Image, x,y, [width], [height]) - Paints an image from another object
DrawLine (x1,y1,x2,y2,UseColor) - Draws a single line using specified coordenates
DrawRectangle (x1,y1,x2,y2, Color) - Draws a rectangle/square using specified coordenates and color
DrawText (text, [x] , [y]) - Draws text string in those coordenates. If no coordenates are defined, current position will be assumed.
FontBold - Boolean
ForeColor - RGB 32-Bit color for drawing color
FontItalic - Boolean
FontName - String - Example: Tahoma
FontSize - Single - Example: 10.5
FontTransparent - Boolean - If false, back of drawn text will be reverted to backcolor. If true, text will be overdrawn without clearing contents.
FontUnderline - Boolean
Image - Internal Image object for advanced functions (ex: DrawImage)
PaintFileImage (file, [x] , [y], [xl], [yl]) - Draws the file frame in those coordenates. You can use AVI, MPG, WMV, JPG, and any other file to create a thumbnail of it's contents.
SaveToBMP (file) - Boolean - Saves the image to a BMP file
SaveToGIF (file, [MaskColor], [Method], [UsaAlphas]) - Boolean - Saves the image to a GIF file using specified settings.
SaveToJPG (file, [Quality]) - Boolean - Saves the image to a JPG file
SetCoords (x, y)
Width - Long - Image width
Height - Long - Image height

EZK.CreateUrl
Creates an URL object

url - Property - The fully formated url path (http://server:port/path/file.ext?parm1=1&parm2=2
HRef - Function - Returns URL in XML UTF-8 formated encoding so you don't have to worry about replacing & with &
URLPath - Property - ex: /Path
Path - Local file path
PCLinkURL - Function - TBD
LocalFile - Property. Local path of file ex: C:\MyFiles\Path\file.ext
SourceID - Function - TBD
Server - Server address... Example: www.myserver.com
Serverport - Server's port. 80 by default
Params - Collection of parameters.
ReadData - Reads the selected url. Works with http, https, ftp, and other protocols.

EZK.Database
EzLink NG database functions and objects

ActiveConnection - active ADODB.Connection object of "ezlinkng.mdb"
DBVersion - TBD
ExecuteSQL - Executes a sql query to the connection. returns True/False
GetRecords(Query, [ReadOnly] as boolean) - Executes the specified query and returns the recordset to be changed if readonly is false.
SetTag(TagName, TagValue) - Custom tag entries
GetTag(TagName) - Custom tag entries

EZK.FileInfo
FileInformation Objects

AudioFile(Localfile as string) - Returns AUDIO information object of specified file (*)
PictureFile(Localfile as string) - Returns PICTURE information object of specified file (*)
VideoFile(Localfile as string) - Returns VIDEO information object of specified file (*)

EZK.Filters - TBD
Documentation to be made available

EZK.KMLObjects
Many KML objects to simplify coding

StdKMLButton - Enables you to quickly add a KML menuitem button
Background - BACKGROUND KML object - Draws a gradient / jpg image in background layer
Rect - RECT KML Object - Draws a rectangular shape in foreground layer
PlayMedia - PLAYMEDIA KML Object - Plays media file (ex: mp3)
OnMetadata - ONMETADATA KML Event - Raised when media is being played
MenuItem - MENUITEM KML Object - Enables navigation events
LoadImage - LOADIMAGE KML object - Pre-loads a gif image to be used in image object
Line - LINE KML Object - Draws a line in foreground layer
Key - KEY KML Object - Assign events to remote key
Fip - FIP KML Object - Enables a marquee text to be shown in player front display
FillRect - FILLRECT KML Object - Same as rect, but fills the rectangular with specified pen color
DrawImage - DRAWIMAGE KML Object - Draws a kml palletted gif in foreground layer
Text - TEXT KML Object - Draws text in foreground layer

EZK.Net - World EzLink Network functions (WEN)
Documentation to be made available

EZK.OpenFile ([localfile])
Opens a file in disk or network.

URL - The respective EZK Url object for the file
Path - String containing local file path/folder/unc
Filename - String with just the name of the file (no directory path)
FileDate ([dateformat]) - The file date. If date format is specified result is string in that format (ex: "yyyy-MM-dd hh:mm")
FileSize () - 64 bit file size (up to 16 Hexabytes - 18.446.744.073.709.551.616 bytes)
FileIndex - Function - If file is listed in database, reports index (ID) of the respective record (long)
Extension - File Extension. Ex: avi, mpg, mpeg, jpeg, jpg, mp3, etc...
LocalFile - String with local file name and path
AppendData (data) - Adds specified data to the file specified in local file. Security measures may apply avoiding writing to non-allowed extensions.
ReadData () - Returns a string with the contents of the file. Limited to 128k by default
WriteData (data) - Writes data to the file. All contents will be cleared. Security measures may apply avoiding writing to non-allowed extensions.

EZK.Playlist
Manages a file playist file (pls,m3u,wpl, etc)

AddURLtoPlS (plsfile as string, url as string) - Function - Quickly appends a url to a pls file. Security measures apply.
ReadPLS (localfile or href as string) - EZKPLS playlist object handler
ReadM3U (localfile or href as string) - EZKM3U playlist object handler
ReadWPL (localfile or href as string) - EZKWPL playlist object handler

EZK.Structure - Contains EzLink NG structured filters, folders, sources, etc
Documentation to be made available

EZK.Server - Contains EzLink NG server information, IP's, post data, url parameters, etc
Documentation to be made available

EZK.Service - Contains EzLink NG service information
Documentation to be made available

Updated March 16th/2005