Search Results for

    / fm / liveswitch / sdp / ice / PasswordAttribute

    Class: PasswordAttribute

    sdp.ice.PasswordAttribute

    The "ice-pwd" attribute conveys the password used by ICE for message integrity.

    Hierarchy

    • Attribute

      ↳ PasswordAttribute

    Table of contents

    Constructors

    • constructor

    Methods

    • getAttributeType
    • getAttributeValue
    • getMultiplexingCategory
    • getPassword
    • getTypeString
    • setAttributeType
    • setMultiplexingCategory
    • toString
    • createAttribute
    • fromAttributeValue
    • generatePassword
    • getTypeName
    • isMediaLevel
    • isSessionLevel
    • parse

    Constructors

    constructor

    + new PasswordAttribute(): PasswordAttribute

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

    Returns: PasswordAttribute

    Inherited from: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/PasswordAttribute.ts:15

    + new PasswordAttribute(password: string): PasswordAttribute

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

    Parameters:

    Name Type Description
    password string The password used by ICE for message integrity.

    Returns: PasswordAttribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/PasswordAttribute.ts:22

    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/PasswordAttribute.ts:92


    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


    getPassword

    ▸ getPassword(): string

    Gets the password used by ICE for message integrity.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/PasswordAttribute.ts:104


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Attribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/PasswordAttribute.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): PasswordAttribute

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

    Parameters:

    Name Type Description
    value string The attribute value.

    Returns: PasswordAttribute

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/PasswordAttribute.ts:68


    generatePassword

    ▸ StaticgeneratePassword(): string

    Generates a random password.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/PasswordAttribute.ts:80


    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