Search Results for

    / fm / liveswitch / ScreenConfig

    Class: ScreenConfig

    fm.liveswitch.ScreenConfig

    A screen configuration.

    Hierarchy

    • MediaConfig<ScreenConfig>

      ↳ ScreenConfig

    Table of contents

    Constructors

    • constructor

    Methods

    • fmliveswitchScreenConfigInit
    • getClockRate
    • getFrameRate
    • getHeight
    • getOrigin
    • getRegion
    • getSize
    • getTypeString
    • getWidth
    • getX
    • getY
    • isEquivalent
    • setFrameRate
    • setOrigin
    • setRegion
    • setSize
    • toString

    Constructors

    constructor

    + new ScreenConfig(origin: Point, size: Size, frameRate: number): ScreenConfig

    Initializes a new instance of the [[fm.liveswitch.screenConfig]] class.

    Parameters:

    Name Type Description
    origin Point The region origin.
    size Size The region size.
    frameRate number The frame rate.

    Returns: ScreenConfig

    Inherited from: MediaConfig

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:21

    + new ScreenConfig(origin: Point, size: Size, frameRate: number, clockRate: number): ScreenConfig

    Initializes a new instance of the [[fm.liveswitch.screenConfig]] class.

    Parameters:

    Name Type Description
    origin Point The region origin.
    size Size The region size.
    frameRate number The frame rate.
    clockRate number The clock rate.

    Returns: ScreenConfig

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:30

    + new ScreenConfig(region: Rectangle, frameRate: number): ScreenConfig

    Initializes a new instance of the [[fm.liveswitch.screenConfig]] class.

    Parameters:

    Name Type Description
    region Rectangle The region.
    frameRate number The frame rate.

    Returns: ScreenConfig

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:40

    + new ScreenConfig(region: Rectangle, frameRate: number, clockRate: number): ScreenConfig

    Initializes a new instance of the [[fm.liveswitch.screenConfig]] class.

    Parameters:

    Name Type Description
    region Rectangle The region.
    frameRate number The frame rate.
    clockRate number The clock rate.

    Returns: ScreenConfig

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:48

    + new ScreenConfig(x: number, y: number, width: number, height: number, frameRate: number): ScreenConfig

    Initializes a new instance of the [[fm.liveswitch.screenConfig]] class.

    Parameters:

    Name Type Description
    x number The region origin X coordinate.
    y number The region origin Y coordinate.
    width number The region size width.
    height number The region size height.
    frameRate number The frame rate.

    Returns: ScreenConfig

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:57

    + new ScreenConfig(x: number, y: number, width: number, height: number, frameRate: number, clockRate: number): ScreenConfig

    Initializes a new instance of the [[fm.liveswitch.screenConfig]] class.

    Parameters:

    Name Type Description
    x number The region origin X coordinate.
    y number The region origin Y coordinate.
    width number The region size width.
    height number The region size height.
    frameRate number The frame rate.
    clockRate number The clock rate.

    Returns: ScreenConfig

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:68

    Methods

    fmliveswitchScreenConfigInit

    ▸ PrivatefmliveswitchScreenConfigInit(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:18


    getClockRate

    ▸ getClockRate(): number

    Gets the clock rate.

    Returns: number

    Inherited from: MediaConfig

    Defined in: Generated/TypeScript/fm.liveswitch/MediaConfig.ts:44


    getFrameRate

    ▸ getFrameRate(): number

    Gets the frame-rate.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:236


    getHeight

    ▸ getHeight(): number

    Gets the region size height.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:248


    getOrigin

    ▸ getOrigin(): Point

    Gets the region origin.

    Returns: Point

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:260


    getRegion

    ▸ getRegion(): Rectangle

    Gets the region.

    Returns: Rectangle

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:272


    getSize

    ▸ getSize(): Size

    Gets the region size.

    Returns: Size

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:284


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: MediaConfig

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:10


    getWidth

    ▸ getWidth(): number

    Gets the region size width.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:296


    getX

    ▸ getX(): number

    Gets the region origin X coordinate.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:308


    getY

    ▸ getY(): number

    Gets the region origin Y coordinate.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:320


    isEquivalent

    ▸ isEquivalent(config: ScreenConfig): boolean

    Determines whether the specified configuration is equivalent.

    Parameters:

    Name Type Description
    config ScreenConfig The configuration.

    Returns: boolean

    Overrides: MediaConfig

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:333


    setFrameRate

    ▸ setFrameRate(value: number): void

    Sets the frame-rate.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:348


    setOrigin

    ▸ setOrigin(value: Point): void

    Sets the region origin.

    Parameters:

    Name Type
    value Point

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:363


    setRegion

    ▸ setRegion(value: Rectangle): void

    Sets the region.

    Parameters:

    Name Type
    value Rectangle

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:375


    setSize

    ▸ setSize(value: Size): void

    Sets the region size.

    Parameters:

    Name Type
    value Size

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:390


    toString

    ▸ toString(): string

    Returns a string that represents this instance.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/ScreenConfig.ts:402

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.14.6