JavaScript video editor, encoder, and streamer - version 5.0.6

Utility

A collection of utility methods.

Color

  • fromRgb(rgb: Rgb): string
  • Parameter

    rgb: Rgb

    Returns string

  • fromRgba(rgba: Rgba): string
  • Parameter

    rgba: Rgba

    Returns string

hexRegex: RegExp
  • hexToRgb(hex: string): Rgb
  • Parameter

    hex: string

    Returns Rgb

  • hexToRgba(hex: string): Rgba
  • Parameter

    hex: string

    Returns Rgba

rgb: Rgb
rgbRegex: RegExp
rgba: Rgba
rgbaRegex: RegExp
  • strip(color: string): string
  • Parameter

    color: string

    Returns string

  • toRgb(value: string): Rgb
  • Parameter

    value: string

    Returns Rgb

  • toRgba(value: string): Rgba
  • Parameter

    value: string

    Returns Rgba

transparent: string
  • valid(color: string): boolean
  • Parameter

    color: string

    Returns boolean

  • validHex(value: string): boolean
  • Parameter

    value: string

    Returns boolean

  • validRgb(value: string): boolean
  • Parameter

    value: string

    Returns boolean

  • validRgba(value: string): boolean
  • Parameter

    value: string

    Returns boolean

Element

  • scrollMetrics(element?: null | Element): undefined | ScrollMetrics
  • Parameter

    Optional element: null | Element

    Returns undefined | ScrollMetrics

Id

  • generate(): string
  • Returns string

prefix: string
  • prefixSet(prefix: string): void
  • Parameter

    prefix: string

    Returns void

Is

  • aboveZero(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • array(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • boolean(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • defined(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • float(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • integer(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • method(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • nan(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • number(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • object(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • populatedArray(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • populatedObject(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • populatedString(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • positive(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • string(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

  • undefined(value: unknown): boolean
  • Parameter

    value: unknown

    Returns boolean

Pixel

  • color(value: Value): string
  • Parameter

    value: Value

    Returns string

  • fromFrame(frame: number, perFrame: number, rounding?: string): number
  • Parameters

    • frame: number
    • perFrame: number
    • Optional rounding: string

    Returns number

  • perFrame(frames: number, width: number, zoom: number): number
  • Parameters

    • frames: number
    • width: number
    • zoom: number

    Returns number

  • toFrame(pixels: number, perFrame: number, rounding?: string): number
  • Parameters

    • pixels: number
    • perFrame: number
    • Optional rounding: string

    Returns number

Round

  • withMethod(number: number, method?: string): number
  • Parameters

    • number: number
    • Optional method: string

    Returns number

Sort

Url

  • absolute(url: string, base?: string): string
  • Parameters

    • url: string
    • Optional base: string

    Returns string

  • forEndpoint(endpoint?: Endpoint, suffix?: string): string
  • Parameters

    • Optional endpoint: Endpoint
    • Optional suffix: string

    Returns string