fm.liveswitch.VideoLayout Class Reference

A description of the layout within a mixed video view. More...

Public Member Functions
java.util.HashMap< String, fm.liveswitch.LayoutFrame >	getBounds ()
	Gets the bounds, keyed by connection ID. More...
boolean	getCrop ()
	Gets whether to crop. More...
java.util.HashMap< String, fm.liveswitch.LayoutFrame >	getFrames ()
	Gets the frames, keyed by connection ID. More...
int	getHeight ()
	Gets the video height. More...
fm.liveswitch.VideoLayoutRegion[]	getRegions ()
	Gets the regions within the layout where each region has a frame, bounds, and client/connection information. More...
int	getWidth ()
	Gets the video width. More...
boolean	isEquivalent (fm.liveswitch.VideoLayout videoLayout)
	Determines whether the specified video layout is equivalent. More...
String	toJson ()
	Serializes this instance to JSON. More...
	VideoLayout (int width, int height)
	Initializes a new instance of the fm.liveswitch.VideoLayout class. More...
	VideoLayout (int width, int height, boolean crop)
	Initializes a new instance of the fm.liveswitch.VideoLayout class. More...
	VideoLayout (int width, int height, java.util.HashMap< String, fm.liveswitch.LayoutFrame > frames, java.util.HashMap< String, fm.liveswitch.LayoutFrame > bounds)
	Initializes a new instance of the fm.liveswitch.VideoLayout class. More...
	VideoLayout (int width, int height, java.util.HashMap< String, fm.liveswitch.LayoutFrame > frames, java.util.HashMap< String, fm.liveswitch.LayoutFrame > bounds, boolean crop)
	Initializes a new instance of the fm.liveswitch.VideoLayout class. More...

Static Public Member Functions
static fm.liveswitch.VideoLayout	fromJson (String videoLayoutJson)
	Deserializes a view from JSON. More...
static String	toJson (fm.liveswitch.VideoLayout videoLayout)
	Serializes a view to JSON. More...

Detailed Description

A description of the layout within a mixed video view.

Constructor & Destructor Documentation

VideoLayout() [1/4]

fm.liveswitch.VideoLayout.VideoLayout	(	int	width,
		int	height
	)

Initializes a new instance of the fm.liveswitch.VideoLayout class.

VideoLayout() [2/4]

fm.liveswitch.VideoLayout.VideoLayout	(	int	width,
		int	height,
		boolean	crop
	)

Initializes a new instance of the fm.liveswitch.VideoLayout class.

VideoLayout() [3/4]

fm.liveswitch.VideoLayout.VideoLayout	(	int	width,
		int	height,
		java.util.HashMap< String, fm.liveswitch.LayoutFrame >	frames,
		java.util.HashMap< String, fm.liveswitch.LayoutFrame >	bounds
	)

Initializes a new instance of the fm.liveswitch.VideoLayout class.

VideoLayout() [4/4]

fm.liveswitch.VideoLayout.VideoLayout	(	int	width,
		int	height,
		java.util.HashMap< String, fm.liveswitch.LayoutFrame >	frames,
		java.util.HashMap< String, fm.liveswitch.LayoutFrame >	bounds,
		boolean	crop
	)

Initializes a new instance of the fm.liveswitch.VideoLayout class.

Member Function Documentation

fromJson()

static fm.liveswitch.VideoLayout fm.liveswitch.VideoLayout.fromJson ( String  videoLayoutJson )

static

Deserializes a view from JSON.

Parameters

videoLayoutJson

The layout JSON.

getBounds()

java.util.HashMap<String,fm.liveswitch.LayoutFrame> fm.liveswitch.VideoLayout.getBounds

(

)

Gets the bounds, keyed by connection ID.

getCrop()

boolean fm.liveswitch.VideoLayout.getCrop

(

)

Gets whether to crop.

getFrames()

java.util.HashMap<String,fm.liveswitch.LayoutFrame> fm.liveswitch.VideoLayout.getFrames

(

)

Gets the frames, keyed by connection ID.

getHeight()

int fm.liveswitch.VideoLayout.getHeight

(

)

Gets the video height.

getRegions()

fm.liveswitch.VideoLayoutRegion [] fm.liveswitch.VideoLayout.getRegions

(

)

Gets the regions within the layout where each region has a frame, bounds, and client/connection information.

getWidth()

int fm.liveswitch.VideoLayout.getWidth

(

)

Gets the video width.

isEquivalent()

boolean fm.liveswitch.VideoLayout.isEquivalent

(

fm.liveswitch.VideoLayout

videoLayout

)

Determines whether the specified video layout is equivalent.

Parameters

videoLayout

The video layout.

toJson() [1/2]

String fm.liveswitch.VideoLayout.toJson

(

)

Serializes this instance to JSON.

toJson() [2/2]

static String fm.liveswitch.VideoLayout.toJson ( fm.liveswitch.VideoLayout  videoLayout )

static

Serializes a view to JSON.

Parameters

videoLayout

The layout.