Synchronizing HTML5 Slides with Node.js

I gave a talk in February on Advanced jQuery Templates that had an interesting and unique twist. Instead of changing slides using traditional presentation delivery methods such as a clicker or a laptop keyboard, I used my smartphone which made asynchronous calls to a Node.js server. The server then propagated events to all connected viewers, regardless of Internet connection or device.

This post provides all the code necessary to run the Node.js server, the controller on a smartphone (or any device that has a web browser) and the client-side component necessary to work with various HTML5 slide decks.

Before diving in, here is a demo of the code in action:

Dependencies

As with any new technology demonstration, there are certain dependencies needed in order to run the code successfully. The following must be installed on your server:

I recommend installing Node.js first and then installing NPM. Create a directory to contain the server code, cd into it in the terminal and install Socket.io and express with the following command npm install socket.io express. You install inside a folder, because NPM puts modules in a node_modules subfolder locally.

I am using tabdeveloper.com as my hostname and port 1987 in all my examples. You will need to change these to match your own environment.

Assembling the server

The server component runs continuously and listens for messages to be sent by the remote controller. It then propagates the message to all connected clients. Routing is handled by Express and the message propagation is executed through Socket.io. Express creates a wrapped HTTP server with createServer() and returns an app to bind Socket.io and define routes on.

The following code blocks are excerpts that can be viewed as a whole at the end of the post:

The server must maintain two variables: current slide position state and connected clients clients. The last line binds Socket.io to Express so the same port can be used.

Before defining the routes for the server to handle moving forwards and backwards, the server socket must listen for incoming connections from clients and save them for reuse. The socket has only one task: sending messages. The send function facilitates the message sending and prunes out disconnected clients. Pruning keeps the looping efficient (no unusable items) this keeps memory usage lower (assuming hundreds/thousands connecting and disconnecting at a conference).

Defining routes is very easy and intuitive. Routes are created for each action handled inside the slide deck code. The state variable is only updated inside the advance and recede routes. The default route is specified by the asterisk and will serve up the remote for a controller device.

Once all routes are defined, set the port to listen on.

Injecting the client into the slide deck

The client component resides in the existing slide deck and augments it by establishing a real-time socket which receives messages from the server and reacting. The slide deck must use hashchange for the following code to work. If the slide deck does not respond to hashchange events to change the slide, other options should be explored such as simulating keyboard events or finding the functions in the slide deck source and triggering them manually.

This file will most likely be included with the rest of the slide deck source, or embedded inline. End users should have a choice to disable remote control, so logic is implemented in the beginning to allow a button to enable and disable synchronization.

Messages sent from the server can be handled elegantly with conditional logic: If a state property is provided, then change the slide. If the cornify* function is present and the message is sent, then cornify* the user. Lastly if the refresh message is sent, then reload the page.

The remote controller

The basic markup necessary to use the actions above: (styling is required for the swipe area, visible in the full file)

The controller has several responsibilities, but the most important is getting the correct action from the presenter and sending it to the server as a message. Since the server doesn’t respond with anything particularly useful, triggering asynchronous requests can happen without needing a callback. The xhr function simply creates a new XHR object, opens a connection, and sends the request. In my markup the button values directly correspond with the server route mapping.

The swipe code isn’t covered in this post, but I chose that approach for changing slides. You can see it in the complete controller file.

Putting it all together

If this is new ground for you and you’ve made it this far, great! It’s not complicated when taken step-by-step. The remote controller sends messages to the server. The server listens for messages and dispatches them to all connected clients. Each client handles received messages and manipulates the slide deck. demo To put all this together yourself, you may want to look at the full source of each file:

I have included the client component like this in my own slides:

  • I use the terms cornify and cornification throughout the article to refer to an Internet gag that is popular throughout the client-side development community. Cornify when triggered will add unicorn images and distort the page.

This entry was posted by Tim Branyen (@tbranyen) on June 23, 2011 in HTML5, Node.js and Feature.

Comments

Author

This entry was posted by Tim Branyen (@tbranyen) on June 23, 2011 in HTML5, Node.js and Feature.

Recent from this Author

Related Posts