/ fm / liveswitch / RtmpLayoutZones

Class: RtmpLayoutZones

fm.liveswitch.RtmpLayoutZones

The LayoutZones defined in the RTMP custom MCU layout

Table of contents

Constructors

Methods

Constructors

constructor

+ new RtmpLayoutZones(): RtmpLayoutZones

Returns: RtmpLayoutZones

Methods

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/RtmpLayoutZones.ts:9

getFull

▸ StaticgetFull(): string

Gets the name of the Full zone. Full displays inputs at the full size of the MCU ouput. If multiple connections have been assigned to the Full LayoutZone, they will be arranged in a grid of up to two rows. Maximum of five inputs will be displayed.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/RtmpLayoutZones.ts:20

getFullSingle

▸ StaticgetFullSingle(): string

Gets the name of the FullSingle Zone. FullSingle displays a single input at the full size of the MCU output. If multiple connections have been assigned to the FullSingle LayoutZone, then only the connection with the lowest LayoutPriority will be visible.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/RtmpLayoutZones.ts:35

getPromotedBottom

▸ StaticgetPromotedBottom(): string

Gets the name of the PromotedBottom zone. PromotedButtom displays inputs at 75% of the MCU ouptut height aligned to the bottom of the video frame. If multiple inputs are assigned to the PromotedBottom zone, they will be a arranged as a grid with a maximum of two rows and five inputs. Inputs that are not assigned to the PromotedBottom zone will be displayed at the top edge of the video frame in a single row with a maximum of four inputs displayed.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/RtmpLayoutZones.ts:52

getPromotedFloat

▸ StaticgetPromotedFloat(): string

Gets the name of the PromotedFloat Zone. PromotedFloat floats the input at the bottom right corner of the mix above other active zones.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/RtmpLayoutZones.ts:65

getPromotedLeft

▸ StaticgetPromotedLeft(): string

Gets the name of the PromotedLeft zone. PromotedLeft displays inputs at 75% of the MCU ouptut width aligned to the left of the video frame. If multiple inputs are assigned to the Promoted zone, they will be a arranged as a grid with a maximum of two rows and five inputs. Inputs that are not assigned to the Promoted zone will be displayed at the right edge of the video frame in a single column with a maximum of four inputs displayed.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/RtmpLayoutZones.ts:82

getPromotedLeftSingle

▸ StaticgetPromotedLeftSingle(): string

Gets the name of the PromotedLeftSingle zone. PromotedLeftSingle displays a single input at 75% of the MCU ouptut width aligend to the left of the video frame. If multiple inputs are assigned to the PromotedSingle zone, then the input with the lowest LayoutPriority value will be displayed. Inputs that are not assigned to the PromotedSingle zone will be displayed at the right edge of the video frame in a single column with a maximum of four inputs displayed.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/RtmpLayoutZones.ts:99

getPromotedRight

▸ StaticgetPromotedRight(): string

Gets the name of the PromotedRight zone. PromotedRight displays inputs at 75% of the MCU ouptut width aligned to the right of the video frame. If multiple inputs are assigned to the PromotedRight zone, they will be a arranged as a grid with a maximum of two rows and five inputs. Inputs that are not assigned to the PromotedRight zone will be displayed at the left edge of the video frame in a single column with a maximum of four inputs displayed.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/RtmpLayoutZones.ts:116

getPromotedTop

▸ StaticgetPromotedTop(): string

Gets the name of the PromotedTop zone. PromotedTop displays inputs at 75% of the MCU ouptut height aligned to the top of the video frame. If multiple inputs are assigned to the PromotedTop zone, they will be a arranged as a grid with a maximum of two rows and five inputs. Inputs that are not assigned to the PromotedTop zone will be displayed at the bottom edge of the video frame in a single row with a maximum of four inputs displayed.

Returns: string

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