Search Results for

    / fm / liveswitch / sdp / ice / FingerprintAttribute

    Class: FingerprintAttribute

    sdp.ice.FingerprintAttribute

    The SDP session attribute "fingerprint" provides an encryption certificate fingerprint to a remote peer for use with DTLS.

    Hierarchy

    • Attribute

      ↳ FingerprintAttribute

    Table of contents

    Constructors

    • constructor

    Methods

    • getAttributeType
    • getAttributeValue
    • getFingerprint
    • getHashFunction
    • getMultiplexingCategory
    • getTypeString
    • setAttributeType
    • setMultiplexingCategory
    • toString
    • createAttribute
    • fromAttributeValue
    • getTypeName
    • isMediaLevel
    • isSessionLevel
    • parse

    Constructors

    constructor

    + new FingerprintAttribute(): FingerprintAttribute

    Returns: FingerprintAttribute

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/FingerprintAttribute.ts:17

    + new FingerprintAttribute(hashFunction: string, fingerprint: string): FingerprintAttribute

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

    Parameters:

    Name Type Description
    hashFunction string The hash function.
    fingerprint string The fingerprint.

    Returns: FingerprintAttribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/FingerprintAttribute.ts:19

    Methods

    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 value of the attribute.

    Returns: string

    Overrides: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/FingerprintAttribute.ts:85


    getFingerprint

    ▸ getFingerprint(): string

    Gets the fingerprint.

    Returns: string

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


    getHashFunction

    ▸ getHashFunction(): string

    Gets the hash function (i.e. sha-256).

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/FingerprintAttribute.ts:113


    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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/FingerprintAttribute.ts:11


    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): FingerprintAttribute

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

    Parameters:

    Name Type Description
    value string The attribute as a string.

    Returns: FingerprintAttribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/FingerprintAttribute.ts:66


    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