Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CandidateAttribute

The candidate attribute is a media-level attribute only. It contains a transport address for a candidate that can be used for connectivity checks.

Hierarchy

  • Attribute
    • CandidateAttribute

Index

Constructors

Properties

Methods

Constructors

constructor

  • new CandidateAttribute(): CandidateAttribute
  • new CandidateAttribute(foundation: string, priority: number, connectionAddress: string, port: number, candidateType: string, componentId: number): CandidateAttribute
  • new CandidateAttribute(foundation: string, priority: number, connectionAddress: string, port: number, candidateType: string, relatedAddress: string, relatedPort: number, protocol: string, componentId: number): CandidateAttribute
  • Initializes a new instance of the fm.icelink.sdp.ice.candidateAttribute class.
    Initializes a new instance of the fm.icelink.sdp.ice.candidateAttribute class.

    Returns CandidateAttribute

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

    Parameters

    • foundation: string

      The candidate's foundation.

    • priority: number

      The priority of the candidate.

    • connectionAddress: string

      The IP address of the candidate.

    • port: number

      The port of the candidate.

    • candidateType: string

      The type of the candidate. See fm.icelink.sdp.ice.candidateAttribute.candidateType for possible values.

    • componentId: number

      The component identifier.

    Returns CandidateAttribute

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

    Parameters

    • foundation: string

      The candidate's foundation.

    • priority: number

      The priority of the candidate.

    • connectionAddress: string

      The IP address of the candidate.

    • port: number

      The port of the candidate.

    • candidateType: string

      The type of the candidate. See fm.icelink.sdp.ice.candidateAttribute.candidateType for possible values.

    • relatedAddress: string

      The IP address related to the candidate.

    • relatedPort: number

      The port related to the candidate.

    • protocol: string

      The protocol.

    • componentId: number

      The component identifier.

    Returns CandidateAttribute

Properties

Private __candidateType

__candidateType: string
internal

Private __connectionAddress

__connectionAddress: string
internal

Private __foundation

__foundation: string
internal

Private _componentId

_componentId: number
internal

Private _extensions

_extensions: Hash<string, string>
internal

Private _port

_port: number
internal

Private _priority

_priority: number
internal

Private _protocol

_protocol: string
internal

Private _relatedAddress

_relatedAddress: string
internal

Private _relatedPort

_relatedPort: number
internal

Methods

getAttributeType

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

    Returns AttributeType

Protected getAttributeValue

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

    Returns string

getCandidateType

  • getCandidateType(): string
  • Gets the type of the candidate. See fm.icelink.sdp.ice.candidateAttribute.candidateType for possible values.

    Returns string

getComponentId

  • getComponentId(): number
  • Gets the ID of the component for which this is a candidate.

    Returns number

getConnectionAddress

  • getConnectionAddress(): string
  • Gets the IP address of the candidate.

    Returns string

getExtensions

  • getExtensions(): Hash<string, string>
  • Gets the extensions.

    Returns Hash<string, string>

getFoundation

  • getFoundation(): string
  • Gets the candidate's foundation.

    Returns string

getPort

  • getPort(): number
  • Gets the port of the candidate.

    Returns number

getPriority

  • getPriority(): number
  • Gets the priority of the candidate.

    Returns number

getProtocol

  • getProtocol(): string
  • Gets the protocol of this candidate.

    Returns string

getRelatedAddress

  • getRelatedAddress(): string
  • Gets the IP address related to the candidate.

    Returns string

getRelatedPort

  • getRelatedPort(): number
  • Gets the port related to the candidate.

    Returns number

getTypeString

  • getTypeString(): string

  • Returns string

setAttributeType

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

    Parameters

    • value: AttributeType

    Returns void

setCandidateType

  • setCandidateType(value: string): void
  • Sets the type of the candidate. See fm.icelink.sdp.ice.candidateAttribute.candidateType for possible values.

    Parameters

    • value: string

    Returns void

setComponentId

  • setComponentId(value: number): void
  • Sets the ID of the component for which this is a candidate.

    Parameters

    • value: number

    Returns void

setConnectionAddress

  • setConnectionAddress(value: string): void
  • Sets the IP address of the candidate.

    Parameters

    • value: string

    Returns void

Private setExtensions

  • setExtensions(value: Hash<string, string>): void
  • internal

    Parameters

    • value: Hash<string, string>

    Returns void

setFoundation

  • setFoundation(value: string): void
  • Sets the candidate's foundation.

    Parameters

    • value: string

    Returns void

setPort

  • setPort(value: number): void
  • Sets the port of the candidate.

    Parameters

    • value: number

    Returns void

setPriority

  • setPriority(value: number): void
  • Sets the priority of the candidate.

    Parameters

    • value: number

    Returns void

setProtocol

  • setProtocol(value: string): void
  • Sets the protocol of this candidate.

    Parameters

    • value: string

    Returns void

setRelatedAddress

  • setRelatedAddress(value: string): void
  • Sets the IP address related to the candidate.

    Parameters

    • value: string

    Returns void

setRelatedPort

  • setRelatedPort(value: number): void
  • Sets the port related to the candidate.

    Parameters

    • value: number

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

    Parameters

    • value: string

      The attribute as a string.

    Returns CandidateAttribute

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