yeah.js yeah.js

  • API Docs for Version: 1.0.0

    • APIs

    Show:

    Yeah Class

    Defined in: lib/yeah.js:129

    A library to convert video to its excitement score.

    Methods

    calcAdjustedSensitivity

    (
    • cornerCnt
    • options
    )
    Number

    Defined in lib/yeah.js:522

    Calculate adjusted sensitivity with found corner size

    Parameters:

    • cornerCnt Number

      Found corner size

    • options Object

      Options of Yeah class

    Returns:

    Number:

    Calculated sensitivity

    calcYeah

    (
    • currentMatchRate
    • tsDataList
    )
    Number

    Defined in lib/yeah.js:433

    Calculate yeah score from time series data set

    Parameters:

    • currentMatchRate Number

      Current match rate score

    • tsDataList Array

      List of corner detection and yeah score history data

    Returns:

    Number:

    Yeah score

    clearLastCaptureInfo

    ()

    Defined in lib/yeah.js:461

    Clear last capture info

    createCanvas

    ()

    Defined in lib/yeah.js:163

    Create canvas

    delayTimer

    (
    • delay
    )
    Object private

    Defined in lib/yeah.js:58

    Promise to make delay

    Parameters:

    • delay Number

      Delay time for resolve timer (ms)

    Returns:

    Object:

    Promise object to make delay like setTimeout

    fillTrackedPointsOnCanvas

    (
    • canvasContext
    • trackedData
    • scaleInverted
    • options
    )
    private

    Defined in lib/yeah.js:91

    Fill marker on tracked corners and matched points

    Parameters:

    • canvasContext Object

      Canvas element

    • trackedData Object

      Tracked data points

    • scaleInverted Number

      Inverted scale

    • options Object

      Options of Yeah class

    findFeatures

    () Object

    Defined in lib/yeah.js:472

    Find features from captured image on canvas

    Returns:

    Object:

    Promise object to find features

    getCaptureInterval

    () Number

    Defined in lib/yeah.js:235

    Get capture interval

    Returns:

    Number:

    Capture interval

    getMarkerSize

    () Number

    Defined in lib/yeah.js:318

    Get marker size

    Returns:

    Number:

    Marker size

    getOptions

    () Object

    Defined in lib/yeah.js:201

    Get options

    Returns:

    Object:

    Options set to Yeah class

    getSensitivity

    () Number

    Defined in lib/yeah.js:255

    Get sensitivity

    Returns:

    Number:

    Sensitivity

    isAutoAdjustSensitivity

    () Boolean

    Defined in lib/yeah.js:298

    Get flag for auto sensitivity adjustment

    Returns:

    Boolean:

    Flag for auto sensitivity adjustment

    isShowCapturePanel

    () Boolean

    Defined in lib/yeah.js:277

    Get flag for showing capture panel

    Returns:

    Boolean:

    Flag for show capture panel

    isVideoPaused

    (
    • videoElm
    )
    Boolean private

    Defined in lib/yeah.js:45

    Get flag for video playing status http://www.w3schools.com/TagS/ref_av_dom.asp

    Parameters:

    • videoElm Object

      Video element

    Returns:

    Boolean:

    Flag for video playing status (stop: true, playing: false)

    pEmit

    (
    • func
    )
    Object private

    Defined in lib/yeah.js:72

    Promise to wrap processing

    Parameters:

    • func Function

      Function to be wrapped by Promise

    Returns:

    Object:

    Promise object for some processing

    playVideo

    (
    • src
    • delay
    )
    Object

    Defined in lib/yeah.js:338

    play video and initialize canvas

    Parameters:

    • src String

      Video src

    • delay Number

      Delay for copying height and width from video element

    Returns:

    Object:

    Promise object

    setCaptureInterval

    (
    • captureInterval
    )

    Defined in lib/yeah.js:245

    Set capture interval

    Parameters:

    • captureInterval Number

      Capture interval to be set

    setCustomYeahCalculator

    (
    • func
    )

    Defined in lib/yeah.js:423

    Set custom yeah calculator

    Parameters:

    • func Function

      Customized yeah calculator

    setIsAutoAdjustSensitivity

    (
    • bool
    )

    Defined in lib/yeah.js:308

    Set flag for auto sensitivity adjustment

    Parameters:

    • bool Boolean

      Flag to be set

    setIsShowCapturePanel

    (
    • bool
    )

    Defined in lib/yeah.js:287

    Set flag for showing capture panel

    Parameters:

    • bool Boolean

      Flag to be set

    setMarkerSize

    (
    • markerSize
    )

    Defined in lib/yeah.js:328

    Set marker size

    Parameters:

    • markerSize Number

      Marker size to be set

    SetOptions

    (
    • options
    )

    Defined in lib/yeah.js:177

    Set options

    Parameters:

    • options Object

      Options to be set

    setSensitivity

    (
    • sensitivity
    )

    Defined in lib/yeah.js:265

    Update sensitivity

    Parameters:

    • sensitivity Number

      Sensitivity to be set

    setVideoElement

    (
    • videoElm
    )

    Defined in lib/yeah.js:211

    Set video element

    Parameters:

    • videoElm Object

      A video element as a capture target

    setVideoSrc

    (
    • src
    )

    Defined in lib/yeah.js:224

    Set video src

    Parameters:

    • src String

      Video source url

    startCaptureVideo

    (
    • successCallback
    • failureCallback
    )

    Defined in lib/yeah.js:377

    Start capturing video element to canvas

    Parameters:

    • successCallback Function

      Callback after getting capture data

    • failureCallback Function

      Callback for getting error for each capture loop

    stopCaptureVideo

    ()

    Defined in lib/yeah.js:366

    Stop capturing video element