/ fm / liveswitch / VideoLayoutRegion

Class: VideoLayoutRegion

fm.liveswitch.VideoLayoutRegion

A video layout region.

Table of contents

Constructors

• constructor

Methods

• getBounds
• getClientId
• getClientRoles
• getClientTag
• getConnectionId
• getConnectionTag
• 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[], connectionId: string, connectionTag: 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.
connectionId	string	The connection identifier.
connectionTag	string	The connection tag.

Returns: VideoLayoutRegion

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:31

Methods

getBounds

▸ getBounds(): LayoutFrame

Gets the bounds.

Returns: LayoutFrame

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:83

---

getClientId

▸ getClientId(): string

Gets the client identifier.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:93

---

getClientRoles

▸ getClientRoles(): string[]

Gets the client roles.

Returns: string[]

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:103

---

getClientTag

▸ getClientTag(): string

Gets the client tag.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:113

---

getConnectionId

▸ getConnectionId(): string

Gets the connection identifier.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:123

---

getConnectionTag

▸ getConnectionTag(): string

Gets the connection tag.

Returns: string

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

---

getDeviceAlias

▸ getDeviceAlias(): string

Gets the device alias.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:143

---

getDeviceId

▸ getDeviceId(): string

Gets the device identifier.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:153

---

getFrame

▸ getFrame(): LayoutFrame

Gets the frame.

Returns: LayoutFrame

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:163

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:7

---

getUserAlias

▸ getUserAlias(): string

Gets the user alias.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:173

---

getUserId

▸ getUserId(): string

Gets the user identifier.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoLayoutRegion.ts:183