VoiceRecorder element

WARNING: recording audio samples requires access to the recording device of your participants. For security concerns, as of June 27, 2018, Chrome (and Chromium) only granted access to the recording device if the script is run from a secured domain. As of June 27, 2018, the domain on which Ibex Farm was hosted did not have the credentials to identify itself as secured. As of June 27, 2018, Firefox still allowed scripts run from domains not identified as secured to access recording devices.

VoiceRecorder elements let you collect audio samples after requesting access to a recording device.

Creation:

newVoiceRecorder("recorder")

If print is called, this will add two <buttons> to the page: the button to the left starts/stops recording and the button to the right starts/stops playback.

In order to collect voice recordings, you need to

  1. upload a PHP file on a server where you can store an archive of the audio recording files. See the page How to collect audio recordings on a server for instructions.
  2. initiate the recorder before creating a voiceRecorder element, by adding to the items variable a PennController instance that will call PennController.InitiateRecorder with the URL of your PHP file, e.g.

PennController.InitiateRecorder("http://myserver/saveVoiceRecordings.php");

PennController(
    newVoiceRecorder("recorder")
        .print()
    ,
    newButton("send", "Click here to send your recording.")
        .print()
        .wait()
);

Actions

voicerecorder.play

getVoiceRecorder(id).play()

Starts playing the last recording (if any).

Example:

PennController.InitiateRecorder("https://myserver/upload.php");

PennController(
    newVoiceRecorder("recorder")
        .record()
    ,
    newTimer("recording", 2000)
        .start()
        .wait()
    ,
    getVoiceRecorder("recorder")
        .stop()
        .play()
        .wait("playback")
);

Will record audio for 2s and then play it back.

voicerecorder.record

getVoiceRecorder(id).record()

Starts recording audio.

Example:

PennController.InitiateRecorder("https://myserver/upload.php");

PennController(
    newVoiceRecorder("recorder")
        .record()
    ,
    newTimer("recording", 2000)
        .start()
        .wait()
    ,
    getVoiceRecorder("recorder")
        .stop()
        .play()
        .wait("playback")
);

Will record audio for 2s and then play it back.

voicerecorder.stop

getVoiceRecorder(id).stop()

Stop recording audio / playing last recording.

Example:

PennController.InitiateRecorder("https://myserver/upload.php");

PennController(
    newVoiceRecorder("recorder")
        .record()
    ,
    newTimer("recording", 3000)
        .start()
        .wait()
    ,
    getVoiceRecorder("recorder")
        .stop()
        .play()
    ,
    newTimer("preview", 1000)
        .start()
        .wait()
    ,
    getVoiceRecorder("recorder")
        .stop()
);

Will start recording audio and stop recording after 2s, then play back the first second of the recording and stop the playback.

voicerecorder.wait

getVoiceRecorder(id).wait()

or getVoiceRecorder(id).wait("first")

or getVoiceRecorder(id).wait("playback") (since PennController 1.1)

Waits for the current (or next) recording to be over.

If you pass “first” and a recording had already been done by the time this command get evaluated and executed, the commands that come next are immediately evaluated and executed. Otherwise, it waits until a recording is over before evaluating and executing the next commands.

If you pass “playback”, the commands that come next will only be evaluated and executed next time a recording has finished playing back via a click on the triangle-play button.

You can also pass a test command, in which case the next commands will be evaluated and executed upon completion of a recording while the condition of the test is satisfied. It it is not satisfied, then it will be checked again next time a recording is over.

Example:

PennController.InitiateRecorder("https://myserver/upload.php");

PennController(
    newVoiceRecorder("recorder")
        .settings.once()
        .print()
        .wait()
        .play()
        .wait("playback")
)

Adds a recording and a playback button to the page, and when the recording button is clicked for the second time (i.e., recording is over) the audio automatically plays back.

standard.print

getElement(id).print()

or getElement(id).print(x,y) (since PennController 1.3, limited)

or getElement(id).print(x,y,canvas) (since PennController 1.3, limited)

Adds the content of the element to the screen. This has no effect for non-visual elements such as the purely interactive Selector elements.

