/ fm / liveswitch / VideoConfig

Class: VideoConfig

fm.liveswitch.VideoConfig

A video configuration.

Hierarchy

• MediaConfig<VideoConfig>

  ↳ VideoConfig

Table of contents

Constructors

• constructor

Methods

• fmliveswitchVideoConfigInit
• getClockRate
• getFrameDuration
• getFrameRate
• getHeight
• getSize
• getTypeString
• getWidth
• isEquivalent
• setFrameRate
• setSize
• toString

Constructors

constructor

+ new VideoConfig(size: Size, frameRate: number): VideoConfig

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

Parameters:

Name	Type	Description
size	Size	The size.
frameRate	number	The frame rate.

Returns: VideoConfig

Inherited from: MediaConfig

+ new VideoConfig(size: Size, frameRate: number, clockRate: number): VideoConfig

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

Parameters:

Name	Type	Description
size	Size	The size.
frameRate	number	The frame rate.
clockRate	number	The clock rate.

Returns: VideoConfig

+ new VideoConfig(width: number, height: number, frameRate: number): VideoConfig

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

Parameters:

Name	Type	Description
width	number	The width.
height	number	The height.
frameRate	number	The frame rate.

Returns: VideoConfig

+ new VideoConfig(width: number, height: number, frameRate: number, clockRate: number): VideoConfig

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

Parameters:

Name	Type	Description
width	number	The width.
height	number	The height.
frameRate	number	The frame rate.
clockRate	number	The clock rate.

Returns: VideoConfig

Methods

fmliveswitchVideoConfigInit

▸ PrivatefmliveswitchVideoConfigInit(): void

Returns: void

---

getClockRate

▸ getClockRate(): number

Gets the clock rate.

Returns: number

Inherited from: MediaConfig

---

getFrameDuration

▸ getFrameDuration(): number

Gets the frame duration in milliseconds.

Returns: number

---

getFrameRate

▸ getFrameRate(): number

Gets the frame-rate.

Returns: number

---

getHeight

▸ getHeight(): number

Gets the size height.

Returns: number

---

getSize

▸ getSize(): Size

Gets the size.

Returns: Size

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: MediaConfig

---

getWidth

▸ getWidth(): number

Gets the size width.

Returns: number

---

isEquivalent

▸ isEquivalent(config: VideoConfig): boolean

Determines whether the specified configuration is equivalent.

Parameters:

Name	Type	Description
config	VideoConfig	The configuration.

Returns: boolean

Overrides: MediaConfig

---

setFrameRate

▸ setFrameRate(value: number): void

Sets the frame-rate.

Parameters:

Name	Type
value	number

Returns: void

---

setSize

▸ setSize(value: Size): void

Sets the size.

Parameters:

Name	Type
value	Size

Returns: void

---

toString

▸ toString(): string

Returns a string that represents this instance.

Returns: string