FMIceLinkLayoutManager Class Reference

Inherits from FMIceLinkLayoutPreset : FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Conforms to T
__covariant
Declared in FMIceLinkLayoutManager.h
FMIceLinkLayoutManager.m

Overview

A class that supplies simple video frame [layout](#//api/name/layout) management.

– addOnLayout:

Adds a handler that is raised when a [layout](#//api/name/layout) is calculated.
- (void)addOnLayout:(FMIceLinkAction1<FMIceLinkLayout*> *)value

Discussion

Adds a handler that is raised when a [layout](#//api/name/layout) is calculated.

Declared In

FMIceLinkLayoutManager.h

– addOnLayoutWithBlock

Adds a handler that is raised when a [layout](#//api/name/layout) is calculated.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkLayout *) ))addOnLayoutWithBlock

Discussion

Adds a handler that is raised when a [layout](#//api/name/layout) is calculated.

Declared In

FMIceLinkLayoutManager.h

– addOnLayoutWithBlock:

Adds a handler that is raised when a [layout](#//api/name/layout) is calculated.
- (void)addOnLayoutWithBlock:(void ( ^ ) ( FMIceLinkLayout *))valueBlock

Discussion

Adds a handler that is raised when a [layout](#//api/name/layout) is calculated.

Declared In

FMIceLinkLayoutManager.h

– addRemoteMedia:

Adds remote media to the [layout](#//api/name/layout).
- (bool)addRemoteMedia:(NSObject<FMIceLinkIViewableMedia> *)remoteMedia

Parameters

remoteMedia

The remote media.

Return Value

true if successful; otherwise, false.

Discussion

Adds remote media to the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– addRemoteViewsWithIds:views:

Adds remote views to the [layout](#//api/name/layout).
- (bool)addRemoteViewsWithIds:(NSMutableArray *)ids views:(NSMutableArray *)views

Parameters

ids

The remote view IDs.
views

The remote views.

Return Value

true if successful; otherwise, false. Check the logs for additional information.

Discussion

Adds remote views to the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– addRemoteViewWithId:view:

Adds a remote view to the [layout](#//api/name/layout).
- (bool)addRemoteViewWithId:(NSString *)idValue view:(T)view

Parameters

idValue

The remote view ID.
view

The remote view.

Return Value

true if successful; otherwise, false. Check the logs for additional information.

Discussion

Adds a remote view to the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– addView:

Adds a view to the container.
- (void)addView:(T)view

Parameters

view

The view to add.

Discussion

Adds a view to the container.

Declared In

FMIceLinkLayoutManager.h

– dispatchToMainThreadWithAction:arg1:arg2:

Dispatches an action to the main thread.
- (void)dispatchToMainThreadWithAction:(FMIceLinkAction2<id,id> *)action arg1:(id)arg1 arg2:(id)arg2

Parameters

action

The action to invoke.
arg1

The first argument.
arg2

The second argument.

Discussion

Dispatches an action to the main thread.

Declared In

FMIceLinkLayoutManager.h

– dispatchToMainThreadWithActionBlock:arg1:arg2:

Dispatches an action to the main thread.
- (void)dispatchToMainThreadWithActionBlock:(void ( ^ ) ( id , id ))actionBlock arg1:(id)arg1 arg2:(id)arg2

Parameters

actionBlock

The action to invoke.
arg1

The first argument.
arg2

The second argument.

Discussion

Dispatches an action to the main thread.

Declared In

FMIceLinkLayoutManager.h

– dispatchToMainThreadWithActionBlockAndArg1AndArg2

Dispatches an action to the main thread.

@inlineparam actionBlock The action to invoke. @inlineparam arg1 The first argument. @inlineparam arg2 The second argument.

- (void ( ^ ) ( void ( ^ ) ( id , id ) , id , id ))dispatchToMainThreadWithActionBlockAndArg1AndArg2

Discussion

Dispatches an action to the main thread.

@inlineparam actionBlock The action to invoke. @inlineparam arg1 The first argument. @inlineparam arg2 The second argument.

Declared In

FMIceLinkLayoutManager.h

– getLayoutWithLayoutWidth:layoutHeight:remoteCount:

Gets a video frame [layout](#//api/name/layout).
- (FMIceLinkLayout *)getLayoutWithLayoutWidth:(int)layoutWidth layoutHeight:(int)layoutHeight remoteCount:(int)remoteCount

Parameters

layoutWidth

The total width of the layout.
layoutHeight

The total height of the layout.
remoteCount

The number of remote frames.

Return Value

The video frame layout.

Discussion

Gets a video frame [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– getLayoutWithLayoutWidth:layoutHeight:remoteCount:remoteViewIds:

Gets a video frame [layout](#//api/name/layout).
- (FMIceLinkLayout *)getLayoutWithLayoutWidth:(int)layoutWidth layoutHeight:(int)layoutHeight remoteCount:(int)remoteCount remoteViewIds:(NSMutableArray *)remoteViewIds

Parameters

layoutWidth

The total width of the layout.
layoutHeight

The total height of the layout.
remoteCount

The number of remote frames.
remoteViewIds

The array of remote view ids.

Return Value

The video frame layout.

Discussion

Gets a video frame [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– getLocalView

Gets the local view from the [layout](#//api/name/layout).
- (T)getLocalView

Return Value

The local view.

Discussion

Gets the local view from the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– getRemoteViewIds

Gets the IDs of the remote views in the [layout](#//api/name/layout).
- (NSMutableArray *)getRemoteViewIds

Return Value

The remote view IDs.

Discussion

Gets the IDs of the remote views in the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– getRemoteViews

Gets all remote views from the [layout](#//api/name/layout).
- (NSMutableArray<T> *)getRemoteViews

Return Value

The remote views.

Discussion

Gets all remote views from the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– getRemoteViewsWithIds:

Gets remote views from the [layout](#//api/name/layout).
- (NSMutableArray<T> *)getRemoteViewsWithIds:(NSMutableArray *)ids

Parameters

ids

The remote view IDs.

Return Value

The remote views.

Discussion

Gets remote views from the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– getRemoteViewWithId:

Gets a remote view from the [layout](#//api/name/layout).
- (T)getRemoteViewWithId:(NSString *)idValue

Parameters

idValue

The remote view ID.

Return Value

The remote view.

Discussion

Gets a remote view from the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– init

Initializes a new instance of the FMIceLinkLayoutManager`1 class.
- (instancetype)init

Discussion

Initializes a new instance of the FMIceLinkLayoutManager`1 class.

Declared In

FMIceLinkLayoutManager.h

– initWithPreset:

Initializes a new instance of the FMIceLinkLayoutManager`1 class.
- (instancetype)initWithPreset:(FMIceLinkLayoutPreset *)preset

Discussion

Initializes a new instance of the FMIceLinkLayoutManager`1 class.

Declared In

FMIceLinkLayoutManager.h

– layout

Positions the local and remote views within the layout.
- (void)layout

Discussion

Positions the local and remote views within the layout.

Declared In

FMIceLinkLayoutManager.h

+ layoutManager

Initializes a new instance of the FMIceLinkLayoutManager`1 class.
+ (FMIceLinkLayoutManager *)layoutManager

Discussion

Initializes a new instance of the FMIceLinkLayoutManager`1 class.

Declared In

FMIceLinkLayoutManager.h

+ layoutManagerWithPreset:

Initializes a new instance of the FMIceLinkLayoutManager`1 class.
+ (FMIceLinkLayoutManager *)layoutManagerWithPreset:(FMIceLinkLayoutPreset *)preset

Discussion

Initializes a new instance of the FMIceLinkLayoutManager`1 class.

Declared In

FMIceLinkLayoutManager.h

– layoutOnMainThread

Positions the local and remote views within the [layout](#//api/name/layout) after dispatching to the main thread.
- (void)layoutOnMainThread

Discussion

Positions the local and remote views within the [layout](#//api/name/layout) after dispatching to the main thread.

Declared In

FMIceLinkLayoutManager.h

– layoutOrigin

Gets the [layout](#//api/name/layout) origin. Defaults to TopLeft.
- (FMIceLinkLayoutOrigin)layoutOrigin

Discussion

Gets the [layout](#//api/name/layout) origin. Defaults to TopLeft.

Declared In

FMIceLinkLayoutManager.h

– removeOnLayout:

Removes a handler that is raised when a [layout](#//api/name/layout) is calculated.
- (void)removeOnLayout:(FMIceLinkAction1<FMIceLinkLayout*> *)value

Discussion

Removes a handler that is raised when a [layout](#//api/name/layout) is calculated.

Declared In

FMIceLinkLayoutManager.h

– removeRemoteMedia:

Removes remote media from the [layout](#//api/name/layout).
- (bool)removeRemoteMedia:(NSObject<FMIceLinkIViewableMedia> *)remoteMedia

Parameters

remoteMedia

The remote media.

Return Value

true if successful; otherwise, false.

Discussion

Removes remote media from the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– removeRemoteViews

Removes all remote views from the [layout](#//api/name/layout).
- (void)removeRemoteViews

Discussion

Removes all remote views from the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– removeRemoteViewsWithIds:

Removes remote views from the [layout](#//api/name/layout).
- (bool)removeRemoteViewsWithIds:(NSMutableArray *)ids

Parameters

ids

The remote view IDs.

Return Value

true if successful; otherwise, false. Check the logs for additional information.

Discussion

Removes remote views from the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– removeRemoteViewWithId:

Removes a remote view from the [layout](#//api/name/layout).
- (bool)removeRemoteViewWithId:(NSString *)idValue

Parameters

idValue

The remote view ID.

Return Value

true if successful; otherwise, false. Check the logs for additional information.

Discussion

Removes a remote view from the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– removeView:

Removes a view from the container.
- (void)removeView:(T)view

Parameters

view

The view to remove.

Discussion

Removes a view from the container.

Declared In

FMIceLinkLayoutManager.h

– reset

Removes all remote views from the [layout](#//api/name/layout), then removes the local view from the [layout](#//api/name/layout).
- (void)reset

Discussion

Removes all remote views from the [layout](#//api/name/layout), then removes the local view from the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– setLayoutOrigin:

Sets the [layout](#//api/name/layout) origin. Defaults to TopLeft.
- (void)setLayoutOrigin:(FMIceLinkLayoutOrigin)value

Discussion

Sets the [layout](#//api/name/layout) origin. Defaults to TopLeft.

Declared In

FMIceLinkLayoutManager.h

– setLocalMedia:

Adds the local media to the [layout](#//api/name/layout).
- (bool)setLocalMedia:(NSObject<FMIceLinkIViewableMedia> *)localMedia

Parameters

localMedia

The local media.

Return Value

true if successful; otherwise, false.

Discussion

Adds the local media to the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– setLocalView:

Adds the local view to the [layout](#//api/name/layout).
- (bool)setLocalView:(T)view

Parameters

view

The local view.

Return Value

true if successful; otherwise, false. Check the logs for additional information.

Discussion

Adds the local view to the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– swapRemoteMediaWithRemoteMediaToRemove:remoteMediaToAdd:

Swaps remote media in the [layout](#//api/name/layout).
- (bool)swapRemoteMediaWithRemoteMediaToRemove:(NSObject<FMIceLinkIViewableMedia> *)remoteMediaToRemove remoteMediaToAdd:(NSObject<FMIceLinkIViewableMedia> *)remoteMediaToAdd

Parameters

remoteMediaToRemove

The remote media to remove.
remoteMediaToAdd

The remote media to add. @return

Discussion

Swaps remote media in the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– swapRemoteViewsWithIdsToRemove:idsToAdd:viewsToAdd:

Swaps remote views in the [layout](#//api/name/layout).
- (bool)swapRemoteViewsWithIdsToRemove:(NSMutableArray *)idsToRemove idsToAdd:(NSMutableArray *)idsToAdd viewsToAdd:(NSMutableArray *)viewsToAdd

Parameters

idsToRemove

The remote view IDs to remove.
idsToAdd

The remote view IDs to add.
viewsToAdd

The remote views to add.

Return Value

true if successful; otherwise, false. Check the logs for additional information.

Discussion

Swaps remote views in the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– swapRemoteViewWithIdToRemove:idToAdd:viewToAdd:

Swaps a remote view in the [layout](#//api/name/layout).
- (bool)swapRemoteViewWithIdToRemove:(NSString *)idToRemove idToAdd:(NSString *)idToAdd viewToAdd:(T)viewToAdd

Parameters

idToRemove

The remote view ID to remove.
idToAdd

The remote view ID to add.
viewToAdd

The remote view to add. @return

Discussion

Swaps a remote view in the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h

– unsetLocalView

Removes the local view from the [layout](#//api/name/layout).
- (bool)unsetLocalView

Return Value

true if successful; otherwise, false. Check the logs for additional information.

Discussion

Removes the local view from the [layout](#//api/name/layout).

Declared In

FMIceLinkLayoutManager.h