Search Results for

    / fm / liveswitch / sdp / QualityAttribute

    Class: QualityAttribute

    liveswitch.sdp.QualityAttribute

    This gives a suggestion for the quality of the encoding as an integer value. The intention of the quality attribute for video is to specify a non-default trade-off between frame-rate and still-image quality. For video, the value is in the range 0 to 10, with the following suggested meaning:

    10 - the best still-image quality the compression scheme can give. 5 - the default behaviour given no quality suggestion. 0 - the worst still-image quality the codec designer thinks is still usable.

    It is a media-level attribute, and it is not dependent on charset.

    Hierarchy

    • Attribute

      ↳ QualityAttribute

    Table of contents

    Constructors

    • constructor

    Methods

    • fmliveswitchsdpQualityAttributeInit
    • getAttributeType
    • getAttributeValue
    • getMultiplexingCategory
    • getQuality
    • getTypeString
    • setAttributeType
    • setMultiplexingCategory
    • toString
    • createAttribute
    • fromAttributeValue
    • getTypeName
    • isMediaLevel
    • isSessionLevel
    • parse

    Constructors

    constructor

    + new QualityAttribute(): QualityAttribute

    Returns: QualityAttribute

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/QualityAttribute.ts:32

    + new QualityAttribute(quality: number): QualityAttribute

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

    Parameters:

    Name Type Description
    quality number The suggested quality of the encoding as an integer value from 0-10.

    Returns: QualityAttribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/QualityAttribute.ts:33

    Methods

    fmliveswitchsdpQualityAttributeInit

    ▸ PrivatefmliveswitchsdpQualityAttributeInit(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/QualityAttribute.ts:29


    getAttributeType

    ▸ getAttributeType(): AttributeType

    Gets this Attribute's Type.

    Returns: AttributeType

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:582


    getAttributeValue

    ▸ ProtectedgetAttributeValue(): string

    Gets the internal value of the attribute.

    Returns: string

    Overrides: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/QualityAttribute.ts:89


    getMultiplexingCategory

    ▸ getMultiplexingCategory(): AttributeCategory

    Gets the Multiplexing Category of this Attribute.

    Returns: AttributeCategory

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:600


    getQuality

    ▸ getQuality(): number

    Gets the suggested quality of the encoding as an integer value from 0-10.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/QualityAttribute.ts:101


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/QualityAttribute.ts:23


    setAttributeType

    ▸ setAttributeType(value: AttributeType): void

    Sets this Attribute's Type.

    Parameters:

    Name Type
    value AttributeType

    Returns: void

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:612


    setMultiplexingCategory

    ▸ ProtectedsetMultiplexingCategory(value: AttributeCategory): void

    Sets the Multiplexing Category of this Attribute.

    Parameters:

    Name Type
    value AttributeCategory

    Returns: void

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:624


    toString

    ▸ toString(): string

    Converts this instance to a string.

    Returns: string

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:636


    createAttribute

    ▸ StaticcreateAttribute(name: string, value: string): Attribute

    Creates an attribute.

    Parameters:

    Name Type Description
    name string The name.
    value string The value.

    Returns: Attribute

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:42


    fromAttributeValue

    ▸ StaticfromAttributeValue(value: string): QualityAttribute

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

    Parameters:

    Name Type Description
    value string The attribute value.

    Returns: QualityAttribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/QualityAttribute.ts:75


    getTypeName

    ▸ StaticgetTypeName(type: Type): string

    Gets the name of the attribute type.

    Parameters:

    Name Type Description
    type Type The attribute type.

    Returns: string

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:467


    isMediaLevel

    ▸ StaticisMediaLevel(type: Type): boolean

    Determines whether the type applies to media streams.

    Parameters:

    Name Type Description
    type Type The type.

    Returns: boolean

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:492


    isSessionLevel

    ▸ StaticisSessionLevel(type: Type): boolean

    Determines whether the type applies to sessions.

    Parameters:

    Name Type Description
    type Type The type.

    Returns: boolean

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:516


    parse

    ▸ Staticparse(s: string): Attribute

    Creates an [[fm.liveswitch.sdp.connectionData]] instance from a string.

    Parameters:

    Name Type Description
    s string The string to parse.

    Returns: Attribute

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:540

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