/ fm / liveswitch / VideoFormat

Class: VideoFormat

fm.liveswitch.VideoFormat

A video format.

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

+ new VideoFormat(): VideoFormat

Initializes a new instance of the [[fm.liveswitch.videoFormat]] class.

Returns: VideoFormat

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:16

+ new VideoFormat(name: string): VideoFormat

Initializes a new instance of the [[fm.liveswitch.videoFormat]] class.

Parameters:

Name Type Description
name string The name.

Returns: VideoFormat

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:23

+ new VideoFormat(name: string, clockRate: number): VideoFormat

Initializes a new instance of the [[fm.liveswitch.videoFormat]] class.

Parameters:

Name Type Description
name string The name.
clockRate number The clock rate.

Returns: VideoFormat

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:30

+ new VideoFormat(name: string, clockRate: number, packetizationMode: string): VideoFormat

Initializes a new instance of the [[fm.liveswitch.videoFormat]] class.

Parameters:

Name Type Description
name string The name.
clockRate number The clock rate.
packetizationMode string The packetization mode.

Returns: VideoFormat

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:38

+ new VideoFormat(name: string, clockRate: number, profile: string, level: string): VideoFormat

Initializes a new instance of the [[fm.liveswitch.videoFormat]] class.

Parameters:

Name Type Description
name string The name.
clockRate number The clock rate.
profile string The media format profile.
level string The media format level.

Returns: VideoFormat

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:47

+ new VideoFormat(name: string, clockRate: number, profile: string, level: string, packetizationMode: string): VideoFormat

Initializes a new instance of the [[fm.liveswitch.videoFormat]] class.

Parameters:

Name Type Description
name string The name.
clockRate number The clock rate.
profile string The media format profile.
level string The media format level.
packetizationMode string The packetization mode.

Returns: VideoFormat

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:57

+ new VideoFormat(name: string, clockRate: number, profile: string, level: string, packetizationMode: string, tier: string): VideoFormat

Initializes a new instance of the [[fm.liveswitch.videoFormat]] class.

Parameters:

Name Type Description
name string The name.
clockRate number The clock rate.
profile string The media format profile.
level string The media format level.
packetizationMode string The packetization mode.
tier string The media format tier.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:68

Methods

clone

▸ clone(): VideoFormat

Clones this instance.

Returns: VideoFormat

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:682

createInstance

▸ ProtectedcreateInstance(): VideoFormat

Creates a new instance.

Returns: VideoFormat

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:694

fourCCToFormatName

▸ fourCCToFormatName(fourcc: number): string

Converts a FourCC value to its format name.

Parameters:

Name Type Description
fourcc number The FourCC value.

Returns: string

The format name, or an empty string if the FourCC value is not recognized.

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:708

getClockRate

▸ getClockRate(): number

Gets the clock rate.

Returns: number

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:225

getFourCC

▸ getFourCC(): number

Gets the FourCC value for this format.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:735

getFullName

▸ getFullName(): string

Gets the full name, including clock rate and encoding parameters.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:237

getInfo

▸ getInfo(): FormatInfo

Gets this format as an info object.

Returns: FormatInfo

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:747

getIsAbgr

▸ getIsAbgr(): boolean

Gets a value indicating whether this format is ABGR.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:759

getIsArgb

▸ getIsArgb(): boolean

Gets a value indicating whether this format is ARGB.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:771

getIsBgr

▸ getIsBgr(): boolean

Gets a value indicating whether this format is BGR.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:783

getIsBgra

▸ getIsBgra(): boolean

Gets a value indicating whether this format is BGRA.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:795

getIsCompressed

▸ getIsCompressed(): boolean

Gets whether this is a compressed format.

Returns: boolean

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:807

getIsEncrypted

▸ getIsEncrypted(): boolean

Gets a value indicating that the data is encrypted.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:268

getIsFixedBitrate

▸ getIsFixedBitrate(): boolean

Gets a value indicating whether a format only supports fixed bitrate.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:280

getIsH264

▸ getIsH264(): boolean

Gets a value indicating whether this format is H.264.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:819

getIsH265

▸ getIsH265(): boolean

Gets a value indicating whether this format is H.265.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:831

