Reference client is part of examples, which are small static HTML plus some JavaScript code to interface with server and build (update) HTML DOM.

deferred.js

http://engine.qik.com/examples/js/deferred.js

Deferred is a concept from Twisted Framework (http://twistedmatrix.com), it isn't required for Qik Engine interaction, but it is used in this reference client implementation making things a bit more simple.

Deferred

Deferred for Prototype.

For more information about Deferred, please visit Twisted documentation:

• http://twistedmatrix.com/projects/core/documentation/howto/defer.html
• http://twistedmatrix.com/projects/core/documentation/howto/gendefer.html
• http://twistedmatrix.com/projects/core/documentation/howto/deferredindepth.html

Other Deferred implementations in JavaScript:

• MochiKit: http://mochikit.com/doc/html/MochiKit/Async.html
• Dojo: http://www.dojotoolkit.org/book/dojo-book-0-9/part-3-programmatic-dijit-and-dojo/miscellaneous/communication-between-threads-do

DeferredManager

Simple Deferred extension: make only N Deferred running at the same time.

core.js

http://engine.qik.com/examples/js/api.js

Core Qik Engine client namespace and other definitions.

QikEngine

This namespace holds all QikEngine-specific definitions. Core module provides debugging facilities, and global instance of QikEngine.API class.

api.js

http://engine.qik.com/examples/js/api.js

QikEngine.API

Really simple JSON-RPC for Qik Engine client built around Deferred. Abstracting JSON-RPC interface and making all calls Deferred. All errors are passed via Deferred errback.

QikEngine.Session

Session class at Qik API side. Session creation/destroy, authorizing session.

events.js

http://engine.qik.com/examples/js/events.js

Event distributing and processing module (it does actual HTTP polling with timeout to get new events, BOSH/Comet-like).

QikEngine.Events

Event manager receives events for subscribers and delivers them to views.

view.js

http://engine.qik.com/examples/js/view.js

View with live updates, event processing, sorting items, adding new ones, updating old, etc. Actually, video list isn't stored in JS, it is presented only as a set of HTML nodes in DOM container.

QikEngine.View

Base class for all views.

Does all basic operations: processing events, connection to event manager, etc.

QikEngine.PublicUserStreamView

View of public user's streams.

QikEngine.PublicRecentStreamsView

View of public recent streams.

QikEngine.PublicLiveStreamsView

View of public live streams.

QikEngine.UserStreamsView

View of user's streams as seen by current authorized user.

QikEngine.OwnStreamsView

View of user's own streams (for current authorized user).

QikEngine.FollowersStreamsView

View of stream by user's followers (for current authorized user).

updater.js

http://engine.qik.com/examples/js/updater.js

Very simple DOM builder/updater, could be thrown away and rewritten for custom markup/layout.

QikEngine.Updater

Base class, provides value formatting methods and HTML DOM builders/updaters. Provide specific methods for list of streams.

usercache.js

http://engine.qik.com/examples/js/usercache.js

QikEngine.UserCache

UserCache: caching and fetching user information. DeferredManager is used to limit concurrency of user info loading.