/ fm / liveswitch / VideoConfig
Class: VideoConfig
fm.liveswitch.VideoConfig
A video configuration.
Hierarchy
-
↳ VideoConfig
Table of contents
Constructors
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
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:21
+ 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
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:29
+ 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
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:38
+ 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
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:47
Methods
fmliveswitchVideoConfigInit
▸ PrivatefmliveswitchVideoConfigInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:18
getClockRate
▸ getClockRate(): number
Gets the clock rate.
Returns: number
Inherited from: MediaConfig
Defined in: Generated/TypeScript/fm.liveswitch/MediaConfig.ts:44
getFrameDuration
▸ getFrameDuration(): number
Gets the frame duration in milliseconds.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:142
getFrameRate
▸ getFrameRate(): number
Gets the frame-rate.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:158
getHeight
▸ getHeight(): number
Gets the size height.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:170
getSize
▸ getSize(): Size
Gets the size.
Returns: Size
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:182
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: MediaConfig
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:10
getWidth
▸ getWidth(): number
Gets the size width.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:194
isEquivalent
▸ isEquivalent(config: VideoConfig): boolean
Determines whether the specified configuration is equivalent.
Parameters:
| Name | Type | Description |
|---|---|---|
config |
VideoConfig | The configuration. |
Returns: boolean
Overrides: MediaConfig
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:207
setFrameRate
▸ setFrameRate(value: number): void
Sets the frame-rate.
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:222
setSize
▸ setSize(value: Size): void
Sets the size.
Parameters:
| Name | Type |
|---|---|
value |
Size |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:237
toString
▸ toString(): string
Returns a string that represents this instance.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoConfig.ts:252