Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RemoteCandidatesAttribute

The attribute contains a connection-address and port for each component. The ordering of components is irrelevant. However, a value MUST be present for each component of a media stream. This attribute MUST be included in an offer by a controlling agent for a media stream that is Completed, and MUST NOT be included in any other case.

Hierarchy

  • Attribute
    • RemoteCandidatesAttribute

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the fm.icelink.sdp.ice.remoteCandidatesAttribute class.

    Parameters

    • candidates: RemoteCandidate[]

      The array of remote candidates.

    Returns RemoteCandidatesAttribute

  • Initializes a new instance of the fm.icelink.sdp.ice.remoteCandidatesAttribute class.

    Returns RemoteCandidatesAttribute

Properties

Private _candidates

_candidates: RemoteCandidate[]
internal

Methods

getAttributeType

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

    Returns AttributeType

Protected getAttributeValue

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

    Returns string

getCandidates

  • getCandidates(): RemoteCandidate[]
  • Gets the array of remote candidates.

    Returns RemoteCandidate[]

getTypeString

  • getTypeString(): string

  • Returns string

setAttributeType

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

    Parameters

    • value: AttributeType

    Returns void

Private setCandidates

  • setCandidates(value: RemoteCandidate[]): void
  • internal

    Parameters

    • value: RemoteCandidate[]

    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): RemoteCandidatesAttribute
  • Initializes a new instance of the fm.icelink.sdp.ice.remoteCandidatesAttribute class.

    Parameters

    • value: string

      The attribute value.

    Returns RemoteCandidatesAttribute

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