FMLiveSwitchScreenConfig Class Reference

A screen configuration. More...

Instance Methods

(NSString *) - description
 Returns a string that represents this instance. More...
 
(double) - frameRate
 Gets the frame-rate. More...
 
(int) - height
 Gets the region size height. More...
 
(instancetype) - initWithOrigin:size:frameRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
(instancetype) - initWithOrigin:size:frameRate:clockRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
(instancetype) - initWithRegion:frameRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
(instancetype) - initWithRegion:frameRate:clockRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
(instancetype) - initWithX:y:width:height:frameRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
(instancetype) - initWithX:y:width:height:frameRate:clockRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
(bool) - isEquivalentWithConfig:
 Determines whether the specified configuration is equivalent. More...
 
(FMLiveSwitchPoint *) - origin
 Gets the region origin. More...
 
(FMLiveSwitchRectangle *) - region
 Gets the region. More...
 
(void) - setFrameRate:
 Sets the frame-rate. More...
 
(void) - setOrigin:
 Sets the region origin. More...
 
(void) - setRegion:
 Sets the region. More...
 
(void) - setSize:
 Sets the region size. More...
 
(FMLiveSwitchSize *) - size
 Gets the region size. More...
 
(int) - width
 Gets the region size width. More...
 
(int) - x
 Gets the region origin X coordinate. More...
 
(int) - y
 Gets the region origin Y coordinate. More...
 
- Instance Methods inherited from FMLiveSwitchMediaConfig
(instancetype) - initWithClockRate:
 Initializes a new instance of the FMLiveSwitchMediaConfig`1 class. More...
 
(bool) - isEquivalentWithConfig:
 Determines whether the specified configuration is equivalent. More...
 

Class Methods

(FMLiveSwitchScreenConfig *) + screenConfigWithOrigin:size:frameRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
(FMLiveSwitchScreenConfig *) + screenConfigWithOrigin:size:frameRate:clockRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
(FMLiveSwitchScreenConfig *) + screenConfigWithRegion:frameRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
(FMLiveSwitchScreenConfig *) + screenConfigWithRegion:frameRate:clockRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
(FMLiveSwitchScreenConfig *) + screenConfigWithX:y:width:height:frameRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
(FMLiveSwitchScreenConfig *) + screenConfigWithX:y:width:height:frameRate:clockRate:
 Initializes a new instance of the FMLiveSwitchScreenConfig class. More...
 
- Class Methods inherited from FMLiveSwitchMediaConfig
(FMLiveSwitchMediaConfig *) + mediaConfigWithClockRate:
 Initializes a new instance of the FMLiveSwitchMediaConfig`1 class. More...
 

Additional Inherited Members

- Protected Attributes inherited from FMLiveSwitchMediaConfig
 __pad0__: NSObject- (int) clockRate
 

Detailed Description

A screen configuration.

Method Documentation

◆ description

- (NSString*) description

Returns a string that represents this instance.

◆ frameRate

- (double) frameRate

Gets the frame-rate.

◆ height

- (int) height

Gets the region size height.

◆ initWithOrigin:size:frameRate:

- (instancetype) initWithOrigin: (FMLiveSwitchPoint *)  origin
size: (FMLiveSwitchSize *)  size
frameRate: (double)  frameRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
originThe region origin.
sizeThe region size.
frameRateThe frame rate.

◆ initWithOrigin:size:frameRate:clockRate:

- (instancetype) initWithOrigin: (FMLiveSwitchPoint *)  origin
size: (FMLiveSwitchSize *)  size
frameRate: (double)  frameRate
clockRate: (int)  clockRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
originThe region origin.
sizeThe region size.
frameRateThe frame rate.
clockRateThe clock rate.

◆ initWithRegion:frameRate:

- (instancetype) initWithRegion: (FMLiveSwitchRectangle *)  region
frameRate: (double)  frameRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
regionThe region.
frameRateThe frame rate.

◆ initWithRegion:frameRate:clockRate:

- (instancetype) initWithRegion: (FMLiveSwitchRectangle *)  region
frameRate: (double)  frameRate
clockRate: (int)  clockRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
regionThe region.
frameRateThe frame rate.
clockRateThe clock rate.

