Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RemoteCandidate

An SDP remote candidate element.

Hierarchy

  • RemoteCandidate

Index

Constructors

Properties

Methods

Constructors

constructor

  • new RemoteCandidate(componentId: number, connectionAddress: string, port: number): RemoteCandidate
  • Initializes a new instance of the fm.icelink.sdp.ice.remoteCandidate class.

    Parameters

    • componentId: number

      The ID of the component for which this is a remote candidate.

    • connectionAddress: string

      The IP address of the remote candidate.

    • port: number

      The port of the remote candidate.

    Returns RemoteCandidate

Properties

Private _componentId

_componentId: number
internal

Private _connectionAddress

_connectionAddress: string
internal

Private _port

_port: number
internal

Methods

getComponentId

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

    Returns number

getConnectionAddress

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

    Returns string

getPort

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

    Returns number

getTypeString

  • getTypeString(): string

  • Returns string

Private setComponentId

  • setComponentId(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

Private setConnectionAddress

  • setConnectionAddress(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

Private setPort

  • setPort(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

toString

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

    Returns string

Static parse

  • parse(s: string): RemoteCandidate
  • Creates an fm.icelink.sdp.ice.remoteCandidate instance from a string.

    Parameters

    • s: string

      The string to parse.

    Returns RemoteCandidate