Recorder class

addEventListener(type:String, listener:Function)

Registers a method as an event listener for a specific event.

getImgData():String

Returns a base-64-encoded string of PNG data representing the Recorder video. Returns an empty string if there is no video.

You can use the string as the value for a data URL scheme passed to the src parameter of an image file, as in the following:

var imgData = recorder.getImgData();

var img = document.createElement("img");
img.setAttribute("src", "data:image/png;base64," + imgData);
document.body.appendChild(img); // Or append as a child of another DOM element

You can store this image data on your server so that you can later provide it to a page as a preview of an archive video.

getStyle():Object

Returns an object that has the properties that define the current user interface controls of the Recorder. You can modify the properties of this object and pass the object to the setStyle() method of the Recorder object. (See the documentation for setStyle() to see the styles that define this object.)

removeEventListener(type:String, listener:Function)

Removes an event listener for a specific event.

saveArchive()

Saves the recorded archive to the OpenTok server.

A recording is saved when the user clicks the Save button or when you call the saveArchive() method of the Recorder object.

The Recorder object dispatches a archiveSaved event when the archive is created on the OpenTok servers. This event is defined by the ArchiveEvent class. The value of the archiveId property is the unique archive ID.

Important: You will want to store the archiveID property of the archiveSaved event for future playback of the archive. For example, you may want to store this in a server-side database table.

setStyle(style:Object, [value:String]):Recorder

Sets properties that define the appearance of some user interface controls of the Recorder.

You can either pass one parameter or two parameters to this method.

If you pass one parameter, style, it is an object that has the following properties that define the style:

• buttonDisplayMode (String) — How to display the microphone controls and settings buttons. Possible values are: "auto" (buttons are displayed when the stream is first displayed and when the user mouses over the display), "off" (buttons are not displayed), and "on" (buttons are displayed). The showMicButton and showSettingsButton properties define whether each individual control is displayed.
• showControlBar (Boolean) — Whether to display the control bar. If you do not specify a value, the Recorder displays the control bar (by default). The control bar includes the following buttons: Record, Record Stop, Re-record, Play, Save, and Play Stop. (You can create your own user interface that calls methods of the Recorder object that control these actions.) You can set other properties of the style property to control the display of individual buttons.
• showMicButton (Boolean) — Whether to display the microphone controls.
• showRecordButton (Boolean) — Whether to display a Record button. If you do not specify a value, the Recorder displays the Record button (by default). (You can start a recording by calling the startRecording() method of the Recorder object.)
• showRecordCounter (Boolean) — Whether to display the recording time indicator. This parameter is optional. If you do not specify a value, the Recorder displays the recording time indicator (by default).
• showRecordStopButton (Boolean) — Whether to display a Stop Recording button. If you do not specify a value, the Recorder displays the Stop Recording button (by default). (You can stop a recording by calling the stopRecording() method of the Recorder object.)
• showReRecordButton (Boolean) — Whether to display a Re-record button. If you do not specify a value, the Recorder displays the Re-record button (by default).
• showPlayButton (Boolean) — Whether to display a Play button. If you do not specify a value, the Recorder displays the Play button (by default).
• showPlayCounter (Boolean) — Whether to display the playback preview time indicator. If you do not specify a value, the Recorder displays the playback preview time indicator (by default).
• showPlayStopButton (Boolean) — Whether to display a Stop Recording button. If you do not specify a value, the Recorder displays the Stop Playing button (by default).
• showSaveButton (Boolean) — Whether to display the Save button. (Note: in addition to using the Save button, you can save an archive by calling the saveArchive() method.)
• showSettingsButton (Boolean) — Whether to display the settings buttons.

For example, the following code passes one parameter to the method:

var newStyle = {
                   buttonDisplayMode: "auto",
                   showMicButton: true,
                   showSaveButton: true,
                   showSettingsButton: false,
               }
myRecorder.setStyle(newStyle);

If you pass two parameters, style and value, they are key-value pair that define one property of the display style. For example, the following code passes two parameter values to each call of the method:

myRecorder.setStyle("buttonDisplayMode", "auto");
myRecorder.setStyle("showSaveButton", true);

You can set the initial settings when you call the RecorderManager.displayRecorder() method. Pass a style property as part of of the properties parameter of the method.

setTitle(title:String)

Sets the title of the next archive to be recorded. Call this method before the recording starts.

An Archive object includes a title property.

You can set the title of the initial recording by setting the initialArchiveTitle property of the properties parameter of the RecorderManager.displayRecorder() method.

startPlaying()

Starts playing the archive. Calling this method has no effect if the archive has not been recorded or if the archive is currently being played back.

You can use this method in place of having the user click the Play button. You can hide the Play button by setting the showPlayButton property of the style property of the properties parameter when you call the RecorderManager.displayRecorder() method.