Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Player

High level API over native SDK

Hierarchy

  • EventTarget
    • Player

Implements

  • EventTarget

Index

Events

Accessors

Methods

Events

Static Readonly FRAME_PROCESSED_EVENT

FRAME_PROCESSED_EVENT: "frameprocessed" = "frameprocessed"

Static Readonly FRAME_RECEIVED_EVENT

FRAME_RECEIVED_EVENT: "framereceived" = "framereceived"

Static Readonly FRAME_RENDERED_EVENT

FRAME_RENDERED_EVENT: "framerendered" = "framerendered"

Accessors

isPlaying

  • get isPlaying(): boolean

  • Returns boolean

Methods

addEventListener

  • addEventListener(event: "framereceived", listener: (e: CustomEvent<void>) => any): void
  • addEventListener(event: "frameprocessed", listener: (e: CustomEvent<{ averagedDuration: number; instantDuration: number }>) => any): void
  • addEventListener(event: "framerendered", listener: (e: CustomEvent<void>) => any): void
  • addEventListener(...args: [type: string, listener: null | EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions]): void

  • Parameters

    • event: "framereceived"
    • listener: (e: CustomEvent<void>) => any
        • (e: CustomEvent<void>): any

        • Parameters

          • e: CustomEvent<void>

          Returns any

    Returns void

  • Parameters

    • event: "frameprocessed"
    • listener: (e: CustomEvent<{ averagedDuration: number; instantDuration: number }>) => any
        • (e: CustomEvent<{ averagedDuration: number; instantDuration: number }>): any

        • Parameters

          • e: CustomEvent<{ averagedDuration: number; instantDuration: number }>

          Returns any

    Returns void

  • Parameters

    • event: "framerendered"
    • listener: (e: CustomEvent<void>) => any
        • (e: CustomEvent<void>): any

        • Parameters

          • e: CustomEvent<void>

          Returns any

    Returns void

  • Parameters

    • Rest ...args: [type: string, listener: null | EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions]

    Returns void

applyEffect

  • applyEffect(effect: Effect): Promise<void>

  • Applies an effect to input

    example
    const octopus = new Effect("effects/octopus.zip")

player.applyEffect(octopus)

    Parameters

    Returns Promise<void>

callJsMethod

  • callJsMethod(methodName: string, methodJSONParams?: string): void

  • Evaluates JavaScript in context of applied effect

    Parameters

    • methodName: string
    • methodJSONParams: string = ""

    Returns void

clearEffect

  • clearEffect(): void

  • Clears effect applied to input

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

pause

  • pause(): void

  • Stops input processing

    Returns void

play

  • play(): Promise<void>

  • Starts input processing

    Returns Promise<void>

removeEventListener

  • removeEventListener(event: "framereceived", listener: (e: CustomEvent<void>) => any): void
  • removeEventListener(event: "frameprocessed", listener: (e: CustomEvent<{ averagedDuration: number; instantDuration: number }>) => any): void
  • removeEventListener(event: "framerendered", listener: (e: CustomEvent<void>) => any): void
  • removeEventListener(...args: [type: string, callback: null | EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions]): void

  • Parameters

    • event: "framereceived"
    • listener: (e: CustomEvent<void>) => any
        • (e: CustomEvent<void>): any

        • Parameters

          • e: CustomEvent<void>

          Returns any

    Returns void

  • Parameters

    • event: "frameprocessed"
    • listener: (e: CustomEvent<{ averagedDuration: number; instantDuration: number }>) => any
        • (e: CustomEvent<{ averagedDuration: number; instantDuration: number }>): any

        • Parameters

          • e: CustomEvent<{ averagedDuration: number; instantDuration: number }>

          Returns any

    Returns void

  • Parameters

    • event: "framerendered"
    • listener: (e: CustomEvent<void>) => any
        • (e: CustomEvent<void>): any

        • Parameters

          • e: CustomEvent<void>

          Returns any

    Returns void

  • Parameters

    • Rest ...args: [type: string, callback: null | EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions]

    Returns void

setVolume

  • setVolume(level: number): void

  • Sets effect volume from 0 to 1

    Parameters

    • level: number

    Returns void

use

  • Uses the input as frames source

    example
    player.use(new Webcam())

    Parameters

    Returns void

Static create

Static setDefaultOptions

  • setDefaultOptions(options: Pick<Partial<SDKOptions>, "clientToken" | "locateFile" | "devicePixelRatio" | "faceSearchingMode" | "cameraOrientation" | "maxFaces">): void

  • Globally sets Player defaultPlayerOptions for reusability. Helpful if it's needed to create more the one player, e.g

    example
    const player1 = await Player.create({ clientToken: "xxx-xxx-xxx" })
const player2 = await Player.create({ clientToken: "xxx-xxx-xxx" })

// vs

Player.setDefaultOptions({ clientToken: "xxx-xxx-xxx" })

const player3 = await Player.create()
const player4 = await Player.create()

    Parameters

    • options: Pick<Partial<SDKOptions>, "clientToken" | "locateFile" | "devicePixelRatio" | "faceSearchingMode" | "cameraOrientation" | "maxFaces">

    Returns void