FMLiveSwitchVideoLayout Class Reference

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

Instance Methods
(NSMutableDictionary< NSString *, FMLiveSwitchLayoutFrame * > *)	- bounds
	Gets the bounds, keyed by connection ID. More...
(bool)	- crop
	Gets whether to crop. More...
(NSMutableDictionary< NSString *, FMLiveSwitchLayoutFrame * > *)	- frames
	Gets the frames, keyed by connection ID. More...
(int)	- height
	Gets the video height. More...
(instancetype)	- initWithWidth:height:
	Initializes a new instance of the FMLiveSwitchVideoLayout class. More...
(instancetype)	- initWithWidth:height:crop:
	Initializes a new instance of the FMLiveSwitchVideoLayout class. More...
(instancetype)	- initWithWidth:height:frames:bounds:
	Initializes a new instance of the FMLiveSwitchVideoLayout class. More...
(instancetype)	- initWithWidth:height:frames:bounds:crop:
	Initializes a new instance of the FMLiveSwitchVideoLayout class. More...
(bool)	- isEquivalentWithVideoLayout:
	Determines whether the specified video layout is equivalent. More...
(NSMutableArray *)	- regions
	Gets the regions within the layout where each region has a frame, bounds, and client/connection information. More...
(NSString *)	- toJson
	Serializes this instance to JSON. More...
(int)	- width
	Gets the video width. More...

Class Methods
(FMLiveSwitchVideoLayout *)	+ fromJsonWithVideoLayoutJson:
	Deserializes a view from JSON. More...
(NSString *)	+ toJsonWithVideoLayout:
	Serializes a view to JSON. More...
(FMLiveSwitchVideoLayout *)	+ videoLayoutWithWidth:height:
	Initializes a new instance of the FMLiveSwitchVideoLayout class. More...
(FMLiveSwitchVideoLayout *)	+ videoLayoutWithWidth:height:crop:
	Initializes a new instance of the FMLiveSwitchVideoLayout class. More...
(FMLiveSwitchVideoLayout *)	+ videoLayoutWithWidth:height:frames:bounds:
	Initializes a new instance of the FMLiveSwitchVideoLayout class. More...
(FMLiveSwitchVideoLayout *)	+ videoLayoutWithWidth:height:frames:bounds:crop:
	Initializes a new instance of the FMLiveSwitchVideoLayout class. More...

Detailed Description

A description of the layout within a mixed video view.

Method Documentation

bounds

- (NSMutableDictionary<NSString*,FMLiveSwitchLayoutFrame*>*) bounds

Gets the bounds, keyed by connection ID.

crop

- (bool) crop

Gets whether to crop.

frames

- (NSMutableDictionary<NSString*,FMLiveSwitchLayoutFrame*>*) frames

Gets the frames, keyed by connection ID.

fromJsonWithVideoLayoutJson:

+ (FMLiveSwitchVideoLayout*) fromJsonWithVideoLayoutJson:

(NSString *)

videoLayoutJson

Deserializes a view from JSON.

Parameters

videoLayoutJson

The layout JSON.

height

- (int) height

Gets the video height.

initWithWidth:height:

- (instancetype) initWithWidth:		(int)	width
height:		(int)	height

Initializes a new instance of the FMLiveSwitchVideoLayout class.

initWithWidth:height:crop:

- (instancetype) initWithWidth:		(int)	width
height:		(int)	height
crop:		(bool)	crop

Initializes a new instance of the FMLiveSwitchVideoLayout class.

initWithWidth:height:frames:bounds:

- (instancetype) initWithWidth:		(int)	width
height:		(int)	height
frames:		(NSMutableDictionary< NSString *, FMLiveSwitchLayoutFrame * > *)	frames
bounds:		(NSMutableDictionary< NSString *, FMLiveSwitchLayoutFrame * > *)	bounds

Initializes a new instance of the FMLiveSwitchVideoLayout class.

initWithWidth:height:frames:bounds:crop:

- (instancetype) initWithWidth:		(int)	width
height:		(int)	height
frames:		(NSMutableDictionary< NSString *, FMLiveSwitchLayoutFrame * > *)	frames
bounds:		(NSMutableDictionary< NSString *, FMLiveSwitchLayoutFrame * > *)	bounds
crop:		(bool)	crop

Initializes a new instance of the FMLiveSwitchVideoLayout class.

isEquivalentWithVideoLayout:

- (bool) isEquivalentWithVideoLayout:

(FMLiveSwitchVideoLayout *)

videoLayout

Determines whether the specified video layout is equivalent.

Parameters

videoLayout

The video layout.

regions

- (NSMutableArray*) regions

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

toJson

- (NSString*) toJson

Serializes this instance to JSON.

toJsonWithVideoLayout:

+ (NSString*) toJsonWithVideoLayout:

(FMLiveSwitchVideoLayout *)

videoLayout

Serializes a view to JSON.

Parameters

videoLayout

The layout.

videoLayoutWithWidth:height:

+ (FMLiveSwitchVideoLayout*) videoLayoutWithWidth:		(int)	width
height:		(int)	height

Initializes a new instance of the FMLiveSwitchVideoLayout class.

videoLayoutWithWidth:height:crop:

+ (FMLiveSwitchVideoLayout*) videoLayoutWithWidth:		(int)	width
height:		(int)	height
crop:		(bool)	crop

Initializes a new instance of the FMLiveSwitchVideoLayout class.

videoLayoutWithWidth:height:frames:bounds:

+ (FMLiveSwitchVideoLayout*) videoLayoutWithWidth:		(int)	width
height:		(int)	height
frames:		(NSMutableDictionary< NSString *, FMLiveSwitchLayoutFrame * > *)	frames
bounds:		(NSMutableDictionary< NSString *, FMLiveSwitchLayoutFrame * > *)	bounds

Initializes a new instance of the FMLiveSwitchVideoLayout class.

videoLayoutWithWidth:height:frames:bounds:crop:

+ (FMLiveSwitchVideoLayout*) videoLayoutWithWidth:		(int)	width
height:		(int)	height
frames:		(NSMutableDictionary< NSString *, FMLiveSwitchLayoutFrame * > *)	frames
bounds:		(NSMutableDictionary< NSString *, FMLiveSwitchLayoutFrame * > *)	bounds
crop:		(bool)	crop

Initializes a new instance of the FMLiveSwitchVideoLayout class.

width

- (int) width

Gets the video width.