getIsI420

▸ getIsI420(): boolean

Gets a value indicating whether this format is I420.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:843

getIsInjected

▸ getIsInjected(): boolean

Gets a value indicating that the data is injected into the primary media stream (e.g. DTMF).

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:293

getIsNv12

▸ getIsNv12(): boolean

Gets a value indicating whether this format is NV12.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:855

getIsNv21

▸ getIsNv21(): boolean

Gets a value indicating whether this format is NV21.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:867

getIsPacketized

▸ getIsPacketized(): boolean

Gets a value indicating whether the data is packetized.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:305

getIsRaw

▸ getIsRaw(): boolean

Gets a value indicating whether this format is RGB, BGR, I420, YV12, NV12, NV21, RGBA, BGRA, ARGB, or ABGR.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:880

getIsRgb

▸ getIsRgb(): boolean

Gets a value indicating whether this format is RGB.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:892

getIsRgbType

▸ getIsRgbType(): boolean

Gets a value indicating whether this format is RGB or BGR.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:929

getIsRgba

▸ getIsRgba(): boolean

Gets a value indicating whether this format is RGBA.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:904

getIsRgbaType

▸ getIsRgbaType(): boolean

Gets a value indicating whether this format is RGBA, BGRA, ARGB, or ABGR.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:917

getIsVp8

▸ getIsVp8(): boolean

Gets a value indicating whether this format is VP8.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:941

getIsVp9

▸ getIsVp9(): boolean

Gets a value indicating whether this format is VP9.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:953

getIsYuvType

▸ getIsYuvType(): boolean

Gets a value indicating whether this format is I420, YV12, NV12, or NV21.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:966

getIsYv12

▸ getIsYv12(): boolean

Gets a value indicating whether this format is YV12.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:978

getLevel

▸ getLevel(): string

Gets the level.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:317

getLevelIsStrict

▸ getLevelIsStrict(): boolean

Gets a value indicating whether the level is strict.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:329

getMaxBitrate

▸ getMaxBitrate(): number

Gets the maximum bitrate supported by this format, in kbps.

Returns: number

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:341

getMaxLevel

▸ ProtectedgetMaxLevel(level1: string, level2: string): string

Gets the maximum level.

Parameters:

Name Type Description
level1 string The first level.
level2 string The second level.

Returns: string

The maximum level.

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:993

getMinBitrate

▸ getMinBitrate(): number

Gets the minimum bitrate supported by this format, in kbps.

Returns: number

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:368

getMinLevel

▸ ProtectedgetMinLevel(level1: string, level2: string): string

Gets the minimum level.

Parameters:

Name Type Description
level1 string The first level.
level2 string The second level.

Returns: string

The minimum level.

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:1021

getName

▸ getName(): string

Gets the name.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:395

getPacketizationMode

▸ getPacketizationMode(): string

Gets the packetization mode.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:407

getParameters

▸ getParameters(): string

Gets the parameters.

Returns: string

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:1046

getProfile

▸ getProfile(): string

Gets the profile.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:428

getStaticPayloadType

▸ getStaticPayloadType(): number

Gets the static payload type, if this format has a static payload type registered with IANA.

Returns: number

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:449

getTier

▸ getTier(): string

Gets the tier.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:461

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:10

isCompatible

▸ isCompatible(format: VideoFormat): boolean

Determines whether the specified format is compatible.

Parameters:

Name Type Description
format VideoFormat The format.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:502

isEquivalent

▸ isEquivalent(format: VideoFormat, ignoreIsPacketized: boolean): boolean

Determines whether the specified format is equivalent.

Parameters:

Name Type Description
format VideoFormat The format.
ignoreIsPacketized boolean Whether to ignore if the two formats differ in whether they are packetized.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:540

isLevelCompatible

▸ ProtectedisLevelCompatible(level: string): boolean

Gets whether a level is compatible.

Parameters:

Name Type Description
level string The level.

Returns: boolean

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:1059

isProfileCompatible

▸ ProtectedisProfileCompatible(profile: string): boolean

Gets whether a profile is compatible.

Parameters:

Name Type Description
profile string The profile.

Returns: boolean

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:1085

setClockRate

