/ fm / liveswitch / VideoLayout
Class: VideoLayout
fm.liveswitch.VideoLayout
A description of the layout within a mixed video view.
Table of contents
Constructors
Methods
- fmliveswitchVideoLayoutInit
- getBounds
- getCrop
- getFrames
- getHeight
- getRegions
- getTypeString
- getWidth
- isEquivalent
- toJson
- fromJson
- toJson
Constructors
constructor
+ new VideoLayout(): VideoLayout
Returns: VideoLayout
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:30
+ new VideoLayout(width: number, height: number): VideoLayout
Initializes a new instance of the [[fm.liveswitch.videoLayout]] class.
Parameters:
| Name | Type |
|---|---|
width |
number |
height |
number |
Returns: VideoLayout
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:31
+ new VideoLayout(width: number, height: number, crop: boolean): VideoLayout
Initializes a new instance of the [[fm.liveswitch.videoLayout]] class.
Parameters:
| Name | Type |
|---|---|
width |
number |
height |
number |
crop |
boolean |
Returns: VideoLayout
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:37
+ new VideoLayout(width: number, height: number, frames: Hash<string, LayoutFrame>, bounds: Hash<string, LayoutFrame>): VideoLayout
Initializes a new instance of the [[fm.liveswitch.videoLayout]] class.
Parameters:
| Name | Type |
|---|---|
width |
number |
height |
number |
frames |
Hash<string, LayoutFrame> |
bounds |
Hash<string, LayoutFrame> |
Returns: VideoLayout
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:43
+ new VideoLayout(width: number, height: number, frames: Hash<string, LayoutFrame>, bounds: Hash<string, LayoutFrame>, crop: boolean): VideoLayout
Initializes a new instance of the [[fm.liveswitch.videoLayout]] class.
Parameters:
| Name | Type |
|---|---|
width |
number |
height |
number |
frames |
Hash<string, LayoutFrame> |
bounds |
Hash<string, LayoutFrame> |
crop |
boolean |
Returns: VideoLayout
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:49
Methods
fmliveswitchVideoLayoutInit
▸ PrivatefmliveswitchVideoLayoutInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:25
getBounds
▸ getBounds(): Hash<string, LayoutFrame>
Gets the bounds, keyed by connection ID.
Returns: Hash<string, LayoutFrame>
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:238
getCrop
▸ getCrop(): boolean
Gets whether to crop.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:258
getFrames
▸ getFrames(): Hash<string, LayoutFrame>
Gets the frames, keyed by connection ID.
Returns: Hash<string, LayoutFrame>
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:270
getHeight
▸ getHeight(): number
Gets the video height.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:282
getRegions
▸ getRegions(): VideoLayoutRegion[]
Gets the regions within the layout where each region has a frame, bounds, and client/connection information.
Returns: VideoLayoutRegion[]
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:295
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:9
getWidth
▸ getWidth(): number
Gets the video width.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:307
isEquivalent
▸ isEquivalent(videoLayout: VideoLayout): boolean
Determines whether the specified video layout is equivalent.
Parameters:
| Name | Type | Description |
|---|---|---|
videoLayout |
VideoLayout | The video layout. |
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:381
toJson
▸ toJson(): string
Serializes this instance to JSON.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:470
fromJson
▸ StaticfromJson(videoLayoutJson: string): VideoLayout
Deserializes a view from JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
videoLayoutJson |
string | The layout JSON. |
Returns: VideoLayout
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:182
toJson
▸ StatictoJson(videoLayout: VideoLayout): string
Serializes a view to JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
videoLayout |
VideoLayout | The layout. |
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayout.ts:220