Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VideoBuffer

A video buffer.

Hierarchy

  • MediaBuffer<VideoFormat, VideoBuffer>
    • VideoBuffer

Index

Constructors

Properties

Methods

Constructors

constructor

  • new VideoBuffer(): VideoBuffer
  • new VideoBuffer(width: number, height: number, dataBuffer: DataBuffer, format: VideoFormat): VideoBuffer
  • new VideoBuffer(width: number, height: number, dataBuffers: DataBuffer[], format: VideoFormat): VideoBuffer
  • Initializes a new instance of the fm.icelink.videoBuffer class.

    Returns VideoBuffer

  • Initializes a new instance of the fm.icelink.videoBuffer class.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • dataBuffer: DataBuffer

      The data buffer.

    • format: VideoFormat

      The format.

    Returns VideoBuffer

  • Initializes a new instance of the fm.icelink.videoBuffer class.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • dataBuffers: DataBuffer[]

      The data buffers.

    • format: VideoFormat

      The format.

    Returns VideoBuffer

Properties

Private __height

__height: number
internal

Private __isMuted

__isMuted: boolean
internal

Private __orientation

__orientation: number
internal

Private __width

__width: number
internal

Private _strides

_strides: number[]
internal

Methods

clone

  • clone(): VideoBuffer
  • Clones this instance.

    Returns VideoBuffer

convert

  • convert(format: VideoFormat, dataBuffer: DataBuffer): VideoBuffer
  • convert(format: VideoFormat): VideoBuffer
  • Creates a new video buffer using the specified format.

    Parameters

    • format: VideoFormat

      The format.

    • dataBuffer: DataBuffer

      The data buffer.

    Returns VideoBuffer

  • Creates a new video buffer using the specified format.

    Parameters

    • format: VideoFormat

      The format.

    Returns VideoBuffer

Protected createInstance

  • createInstance(): VideoBuffer

free

  • free(): void
  • Frees the data buffers referenced by this instance.

    Returns void

getDataBuffer

  • getDataBuffer(): DataBuffer
  • Gets the data buffer.

    Returns DataBuffer

getDataBuffers

  • getDataBuffers(): DataBuffer[]
  • Gets the data buffers.

    Returns DataBuffer[]

Private getDefaultStrides

  • getDefaultStrides(width: number, format: VideoFormat): number[]
  • internal

    Parameters

    • width: number
    • format: VideoFormat

    Returns number[]

getDynamicProperties

  • getDynamicProperties(): Hash<string, Object>
  • Gets the dynamic properties on this instance.

    Returns Hash<string, Object>

getDynamicValue

  • getDynamicValue(key: string): Object
  • Gets a property value from the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns Object

    The stored value, if found; otherwise null.

getFormat

  • getFormat(): VideoFormat
  • Gets the format.

    Returns VideoFormat

getHeight

  • getHeight(): number
  • Gets the height.

    Returns number

getIsAbgr

  • getIsAbgr(): boolean
  • Gets a value indicating whether this buffer has ABGR video.

    Returns boolean

getIsArgb

  • getIsArgb(): boolean
  • Gets a value indicating whether this buffer has ARGB video.

    Returns boolean

getIsBgr

  • getIsBgr(): boolean
  • Gets a value indicating whether this buffer has BGR video.

    Returns boolean

getIsBgra

  • getIsBgra(): boolean
  • Gets a value indicating whether this buffer has BGRA video.

    Returns boolean

getIsDirty

  • getIsDirty(): boolean
  • Gets a value indicating whether this instance is dirty.
    internal

    Returns boolean

getIsH264

  • getIsH264(): boolean
  • Gets a value indicating whether this buffer has H.264 video.

    Returns boolean

getIsI420

  • getIsI420(): boolean
  • Gets a value indicating whether this buffer has I420 video.

    Returns boolean

getIsMuted

  • getIsMuted(): boolean
  • Gets a value indicating whether this instance has been muted.

    Returns boolean

getIsNv12

  • getIsNv12(): boolean
  • Gets a value indicating whether this buffer has NV12 video.

    Returns boolean

getIsNv21

  • getIsNv21(): boolean
  • Gets a value indicating whether this buffer has NV21 video.

    Returns boolean

getIsPacketized

  • getIsPacketized(): boolean

getIsRaw

  • getIsRaw(): boolean
  • Gets a value indicating whether this buffer has raw video.

    Returns boolean

getIsRgb

  • getIsRgb(): boolean
  • Gets a value indicating whether this buffer has RGB video.

    Returns boolean

getIsRgbType

  • getIsRgbType(): boolean
  • Gets a value indicating whether this buffer has raw RGB or BGR video.

    Returns boolean

getIsRgba

  • getIsRgba(): boolean
  • Gets a value indicating whether this buffer has RGBA video.

    Returns boolean

getIsRgbaType

  • getIsRgbaType(): boolean
  • Gets a value indicating whether this buffer has raw RGBA, BGRA, ARGB, or ABGR video.

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

getIsVp8

  • getIsVp8(): boolean
  • Gets a value indicating whether this buffer has VP8 video.

    Returns boolean