◆ initWithX:y:width:height:frameRate:

- (instancetype) initWithX: (int)  x
y: (int)  y
width: (int)  width
height: (int)  height
frameRate: (double)  frameRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
xThe region origin X coordinate.
yThe region origin Y coordinate.
widthThe region size width.
heightThe region size height.
frameRateThe frame rate.

◆ initWithX:y:width:height:frameRate:clockRate:

- (instancetype) initWithX: (int)  x
y: (int)  y
width: (int)  width
height: (int)  height
frameRate: (double)  frameRate
clockRate: (int)  clockRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
xThe region origin X coordinate.
yThe region origin Y coordinate.
widthThe region size width.
heightThe region size height.
frameRateThe frame rate.
clockRateThe clock rate.

◆ isEquivalentWithConfig:

- (bool) isEquivalentWithConfig: (FMLiveSwitchScreenConfig *)  config

Determines whether the specified configuration is equivalent.

Parameters
configThe configuration.

◆ origin

- (FMLiveSwitchPoint*) origin

Gets the region origin.

◆ region

- (FMLiveSwitchRectangle*) region

Gets the region.

◆ screenConfigWithOrigin:size:frameRate:

+ (FMLiveSwitchScreenConfig*) screenConfigWithOrigin: (FMLiveSwitchPoint *)  origin
size: (FMLiveSwitchSize *)  size
frameRate: (double)  frameRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
originThe region origin.
sizeThe region size.
frameRateThe frame rate.

◆ screenConfigWithOrigin:size:frameRate:clockRate:

+ (FMLiveSwitchScreenConfig*) screenConfigWithOrigin: (FMLiveSwitchPoint *)  origin
size: (FMLiveSwitchSize *)  size
frameRate: (double)  frameRate
clockRate: (int)  clockRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
originThe region origin.
sizeThe region size.
frameRateThe frame rate.
clockRateThe clock rate.

◆ screenConfigWithRegion:frameRate:

+ (FMLiveSwitchScreenConfig*) screenConfigWithRegion: (FMLiveSwitchRectangle *)  region
frameRate: (double)  frameRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
regionThe region.
frameRateThe frame rate.

◆ screenConfigWithRegion:frameRate:clockRate:

+ (FMLiveSwitchScreenConfig*) screenConfigWithRegion: (FMLiveSwitchRectangle *)  region
frameRate: (double)  frameRate
clockRate: (int)  clockRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
regionThe region.
frameRateThe frame rate.
clockRateThe clock rate.

◆ screenConfigWithX:y:width:height:frameRate:

+ (FMLiveSwitchScreenConfig*) screenConfigWithX: (int)  x
y: (int)  y
width: (int)  width
height: (int)  height
frameRate: (double)  frameRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
xThe region origin X coordinate.
yThe region origin Y coordinate.
widthThe region size width.
heightThe region size height.
frameRateThe frame rate.

◆ screenConfigWithX:y:width:height:frameRate:clockRate:

+ (FMLiveSwitchScreenConfig*) screenConfigWithX: (int)  x
y: (int)  y
width: (int)  width
height: (int)  height
frameRate: (double)  frameRate
clockRate: (int)  clockRate 

Initializes a new instance of the FMLiveSwitchScreenConfig class.

Parameters
xThe region origin X coordinate.
yThe region origin Y coordinate.
widthThe region size width.
heightThe region size height.
frameRateThe frame rate.
clockRateThe clock rate.

◆ setFrameRate:

- (void) setFrameRate: (double)  value

Sets the frame-rate.

◆ setOrigin:

- (void) setOrigin: (FMLiveSwitchPoint *)  value

Sets the region origin.

◆ setRegion:

- (void) setRegion: (FMLiveSwitchRectangle *)  value

Sets the region.

◆ setSize:

- (void) setSize: (FMLiveSwitchSize *)  value

Sets the region size.

◆ size

- (FMLiveSwitchSize*) size

Gets the region size.

◆ width

- (int) width

Gets the region size width.

◆ x

- (int) x

Gets the region origin X coordinate.

◆ y

- (int) y

Gets the region origin Y coordinate.