▸ setClockRate(value: number): void

Sets the clock rate.

Parameters:

Name Type
value number

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:622

setFourCC

▸ setFourCC(value: number): void

Sets the FourCC value for this format.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:1102

setIsEncrypted

▸ setIsEncrypted(value: boolean): void

Sets a value indicating that the data is encrypted.

Parameters:

Name Type
value boolean

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:635

setIsFixedBitrate

▸ ProtectedsetIsFixedBitrate(value: boolean): void

Sets a value indicating whether a format only supports fixed bitrate.

Parameters:

Name Type
value boolean

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:647

setIsInjected

▸ setIsInjected(value: boolean): void

Sets a value indicating that the data is injected into the primary media stream (e.g. DTMF).

Parameters:

Name Type
value boolean

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:660

setIsPacketized

▸ setIsPacketized(value: boolean): void

Sets a value indicating whether the data is packetized.

Parameters:

Name Type
value boolean

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:672

setLevel

▸ setLevel(value: string): void

Sets the level.

Parameters:

Name Type
value string

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:684

setLevelIsStrict

▸ setLevelIsStrict(value: boolean): void

Sets a value indicating whether the level is strict.

Parameters:

Name Type
value boolean

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:696

setName

▸ setName(value: string): void

Sets the name.

Parameters:

Name Type
value string

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:708

setPacketizationMode

▸ setPacketizationMode(value: string): void

Sets the packetization mode.

Parameters:

Name Type
value string

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:723

setProfile

▸ setProfile(value: string): void

Sets the profile.

Parameters:

Name Type
value string

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:735

setStaticPayloadType

▸ ProtectedsetStaticPayloadType(value: number): void

Sets the static payload type, if this format has a static payload type registered with IANA.

Parameters:

Name Type
value number

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:757

setTier

▸ setTier(value: string): void

Sets the tier.

Parameters:

Name Type
value string

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:770

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:1115

toString

▸ toString(): string

Returns a string that represents this instance.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:782

updateLevelIsStrictToCompatible

▸ ProtectedupdateLevelIsStrictToCompatible(format: VideoFormat): void

Updates the level-is-strict flag to a compatible value.

Parameters:

Name Type Description
format VideoFormat The format.

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:815

updateLevelToCompatible

▸ ProtectedupdateLevelToCompatible(format: VideoFormat): void

Updates the level to a compatible value.

Parameters:

Name Type Description
format VideoFormat The format.

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:830

updateProfileToCompatible

▸ ProtectedupdateProfileToCompatible(format: VideoFormat): void

Updates the profile to a compatible value.

Parameters:

Name Type Description
format VideoFormat The format.

Returns: void

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:1128

updateTierToCompatible

▸ ProtectedupdateTierToCompatible(format: VideoFormat): void

Updates the tier to a compatible value.

Parameters:

Name Type Description
format VideoFormat The format.

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:870

formatNameToFourCC

▸ StaticformatNameToFourCC(formatName: string): number

Converts a format name to its FourCC value.

Parameters:

Name Type Description
formatName string The format name.

Returns: number

The FourCC value, or 0 if the format name is not recognized.

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:133

fromFormatInfo

▸ StaticfromFormatInfo(info: FormatInfo): VideoFormat

Transforms a FormatInfo into an VideoFormat.

Parameters:

Name Type Description
info FormatInfo The format info.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:150

fromJson

▸ StaticfromJson(videoFormatJson: string): VideoFormat

Deserializes an instance from JSON.

Parameters:

Name Type Description
videoFormatJson string The video format JSON.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:164

getAbgr

▸ StaticgetAbgr(): VideoFormat

Gets an ABGR video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:217

getAbgrName

▸ StaticgetAbgrName(): string

Gets the name of the ABGR video format ("ABGR"). Indicates that each pixel occupies 32 bits (8 bits for alpha, then 8 bits for blue, then8 bits for green, then 8 bits for red).

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:233

getArgb

▸ StaticgetArgb(): VideoFormat

Gets an ARGB video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:246

getArgbName

▸ StaticgetArgbName(): string

Gets the name of the ARGB video format ("ARGB"). Indicates that each pixel occupies 32 bits (8 bits for alpha, then 8 bits for red, then 8 bits for green, then 8 bits for blue).

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:262