Since PennController 1.3, you can pass x and y values to print the element at a specific position on the page, or on a Canvas element if you pass one (or the name of a Canvas element) as the third parameter. You can use any CSS coordinate format for x and y, or special string values following the respective formats "left|center|right at ..." and "top|middle|bottom at ...". Note that x and y are not supported for Audio, Canvas, Scale, TextInput, Video and Youtube elements in PennController 1.3 ; note also that elements added with .settings.before and .settings.after mess with proportional coordinates.

standard.refresh

getElement(id).refresh() (since PennController 1.1)

Calls the command print again on the element, while leaving it where it was printed last.

This command is primarily useful if some aesthetic command does not take effect unless print is called afterward, but you do not want to call print because calling it when you need the aesthetic command to take effect would move the element undesirably.

NOTE: PennController 1.1 handles this command incorrectly and it bugs systematically (draft)

Example:

newImage( "smiley" , "ya.png" )
,
newCanvas( "myCanvas" , 100 , 100 )
    .settings.css( "border" , "solid 1px black" )
    .settings.center()
    .settings.add( "center at 50%" , "center at 50%" , getImage("smiley") )
    .print()
,
newButton( "resize" , "Resize the image" )
    .print()
    .wait()
,
getImage( "smiley" )
    .settings.size( 64, 64 )
,
getCanvas("myCanvas")
    .refresh()

Prints the smiley image at the center of the canvas and adds a button below the canvas. After the button is clicked, the smiley is resized to 64×64 and without refresh the smiley would no longer be centrally aligned on canvas. Calling print on the canvas would recenter the image correctly, but it would move the canvas below the button. The solution is therefore to call refresh (or to call the settings command add again on the canvas).

standard.remove

getElement(id).remove()

Removes the element from the screen. This has no effect for non-visual elements such as the purely interactive Selector elements.

Note that this leaves no space where the element previously was on the page (this is really removing the element, not just hiding it).

Example

newButton("clickme", "Click me")
    .print()
    .wait()
    .remove()

Adds a button that says Click me to the screen, and removes it after it is clicked.

standard.setVar

getElement(id).setVar( varName ) (since beta 0.3)

Stores the current value of the element in the Var element named varName (if it exists).

What the current value corresponds to is specific to each element type:

  • For Audio elements, it corresponds to the timestamp of the end of the last playback so far (0 if never played back or playback never eneded).
  • For Button elements, it corresponds to the timestamp of the last click so far (0 if never clicked).
  • For Canvas elements, it corresponds to the number of elements it currently contains.
  • For Function elements, it corresponds to the value returned by the function.
  • For Html elements, it corresponds to whether the element is completely filled.
  • For Image elements, it corresponds to whether the image is currently being displayed.
  • For Key elements, it corresponds to the last key that was pressed so far (empty string if no key has been pressed so far).
  • For Scale elements, it corresponds to the value of the last option that was selected (NaN if no option has been selected so far).
  • For Selector elements, it corresponds to the last element that was selected (null if no element has been selected so far).
  • For Text elements, it corresponds to the current text.
  • For TextInput elements, it corresponds to the text that is currently in the input box.
  • For Timer elements, it corresponds to whether the timer has elapsed.
  • For Tooltip elements, it corresponds to whether the tooltip has been validated.
  • For Var elements, it corresponds to the element’s value.
  • For Video elements, it corresponds to the timestamp of the end of the last playback so far (0 if never played back or playback never eneded).
  • For VoiceRecorder elements, it corresponds to the last recording (undefined if no recording so far).
  • For Youtube elements, it corresponds to whether the video has been played.

Example:

newVar("name")
,
newTextInput("nameInput", "What is your name?")
    .settings.once()
    .print()
    .wait()
    .setVar("name")
,
newText("helloname")
    .settings.before( newText("hello", "Hello ") )
    .settings.text( getVar("name") )
    .print()

Creates a Var element named name and adds a text box in which to enter a name. When the return/enter key is pressed while editing the input box, it disables the box and stores its value in the Var element named name. Then it prints a text reading Hello name, where name corresponds to the value of the Var element.

