Skip to main content
Version: Current

Experimental Types

  • RecordedFile​

    Defines an interface that represents a recorded file.

    Members​

    • containsAudio boolean​

      Whether the file contains the recorded audio.

    • containsScreen boolean​

      Whether the file contains the recorded screen data.

    • containsVideo boolean​

      Whether the file contains the recorded video.

    • data Blob​

      The data that the file contains.

  • Recording​

    Defines an interface that contains recorded data.

    Members​

    • files RecordedFile[]​

      The list of files that were produced when recording.

  • RecordingOptions​

    An interface that represents the options that can be used for making recordings.

    Members​

    • audio (boolean | ("screen" | "microphone")[])​

      Whether to record audio.

      If the computer does not have an audio device attached, then setting this to true will cause an error.

      If an array is specified, only the specified audio sources will be recorded.

      Defaults to true.

    • audioBitsPerSecond? number​

      The ideal number of bits per second that the audio portion of the recording should use. If omitted then a bitrake of 48kbps will be used.

      See https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/MediaRecorder#audiobitspersecond for more information.

    • bitsPerSecond? number​

      The ideal number of bits per second that the recording should use. If omitted, then the videoBitsPerSecond and audioBitsPerSecond settings will be used.

      See https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/MediaRecorder#bitspersecond for more information.

    • mimeType? string​

      The MIME type that should be produced. If supported, then the recorded file(s) will be in this format. If not supported, then the recording will fail. If not provided, then a default will be used.

      See https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Video_codecs for more information.

    • screen boolean​

      Whether to record the screen.

      Defaults to false.

    • video boolean​

      Whether to record video.

      If the computer does not have a video device attached (like a web cam), then setting this to true will cause an error.

      Defaults to true.

    • videoBitsPerSecond? number​

      The ideal number of bits per second that the video portion of the recording should use. If omitted, then a bitrate of 1mbps will be used.

      See https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/MediaRecorder#videobitspersecond for more information.

  • SpeakTextOptions​

    Defines the options for experiment.speakText(text, options).

    Members​

    • pitch? number​

      The pitch that the text should be spoken at. This can be any positive number.

    • rate? number​

      The rate that the text should be spoken at. This can be any positive number.

    • voice? (string | SyntheticVoice)​

      The voice that the text should be spoken with. This can be the voice object or the name of a voice. Note that not all browsers support the same voices.

  • SyntheticVoice​

    Defines an interface that represents a synthetic voice.

    Members​

    • default boolean​

      Whether this voice is the default synthetic voice.

    • language string​

      The language that this voice can speak.

    • name string​

      The name of the voice.

  • TweenOptions​

    Defines a set of options for a tween.

    Members​

    • duration? number​

      The duration of the tween in seconds.

    • easing? Easing​

      The easing for the tween.