/ fm / liveswitch / VideoLayoutRegion
Class: VideoLayoutRegion
fm.liveswitch.VideoLayoutRegion
A video layout region.
Table of contents
Constructors
Methods
- getBounds
- getClientId
- getClientProtocol
- getClientRoles
- getClientTag
- getConnectionId
- getConnectionTag
- getConnectionType
- getDeviceAlias
- getDeviceId
- getFrame
- getTypeString
- getUserAlias
- getUserId
Constructors
constructor
+ new VideoLayoutRegion(frame: LayoutFrame, bounds: LayoutFrame, userId: string, userAlias: string, deviceId: string, deviceAlias: string, clientId: string, clientTag: string, clientRoles: string[], clientProtocol: string, connectionId: string, connectionTag: string, connectionType: string): VideoLayoutRegion
Initializes a new instance of the [[fm.liveswitch.videoLayoutRegion]] class.
Parameters:
| Name | Type | Description |
|---|---|---|
frame |
LayoutFrame | The frame. |
bounds |
LayoutFrame | The bounds. |
userId |
string | The user identifier. |
userAlias |
string | The user alias. |
deviceId |
string | The device identifier. |
deviceAlias |
string | The device alias. |
clientId |
string | The client identifier. |
clientTag |
string | The client tag. |
clientRoles |
string[] | The client roles. |
clientProtocol |
string | The client protocol. |
connectionId |
string | The connection identifier. |
connectionTag |
string | The connection tag. |
connectionType |
string | The connection type. |
Returns: VideoLayoutRegion
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:37
Methods
getBounds
▸ getBounds(): LayoutFrame
Gets the bounds.
Returns: LayoutFrame
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:99
getClientId
▸ getClientId(): string
Gets the client identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:111
getClientProtocol
▸ getClientProtocol(): string
Gets the client protocol.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:123
getClientRoles
▸ getClientRoles(): string[]
Gets the client roles.
Returns: string[]
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:135
getClientTag
▸ getClientTag(): string
Gets the client tag.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:147
getConnectionId
▸ getConnectionId(): string
Gets the connection identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:159
getConnectionTag
▸ getConnectionTag(): string
Gets the connection tag.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:171
getConnectionType
▸ getConnectionType(): string
Gets the connection type.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:183
getDeviceAlias
▸ getDeviceAlias(): string
Gets the device alias.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:195
getDeviceId
▸ getDeviceId(): string
Gets the device identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:207
getFrame
▸ getFrame(): LayoutFrame
Gets the frame.
Returns: LayoutFrame
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:219
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:9
getUserAlias
▸ getUserAlias(): string
Gets the user alias.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:231
getUserId
▸ getUserId(): string
Gets the user identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:243