Settings

voicerecorder.settings.log

getVoiceRecorder(id).settings.log()

Will add a line whenever a recording starts and whenever it stops.

Note that a line with the filename of the recorded sample is always logged anyway even if you do not call .settings.log(), so you can identify it in the output archive.

newVoiceRecorder("recorder")
    .settings.log()
    .print()
    .wait()

Adds a recording and a playback button to the page and wait for a sample to be recorded. The filename will contain the timestamps of when the recording button was clicked: one line for the first click (start recording) and one for the second click (stop recording).

voicerecorder.settings.once

getVoiceRecorder(id).settings.once()

Disables the button to record after the first recording. You can still record using the action command record.

Example:

PennController.InitiateRecorder("https://myserver/upload.php");

PennController(
    newVoiceRecorder("recorder")
        .settings.once()
        .print()
        .wait()
        .play()
        .wait("playback")
);

Adds a recording and a playback button to the page, and when the recording button is clicked for the second time (i.e., recording is over) the buttons become disabled and the audio automatically plays back.

standard.settings.after

getElement(id).settings.after( getElement(id) )

Adds some content to the right of the element.

Example:

newImage("bad", "no.png")
,
newImage("good", "ya.png")
,
newText("left label", "Bad")
    .settings.before( getImage("bad") )
,
newText("right label", "Good")
    .settings.after( getImage("good") )
,
newScale("judgment", 5)
    .settings.before( getText("left label") )
    .settings.after( getText("right label") )
    .print()
    .wait()

Creates two image and two text elements and prints a 5-point radio-button scale, with the text Bad preceded by the image no.png on its left, and the text Good followed by the image ya.png on its right.

standard.settings.before

or getElement(id).settings.before( getElement(id) )

Adds some content to the left of the element.

Example:

newImage("bad", "no.png")
,
newImage("good", "ya.png")
,
newText("left label", "Bad")
    .settings.before( getImage("bad") )
,
newText("right label", "Good")
    .settings.after( getImage("good") )
,
newScale("judgment", 5)
    .settings.before( getText("left label") )
    .settings.after( getText("right label") )
    .print()
    .wait()

Creates two image and two text elements and prints a 5-point radio-button scale, with the text Bad preceded by the image no.png on its left, and the text Good followed by the image ya.png on its right.

standard.settings.center

getElement(id).settings.center()

Makes the element appear centered on the horizontal axis.

Example:

newText("helloworld", "Hello world")
    .settings.center()
    .print()

Prints Hello world onto the screen, horizontally centered.

standard.settings.css

getElement(id).settings.css("styleName", "style")

or getElement(id).settings.css({"style name 1": "style 1", "style name 2": "style 2"})

Applies the CSS style(s) to the element.

Example:

newText("frame", "framed")
    .settings.css("border", "solid 1px black")
,
newText("sentence", "The last word of this sentence is ")
    .settings.after( getText("frame") )
    .print()

Prints a text reading The last word of this sentence is framed, with the last word (framed) framed in a box with 1px black borders.

standard.settings.disable

getElement(id).settings.disable()

Disables any interactive feature of the element.

Note: this does not prevent an element that is part of a Selector element from being selected.

Example:

newAudio("sentence", "test.mp3")
    .print()
    .wait()
,
getAudio("sentence")
    .settings.disable()

Prints buttons to play/pause the audio file test_sentence.ogg, and disables those buttons when the file has played through.

standard.settings.enable

getElement(id).settings.enable()

Enables any interactive feature of the element that was previously disabled.

Example:

newAudio("sentence", "test.mp3")
    .settings.once()
    .print()
,
newKey("secret key", "R")
    .wait()
,
getAudio("sentence")
    .settings.enable()

Prints buttons to play/pause the audio file test_sentence.ogg, and disables those buttons when the file has played through (see audio.settings.once).

standard.settings.hidden

getElement(id).settings.hidden() (since beta 0.3)

Makes the element invisible. Note that when printed, a hidden element still occupies space on the page, but its content is not visible.