getIsVp9

  • getIsVp9(): boolean
  • Gets a value indicating whether this buffer has VP9 video.

    Returns boolean

getIsYuvType

  • getIsYuvType(): boolean
  • Gets a value indicating whether this buffer has raw I420, YV12, NV12, or NV21 video.

    Returns boolean

getIsYv12

  • getIsYv12(): boolean
  • Gets a value indicating whether this buffer has YV12 video.

    Returns boolean

getLastSequenceNumber

  • getLastSequenceNumber(): number

getOrientation

  • getOrientation(): number
  • Gets the orientation.

    Returns number

getRecoveredByFec

  • getRecoveredByFec(): boolean
  • Gets a value indicating whether this buffer contains data recovered by forward error correction (FEC).

    Returns boolean

getRtpHeader

  • getRtpHeader(): RtpPacketHeader
  • Gets the Rtp Packet Header for this media buffer.

    Returns RtpPacketHeader

getRtpHeaders

  • getRtpHeaders(): RtpPacketHeader[]
  • Gets the Rtp Packet Headers for this media buffer.

    Returns RtpPacketHeader[]

getRtpSequenceNumber

  • getRtpSequenceNumber(): number

getRtpSequenceNumbers

  • getRtpSequenceNumbers(): number[]

getSequenceNumber

  • getSequenceNumber(): number

getSequenceNumbers

  • getSequenceNumbers(): number[]

getSerialized

  • getSerialized(): string

getSourceId

  • getSourceId(): string
  • Gets the source identifier.

    Returns string

getStride

  • getStride(): number
  • Gets the stride.

    Returns number

getStrides

  • getStrides(): number[]
  • Gets the strides.

    Returns number[]

getTypeString

  • getTypeString(): string

getWidth

  • getWidth(): number
  • Gets the width.

    Returns number

keep

  • keep(): void
  • Keeps the data buffers referenced by this instance.

    Returns void

mute

  • mute(): boolean
  • Mutes this instance. This is a one-way operation that clears the underlying data buffer.

    Returns boolean

Private read

  • read(rValues: Holder<number[]>, gValues: Holder<number[]>, bValues: Holder<number[]>, aValues: Holder<number[]>): void
  • internal

    Parameters

    • rValues: Holder<number[]>
    • gValues: Holder<number[]>
    • bValues: Holder<number[]>
    • aValues: Holder<number[]>

    Returns void

setDataBuffer

  • setDataBuffer(value: DataBuffer): void
  • Sets the data buffer.

    Parameters

    • value: DataBuffer

    Returns void

setDataBuffers

  • setDataBuffers(value: DataBuffer[]): void
  • Sets the data buffers.

    Parameters

    • value: DataBuffer[]

    Returns void

setDynamicProperties

  • setDynamicProperties(value: Hash<string, Object>): void
  • internal

    Parameters

    • value: Hash<string, Object>

    Returns void

setDynamicValue

  • setDynamicValue(key: string, value: Object): void
  • Sets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    • value: Object

      The property value. This can be any object that needs to be stored for future use.

    Returns void

setFormat

  • setFormat(value: VideoFormat): void
  • Sets the format.

    Parameters

    • value: VideoFormat

    Returns void

setHeight

  • setHeight(value: number): void
  • Sets the height.

    Parameters

    • value: number

    Returns void

setIsDirty

  • setIsDirty(value: boolean): void
  • Sets a value indicating whether this instance is dirty.
    internal

    Parameters

    • value: boolean

    Returns void