getBgr

▸ StaticgetBgr(): VideoFormat

Gets a BGR video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:275

getBgrName

▸ StaticgetBgrName(): string

Gets the name of the BGR video format ("BGR"). Indicates that each pixel occupies 24 bits (8 bits for blue, then8 bits for green, then 8 bits for red).

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:320

getBgra

▸ StaticgetBgra(): VideoFormat

Gets an BGRA video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:290

getBgraName

▸ StaticgetBgraName(): string

Gets the name of the BGRA video format ("BGRA"). Indicates that each pixel occupies 32 bits (8 bits for blue, then8 bits for green, then 8 bits for red, then 8 bits for alpha).

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:306

getDefaultClockRate

▸ StaticgetDefaultClockRate(): number

Gets the default clock rate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:333

getH264

▸ StaticgetH264(): VideoFormat

Gets an H.264 video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:346

getH264Name

▸ StaticgetH264Name(): string

Gets the name of the H.264 video format ("H264").

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:359

getH265

▸ StaticgetH265(): VideoFormat

Gets an H.265 video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:372

getH265Name

▸ StaticgetH265Name(): string

Gets the name of the H.265 video format ("H265").

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:385

getI420

▸ StaticgetI420(): VideoFormat

Gets an I420 video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:398

getI420Name

▸ StaticgetI420Name(): string

Gets the name of the I420 video format ("I420"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by U plane and then V plane.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:415

getNv12

▸ StaticgetNv12(): VideoFormat

Gets an NV12 video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:428

getNv12Name

▸ StaticgetNv12Name(): string

Gets the name of the NV12 video format ("NV12"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by interleaved U/V plane.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:445

getNv21

▸ StaticgetNv21(): VideoFormat

Gets an NV21 video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:458

getNv21Name

▸ StaticgetNv21Name(): string

Gets the name of the NV21 video format ("NV21"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by interleaved V/U plane.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:475

getRedName

▸ StaticgetRedName(): string

Gets the name of the RED media format.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:169

getRgb

▸ StaticgetRgb(): VideoFormat

Gets an RGB video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:488

getRgbName

▸ StaticgetRgbName(): string

Gets the name of the RGB video format ("RGB"). Indicates that each pixel occupies 24 bits (8 bits for red, then 8 bits for green, then 8 bits for blue).

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:533

getRgba

▸ StaticgetRgba(): VideoFormat

Gets an RGBA video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:503

getRgbaName

▸ StaticgetRgbaName(): string

Gets the name of the RGBA video format ("RGBA"). Indicates that each pixel occupies 32 bits (8 bits for red, then 8 bits for green, then 8 bits for blue, then 8 bits for alpha).

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:519

getUlpFecName

▸ StaticgetUlpFecName(): string

Gets the name of the ULPFEC media format.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:181

getVp8

▸ StaticgetVp8(): VideoFormat

Gets a VP8 video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:546

getVp8Name

▸ StaticgetVp8Name(): string

Gets the name of the VP8 video format ("VP8").

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:559

getVp9

▸ StaticgetVp9(): VideoFormat

Gets a VP9 video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:572

getVp9Name

▸ StaticgetVp9Name(): string

Gets the name of the VP9 video format ("VP9").

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:585

getYv12

▸ StaticgetYv12(): VideoFormat

Gets a YV12 video format.

Returns: VideoFormat

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:598

getYv12Name

▸ StaticgetYv12Name(): string

Gets the name of the YV12 video format ("YV12"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by V plane and then U plane.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:615

toFourCC

▸ StatictoFourCC(a: number, b: number, c: number, d: number): number

Converts 4 FourCC characters to an int.

Parameters:

Name Type
a number
b number
c number
d number

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:628

▸ StatictoFourCC(fourcc: string): number

Converts a FourCC string to a int.

Parameters:

Name Type Description
fourcc string The fourcc.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:635

toJson

▸ StatictoJson(videoFormat: VideoFormat): string

Serializes an instance to JSON.

Parameters:

Name Type Description
videoFormat VideoFormat The video format.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/VideoFormat.ts:657