Example:

newText("instruction", "Guess what fruit is in the image below")
    .print()
,
newImage("fruit", "pear.png")
    .settings.hidden()
    .print()
,
newButton("reveal", "Reveal fruit")
    .print()
    .wait()
,
getImage("fruit")
    .settings.visible()

Adds some text to the page, a blank space below it and a button below the blank space which, when clicked, reveals an image of a pear.

standard.settings.left

getElement(id).settings.left()

Makes the element appear horizontally aligned to the left (default).

Note: the left means the left of the container of the element, not necessarily the left of the screen.

Example:

newText("helloworld", "Hello world")
    .settings.right()
    .print()
,
newButton("left", "Align text to the left")
    .print()
    .wait()
,
getText("helloworld")
    .settings.left()

Prints Hello world onto the screen, horizontally aligned to the left.

standard.settings.right

getElement(id).settings.right()

Makes the element appear horizontally aligned to the right.

Note: the right means the right of the container of the element, not necessarily the right of the screen.

Example:

newText("sentence", "This is a longer sentence")
    .print()
,
newText("helloworld", "Hello world")
    .settings.right()
    .print()

Prints Hello world onto the screen, horizontally aligned to the right.

standard.settings.selector

getElement(id).settings.selector( selectorName )

or getElement(id).settings.selector( getSelector(selectorName) ) (since beta 0.3)

Since beta 0.3, Selector adds a .settings.selector command to all elements as another method for adding them to a selector.

Example:

newSelector("shapes")
,
newImage("square", "square.png")
    .settings.selector("shapes")
,
newImage("triangle", "triangle.png")
    .settings.selector("shapes")
,
newCanvas("shapes canvas", 825, 400)
    .settings.add(  0, 0, getImage("square") )
    .settings.add(425, 0, getImage("triangle") )
    .print()
,
getSelector("shapes")
    .wait()

Adds two images side by side and waits for a click on either one of them.

standard.settings.size

getElement(id).settings.size(width, height)

Resizes the element to a width of width pixels and a height of height pixels.

Example:

newImage("smiley", "pear.png")
    .settings.size(40, 40)
    .print()

Adds a 40x40px image pear.png onto the screen.

standard.settings.visible

getElement(id).settings.visible() (since beta 0.3)

Makes the element visible (again). This is useful if you previously hid the element with .settings.hidden.

Example:

newText("instruction", "Guess what fruit is in the image below")
    .print()
,
newImage("fruit", "pear.png")
    .settings.hidden()
    .print()
,
newButton("reveal", "Reveal fruit")
    .print()
    .wait()
,
getImage("fruit")
    .settings.visible()

Adds some text to the page, a blank space below it and a button below the blank space which, when clicked, reveals an image of a pear.

Tests

voicerecorder.test.hasPlayed

getVoiceRecorder(id).test.hasPlayed() (since beta 0.3)

Tests whether the recording was ever played back.

voicerecorder.test.playing

getVoiceRecorder(id).test.playing() (since beta 0.3)

Tests whether the recording is currently being played back.

voicerecorder.test.recorded

getVoiceRecorder(id).test.playing() (since beta 0.3)

Tests whether a recording was completed.

standard.test.printed

getElement(id).test.printed() (since beta 0.3)

Tests whether the element was printed onto the page (and has not been removed since then).

Example:

newText("instructions", "Click on Top/Bottom to NOT print its word")
    .print()
,
newButton("top", "Top")
    .settings.callback( getButton("top").remove() ) 
    .print()
,
newButton("bottom", "Bottom")
    .settings.callback( getButton("bottom").remove() )
    .print()
,
newButton("print", "Print the buttons' words")
    .print()
    .wait()
    .remove()
,
getButton("top")
    .test.printed()
    .success( newText("top word", "hello").print() )
,
getButton("bottom")
    .test.printed()
    .success( newText("bottom word", "world").print() )

Prints a Top and a Bottom button onto the page, which disappear when clicked. After a click on the print button, the word hello will appear if the top button is still displayed, and the word world will appear if the bottom button is still displayed.