setIsMuted

  • setIsMuted(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setIsSerialized

  • setIsSerialized(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setOrientation

  • setOrientation(value: number): void
  • Sets the orientation.

    Parameters

    • value: number

    Returns void

setRecoveredByFec

  • setRecoveredByFec(value: boolean): void
  • Sets a value indicating whether this buffer contains data recovered by forward error correction (FEC).

    Parameters

    • value: boolean

    Returns void

setRtpHeader

  • setRtpHeader(value: RtpPacketHeader): void
  • Sets the Rtp Packet Header for this media buffer.

    Parameters

    • value: RtpPacketHeader

    Returns void

setRtpHeaders

  • setRtpHeaders(value: RtpPacketHeader[]): void
  • Sets the Rtp Packet Headers for this media buffer.

    Parameters

    • value: RtpPacketHeader[]

    Returns void

setSequenceNumber

  • setSequenceNumber(value: number): void
  • Sets the sequence number.

    Parameters

    • value: number

    Returns void

setSequenceNumbers

  • setSequenceNumbers(value: number[]): void
  • Sets the sequence numbers.

    Parameters

    • value: number[]

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setSourceId

  • setSourceId(value: string): void
  • Sets the source identifier.

    Parameters

    • value: string

    Returns void

setStride

  • setStride(value: number): void
  • Sets the stride.

    Parameters

    • value: number

    Returns void

setStrides

  • setStrides(value: number[]): void
  • Sets the strides.

    Parameters

    • value: number[]

    Returns void

setWidth

  • setWidth(value: number): void
  • Sets the width.

    Parameters

    • value: number

    Returns void

toJson

  • toJson(): string
  • Serializes this instance to JSON.

    Returns string

toPlanar

  • toPlanar(): VideoBuffer
  • Converts a planar representation of this packed buffer, if in YUV-packed format. Otherwise, returns the current buffer.

    Returns VideoBuffer

toString

  • toString(): string
  • Returns a string that represents this instance.

    Returns string

unsetDynamicValue

  • unsetDynamicValue(key: string): boolean
  • Unsets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns boolean

    true if the value was removed; otherwise, false.

Private write

  • write(rValues: number[], gValues: number[], bValues: number[], aValues: number[]): void
  • internal

    Parameters

    • rValues: number[]
    • gValues: number[]
    • bValues: number[]
    • aValues: number[]

    Returns void

Static Private calculateByteCount

  • calculateByteCount(format: VideoFormat, width: number, height: number): number
  • internal

    Parameters

    • format: VideoFormat
    • width: number
    • height: number

    Returns number

Static createBlack

  • createBlack(width: number, height: number, formatName: string): VideoBuffer
  • Creates a black (0, 0, 0) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createBlue

  • createBlue(width: number, height: number, formatName: string): VideoBuffer
  • Creates a blue (0, 0, 255) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createCustom

  • createCustom(width: number, height: number, red: number, green: number, blue: number, formatName: string): VideoBuffer
  • createCustom(width: number, height: number, red: number, green: number, blue: number, formatName: string, buffer: DataBuffer): VideoBuffer
  • Creates a custom video buffer with the specified width/height and red/green/blue values for the specified format name. If the format is not supported, returns null.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • red: number

      The red value.

    • green: number

      The green value.

    • blue: number

      The blue value.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

  • Creates a custom video buffer with the specified width/height and red/green/blue values for the specified format name. If the format is not supported, returns null.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • red: number

      The red value.

    • green: number

      The green value.

    • blue: number

      The blue value.

    • formatName: string

      Name of the format.

    • buffer: DataBuffer

      The output data buffer.

    Returns VideoBuffer

Static createCyan

  • createCyan(width: number, height: number, formatName: string): VideoBuffer
  • Creates a cyan (0, 255, 255) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createDarkBlue

  • createDarkBlue(width: number, height: number, formatName: string): VideoBuffer
  • Creates a dark blue (0, 0, 128) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createDarkGreen

  • createDarkGreen(width: number, height: number, formatName: string): VideoBuffer
  • Creates a dark green (0, 128, 0) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createDarkRed

  • createDarkRed(width: number, height: number, formatName: string): VideoBuffer
  • Creates a dark red (128, 0, 0) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createGray

  • createGray(width: number, height: number, formatName: string): VideoBuffer
  • Creates a gray (255, 255, 255) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createGreen

  • createGreen(width: number, height: number, formatName: string): VideoBuffer
  • Creates a green (0, 255, 0) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createMagenta

  • createMagenta(width: number, height: number, formatName: string): VideoBuffer
  • Creates a magenta (255, 0, 255) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createOlive

  • createOlive(width: number, height: number, formatName: string): VideoBuffer
  • Creates an olive (128, 128, 0) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createPurple

  • createPurple(width: number, height: number, formatName: string): VideoBuffer
  • Creates a purple (128, 0, 128) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createRed

  • createRed(width: number, height: number, formatName: string): VideoBuffer
  • Creates a red (255, 0, 0) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createTeal

  • createTeal(width: number, height: number, formatName: string): VideoBuffer
  • Creates a teal (0, 128, 128) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createWhite

  • createWhite(width: number, height: number, formatName: string): VideoBuffer
  • Creates a white (255, 255, 255) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static createYellow

  • createYellow(width: number, height: number, formatName: string): VideoBuffer
  • Creates a yellow (255, 255, 0) video buffer with the specified width/height.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns VideoBuffer

Static fromJson

  • fromJson(videoBufferJson: string): VideoBuffer
  • Deserializes an instance from JSON.

    Parameters

    • videoBufferJson: string

      The video buffer JSON.

    Returns VideoBuffer

Static fromJsonArray

  • fromJsonArray(videoBuffersJson: string): VideoBuffer[]
  • Deserializes an array of instances from JSON.

    Parameters

    • videoBuffersJson: string

      The video buffers JSON.

    Returns VideoBuffer[]

Static getMinimumBufferLength

  • getMinimumBufferLength(width: number, height: number, formatName: string): number
  • Gets the minimum data buffer length for a given width, height, and format.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • formatName: string

      Name of the format.

    Returns number

Static toJson

  • toJson(videoBuffer: VideoBuffer): string
  • Serializes an instance to JSON.

    Parameters

    • videoBuffer: VideoBuffer

      The video buffer.

    Returns string

Static toJsonArray

  • toJsonArray(videoBuffers: VideoBuffer[]): string
  • Serializes an array of instances to JSON.

    Parameters

    • videoBuffers: VideoBuffer[]

      The video buffers.

    Returns string