Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SsrcAttribute

The SDP media attribute "ssrc" indicates a property (known as a "source-level attribute") of a media source (RTP stream) within an RTP session.

Hierarchy

  • Attribute
    • SsrcAttribute

Index

Constructors

Properties

Methods

Constructors

constructor

  • new SsrcAttribute(synchronizationSource: number, attributeName: string): SsrcAttribute
  • new SsrcAttribute(synchronizationSource: number, attributeName: string, attributeValue: string): SsrcAttribute
  • new SsrcAttribute(): SsrcAttribute
  • Initializes a new instance of the fm.icelink.sdp.rtp.ssrcAttribute class.

    Parameters

    • synchronizationSource: number

      The synchronization source.

    • attributeName: string

      Name of the attribute.

    Returns SsrcAttribute

  • Initializes a new instance of the fm.icelink.sdp.rtp.ssrcAttribute class.

    Parameters

    • synchronizationSource: number

      The synchronization source.

    • attributeName: string

      Name of the attribute.

    • attributeValue: string

      The attribute value.

    Returns SsrcAttribute

  • Initializes a new instance of the fm.icelink.sdp.rtp.ssrcAttribute class.
    Initializes a new instance of the fm.icelink.sdp.rtp.ssrcAttribute class.

    Returns SsrcAttribute

Properties

Private _name

_name: string
internal

Private _synchronizationSource

_synchronizationSource: number
internal

Private _value

_value: string
internal

Methods

getAttributeType

  • getAttributeType(): AttributeType
  • Gets this Attribute's Type.

    Returns AttributeType

Protected getAttributeValue

  • getAttributeValue(): string
  • Gets the internal value of the attribute.

    Returns string

getName

  • getName(): string
  • Gets the name of the attribute.

    Returns string

getSynchronizationSource

  • getSynchronizationSource(): number
  • Gets the synchronization source.

    Returns number

getTypeString

  • getTypeString(): string

  • Returns string

getValue

  • getValue(): string
  • Gets the attribute value.

    Returns string

setAttributeType

  • setAttributeType(value: AttributeType): void
  • Sets this Attribute's Type.

    Parameters

    • value: AttributeType

    Returns void

Private setName

  • setName(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

Private setSynchronizationSource

  • setSynchronizationSource(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setValue

  • setValue(value: string): void
  • Sets the attribute value.

    Parameters

    • value: string

    Returns void

toString

  • toString(): string
  • Converts this instance to a string.

    Returns string

Static createAttribute

  • createAttribute(name: string, value: string): Attribute
  • Creates an attribute.

    Parameters

    • name: string

      The name.

    • value: string

      The value.

    Returns Attribute

Static fromAttributeValue

  • fromAttributeValue(value: string): SsrcAttribute
  • Initializes a new instance of the fm.icelink.sdp.rtp.ssrcAttribute class.

    Parameters

    • value: string

      The attribute value.

    Returns SsrcAttribute

Static getTypeName

  • getTypeName(type: Type): string
  • Gets the name of the attribute type.

    Parameters

    • type: Type

      The attribute type.

    Returns string

Static isMediaLevel

  • isMediaLevel(type: Type): boolean
  • Determines whether the type applies to media streams.

    Parameters

    • type: Type

      The type.

    Returns boolean

Static isSessionLevel

  • isSessionLevel(type: Type): boolean
  • Determines whether the type applies to sessions.

    Parameters

    • type: Type

      The type.

    Returns boolean

Static parse

  • parse(s: string): Attribute
  • Creates an fm.icelink.sdp.connectionData instance from a string.

    Parameters

    • s: string

      The string to parse.

    Returns Attribute