Search Results for

    / fm / liveswitch / sdp / rtcp / Attribute

    Class: Attribute

    sdp.rtcp.Attribute

    The RTCP attribute is used to document the RTCP port used for media stream, when that port is not the next higher (odd) port number following the RTP port described in the media line.

    Hierarchy

    • Attribute

      ↳ Attribute

    Table of contents

    Constructors

    • constructor

    Methods

    • fmliveswitchsdprtcpAttributeInit
    • getAddressType
    • getAttributeType
    • getAttributeValue
    • getConnectionAddress
    • getMultiplexingCategory
    • getNetworkType
    • getPort
    • getTypeString
    • setAddressType
    • setAttributeType
    • setConnectionAddress
    • setMultiplexingCategory
    • setNetworkType
    • setPort
    • toString
    • update
    • createAttribute
    • fromAttributeValue
    • getTypeName
    • isMediaLevel
    • isSessionLevel
    • parse

    Constructors

    constructor

    + new Attribute(): Attribute

    Returns: Attribute

    Inherited from: Attribute

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

    + new Attribute(port: number, connectionAddress: string): Attribute

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

    Parameters:

    Name Type Description
    port number The RTCP port number.
    connectionAddress string The RTCP connection address.

    Returns: Attribute

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

    Methods

    fmliveswitchsdprtcpAttributeInit

    ▸ PrivatefmliveswitchsdprtcpAttributeInit(): void

    Returns: void

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


    getAddressType

    ▸ getAddressType(): string

    Gets the type of the address. See [[fm.liveswitch.sdp.rtcp.attribute.addressType]] for possible values.

    Returns: string

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


    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/rtcp/Attribute.ts:119


    getConnectionAddress

    ▸ getConnectionAddress(): string

    Gets the RTCP connection address.

    Returns: string

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


    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


    getNetworkType

    ▸ getNetworkType(): string

    Gets the type of network. See [[fm.liveswitch.sdp.rtcp.attribute.networkType]] for possible values.

    Returns: string

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


    getPort

    ▸ getPort(): number

    Gets the RTCP port number.

    Returns: number

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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Attribute

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


    setAddressType

    ▸ setAddressType(value: string): void

    Sets the type of the address. See [[fm.liveswitch.sdp.rtcp.attribute.addressType]] for possible values.

    Parameters:

    Name Type
    value string

    Returns: void

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


    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


    setConnectionAddress

    ▸ setConnectionAddress(value: string): void

    Sets the RTCP connection address.

    Parameters:

    Name Type
    value string

    Returns: void

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


    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


    setNetworkType

    ▸ setNetworkType(value: string): void

    Sets the type of network. See [[fm.liveswitch.sdp.rtcp.attribute.networkType]] for possible values.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setPort

    ▸ setPort(value: number): void

    Sets the RTCP port number.

    Parameters:

    Name Type
    value number

    Returns: void

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


    toString

    ▸ toString(): string

    Converts this instance to a string.

    Returns: string

    Inherited from: Attribute

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


    update

    ▸ update(port: number, connectionAddress: string): void

    Updates the port and connection address.

    Parameters:

    Name Type Description
    port number The port.
    connectionAddress string The connection address.

    Returns: void

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


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

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

    Parameters:

    Name Type Description
    value string The attribute value.

    Returns: Attribute

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


    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