FMLiveSwitchVideoLayoutRegion Class Reference

A video layout region. More...

Instance Methods

(FMLiveSwitchLayoutFrame *) - bounds
 Gets the bounds. More...
 
(NSString *) - clientId
 Gets the client identifier. More...
 
(NSString *) - clientProtocol
 Gets the client protocol. More...
 
(NSMutableArray *) - clientRoles
 Gets the client roles. More...
 
(NSString *) - clientTag
 Gets the client tag. More...
 
(NSString *) - connectionId
 Gets the connection identifier. More...
 
(NSString *) - connectionTag
 Gets the connection tag. More...
 
(NSString *) - connectionType
 Gets the connection type. More...
 
(NSString *) - deviceAlias
 Gets the device alias. More...
 
(NSString *) - deviceId
 Gets the device identifier. More...
 
(FMLiveSwitchLayoutFrame *) - frame
 Gets the frame. More...
 
(instancetype) - initWithFrame:bounds:userId:userAlias:deviceId:deviceAlias:clientId:clientTag:clientRoles:clientProtocol:connectionId:connectionTag:connectionType:
 Initializes a new instance of the FMLiveSwitchVideoLayoutRegion class. More...
 
(NSString *) - userAlias
 Gets the user alias. More...
 
(NSString *) - userId
 Gets the user identifier. More...
 

Class Methods

(FMLiveSwitchVideoLayoutRegion *) + videoLayoutRegionWithFrame:bounds:userId:userAlias:deviceId:deviceAlias:clientId:clientTag:clientRoles:clientProtocol:connectionId:connectionTag:connectionType:
 Initializes a new instance of the FMLiveSwitchVideoLayoutRegion class. More...
 

Detailed Description

A video layout region.

Method Documentation

◆ bounds

Gets the bounds.

◆ clientId

- (NSString*) clientId

Gets the client identifier.

◆ clientProtocol

- (NSString*) clientProtocol

Gets the client protocol.

◆ clientRoles

- (NSMutableArray*) clientRoles

Gets the client roles.

◆ clientTag

- (NSString*) clientTag

Gets the client tag.

◆ connectionId

- (NSString*) connectionId

Gets the connection identifier.

◆ connectionTag

- (NSString*) connectionTag

Gets the connection tag.

◆ connectionType

- (NSString*) connectionType

Gets the connection type.

◆ deviceAlias

- (NSString*) deviceAlias

Gets the device alias.

◆ deviceId

- (NSString*) deviceId

Gets the device identifier.

◆ frame

Gets the frame.

◆ initWithFrame:bounds:userId:userAlias:deviceId:deviceAlias:clientId:clientTag:clientRoles:clientProtocol:connectionId:connectionTag:connectionType:

- (instancetype) initWithFrame: (FMLiveSwitchLayoutFrame *)  frame
bounds: (FMLiveSwitchLayoutFrame *)  bounds
userId: (NSString *)  userId
userAlias: (NSString *)  userAlias
deviceId: (NSString *)  deviceId
deviceAlias: (NSString *)  deviceAlias
clientId: (NSString *)  clientId
clientTag: (NSString *)  clientTag
clientRoles: (NSMutableArray *)  clientRoles
clientProtocol: (NSString *)  clientProtocol
connectionId: (NSString *)  connectionId
connectionTag: (NSString *)  connectionTag
connectionType: (NSString *)  connectionType 

Initializes a new instance of the FMLiveSwitchVideoLayoutRegion class.

Parameters
frameThe frame.
boundsThe bounds.
userIdThe user identifier.
userAliasThe user alias.
deviceIdThe device identifier.
deviceAliasThe device alias.
clientIdThe client identifier.
clientTagThe client tag.
clientRolesThe client roles.
clientProtocolThe client protocol.
connectionIdThe connection identifier.
connectionTagThe connection tag.
connectionTypeThe connection type.

◆ userAlias

- (NSString*) userAlias

Gets the user alias.

◆ userId

- (NSString*) userId

Gets the user identifier.

◆ videoLayoutRegionWithFrame:bounds:userId:userAlias:deviceId:deviceAlias:clientId:clientTag:clientRoles:clientProtocol:connectionId:connectionTag:connectionType:

+ (FMLiveSwitchVideoLayoutRegion*) videoLayoutRegionWithFrame: (FMLiveSwitchLayoutFrame *)  frame
bounds: (FMLiveSwitchLayoutFrame *)  bounds
userId: (NSString *)  userId
userAlias: (NSString *)  userAlias
deviceId: (NSString *)  deviceId
deviceAlias: (NSString *)  deviceAlias
clientId: (NSString *)  clientId
clientTag: (NSString *)  clientTag
clientRoles: (NSMutableArray *)  clientRoles
clientProtocol: (NSString *)  clientProtocol
connectionId: (NSString *)  connectionId
connectionTag: (NSString *)  connectionTag
connectionType: (NSString *)  connectionType 

Initializes a new instance of the FMLiveSwitchVideoLayoutRegion class.

Parameters
frameThe frame.
boundsThe bounds.
userIdThe user identifier.
userAliasThe user alias.
deviceIdThe device identifier.
deviceAliasThe device alias.
clientIdThe client identifier.
clientTagThe client tag.
clientRolesThe client roles.
clientProtocolThe client protocol.
connectionIdThe connection identifier.
connectionTagThe connection tag.
connectionTypeThe connection type.