Class: InterleavedVideoFrame

AviSynth. InterleavedVideoFrame

new InterleavedVideoFrame()

This class provides direct access to video frame data that is in an interleaved format.
Source:
See:

Extends

Members

<readonly> bitPerPixel :number

The number of bits in a single pixel.
Type:
  • number
Inherited From:
Source:

<readonly> bytesPerPixel :number

The number of bytes in a single pixel.
Type:
  • number
Inherited From:
Source:

<readonly> data :ArrayBuffer

The data buffer. You'll want to wrap this with one of the more specific typed-array views.
Type:
  • ArrayBuffer
Inherited From:
Source:

<readonly> height :number

The height of the frame in pixels. In the case of planar data, this may not be what you're expecting due to chroma subsampling!
Type:
  • number
Inherited From:
Source:

<readonly> interleaved :boolean

Indicates whether the frame data is interleaved (RGB, YUY2).
Type:
  • boolean
Inherited From:
Source:

<readonly> pitch :number

The pitch: the number of bytes between the start of one row and the start of the next.
Type:
  • number
Inherited From:
Source:

<readonly> planar :boolean

Indicates whether the frame data is planar (YV12).
Type:
  • boolean
Inherited From:
Source:

<readonly> rowSize :number

The row size: the number of bytes after the start of the row that are actually visible in the final frame.
Type:
  • number
Inherited From:
Source:

width

The width of the frame in pixels. In the case of planar data, this may not be what you're expecting due to chroma subsampling!
Inherited From:
Source:

Methods

getContext(type) → {AviSynth.RenderingContext}

Gets a rendering context, allowing you to draw directly onto the frame.
Parameters:
Name Type Description
type string the type of rendering context, currently this must be the string "simple" indicating that a AviSynth.SimpleRenderingContext should be returned. "2d" to get an HTML5 canvas style context is planned, "webgl" would sure be cool but don't count on it.
Inherited From:
Source:
Returns:
a rendering context to render on the frame, or null if the requested context is not available
Type
AviSynth.RenderingContext

release()

Release the frame, indicating that the frame data is no longer useful. This will allow AviSynth to "reclaim" the frame.
Inherited From:
Source: