Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "utils/framerate"

Index

Type aliases

Functions

Type aliases

FramerateObj

FramerateObj: { framerate?: number }

Type declaration

  • Optional framerate?: number

FramerateProjection

FramerateProjection: (manifest?: string) => number | undefined

Type declaration

    • (manifest?: string): number | undefined

    • Parameters

      • Optional manifest: string

      Returns number | undefined

Functions

Const FramerateProjectionDash

  • FramerateProjectionDash(manifest?: string): number | undefined

  • Parses an MPEG-Dash manifest for frameRate properties on AdaptionSet, Representation, and SubRepresentation tags and provides the highest numeric value associated to those properties.

    Parameters

    • Optional manifest: string

      MPEG-Dash manifest

    Returns number | undefined

    Number representing the highest framerate in MPEG-Dash manifest, or undefined

Const FramerateProjectionDefault

  • FramerateProjectionDefault(manifest?: string): number | undefined

  • Parameters

    • Optional manifest: string

    Returns number | undefined

Const FramerateProjectionHLS

  • FramerateProjectionHLS(manifest?: string): number | undefined

  • Parses an HLS manifest for instances of the FRAME-RATE property and provides the highest numeric value associated to those properties.

    Parameters

    • Optional manifest: string

      HLS manifest

    Returns number | undefined

    Number representing the highest framerate in HLS manifest, or undefined

Const framerateDesc

  • framerateDesc(__namedParameters: { a: number }, __namedParameters: { b: number }): number

  • Parameters

    • __namedParameters: { a: number }
      • a: number
    • __namedParameters: { b: number }
      • b: number

    Returns number

Const framerateNodeName

  • framerateNodeName(attr: Node): boolean

  • Takes a DOM node and checks if its nodeName is 'frameRate' (for MPEG-Dash manifests).

    Parameters

    • attr: Node

    Returns boolean

Const fromFramerateAttr

  • fromFramerateAttr(s: string): number

  • Computes the framerate from the shape of an MPEG-Dash framerate value (F or F/D). D is assumed to be 1 if not part of the value.

    Parameters

    • s: string

    Returns number

Const includesFramerate

  • includesFramerate(s: string): boolean

  • Takes a string and checks if "FRAME-RATE" exists (for HLS manifests).

    Parameters

    • s: string

    Returns boolean

Const toFramerate

  • Given a string or Element, calls the corresponding parsing function

    Parameters

    • x: string | Element

    Returns FramerateObj

    an Object with a framerate property

Const toFramerateFromElement

  • Parses an MPEG-Dash XML node for framerate values.

    Parameters

    • node: Element

      XML node from MPEG-Dash manifest

    Returns FramerateObj

    an Object with a framerate property.

Const toFramerateFromString

  • toFramerateFromString(line: string): { framerate: number }

  • Parses an HLS manifest line for framerate values.

    Parameters

    • line: string

      Line from HLS manifest

    Returns { framerate: number }

    an Object with a framerate property.

    • framerate: number

Generated using TypeDoc