Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IceServer

An ICE server.

Hierarchy

  • IceServer

Index

Constructors

Properties

Methods

Constructors

constructor

  • new IceServer(url: string): IceServer
  • new IceServer(url: string, username: string, password: string): IceServer
  • new IceServer(): IceServer
  • Initializes a new instance of the fm.icelink.iceServer class.

    Parameters

    • url: string

      The URL.

    Returns IceServer

  • Initializes a new instance of the fm.icelink.iceServer class.

    Parameters

    • url: string

      The URL.

    • username: string

      The username.

    • password: string

      The password.

    Returns IceServer

  • Initializes a new instance of the fm.icelink.iceServer class.
    Initializes a new instance of the fm.icelink.iceServer class.

    Returns IceServer

Properties

Private __ipAddress

__ipAddress: string
internal

Private __ipAddresses

__ipAddresses: string[]
internal

Private _password

_password: string
internal

Private _url

_url: string
internal

Private _username

_username: string
internal

Methods

getHost

  • getHost(): string
  • Gets the host.

    Returns string

getIPAddress

  • getIPAddress(): string
  • internal

    Returns string

getIPAddresses

  • getIPAddresses(): string[]
  • internal

    Returns string[]

getIsSecure

  • getIsSecure(): boolean
  • Gets a value indicating whether this represents a secure STUN or TURN server.

    Returns boolean

getIsStun

  • getIsStun(): boolean
  • Gets a value indicating whether this represents a STUN server.

    Returns boolean

getIsTcp

  • getIsTcp(): boolean
  • Gets a value indicating whether this represents a TCP server.

    Returns boolean

getIsTurn

  • getIsTurn(): boolean
  • Gets a value indicating whether this represents a TURN server.

    Returns boolean

getIsUdp

  • getIsUdp(): boolean
  • Gets a value indicating whether this represents a UDP server.

    Returns boolean

getPassword

  • getPassword(): string
  • Gets the password.

    Returns string

getPort

  • getPort(): number
  • Gets the port.

    Returns number

getTypeString

  • getTypeString(): string

  • Returns string

getUrl

  • getUrl(): string
  • Gets the URL.

    Returns string

getUsername

  • getUsername(): string
  • Gets the username.

    Returns string

setIPAddress

  • setIPAddress(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setIPAddresses

  • setIPAddresses(value: string[]): void
  • internal

    Parameters

    • value: string[]

    Returns void

Private setPassword

  • setPassword(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

Private setUrl

  • setUrl(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

Private setUsername

  • setUsername(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

toJson

  • toJson(): string
  • Serializes this instance to JSON.

    Returns string

    The serialized JSON.

Static fromJson

  • fromJson(iceServerJson: string): IceServer
  • Deserializes an instance from JSON.

    Parameters

    • iceServerJson: string

      The JSON to deserialize.

    Returns IceServer

    The deserialized ICE server.

Static fromJsonArray

  • fromJsonArray(iceServersJson: string): IceServer[]
  • Deserializes an array of instances from JSON.

    Parameters

    • iceServersJson: string

      The JSON to deserialize.

    Returns IceServer[]

    The deserialized ICE server array.

Static getDefaultPort

  • getDefaultPort(): number
  • Gets the default port.

    Returns number

Static Private parseAddress

  • parseAddress(address: string, host: Holder<string>, port: Holder<number>): boolean
  • internal

    Parameters

    • address: string
    • host: Holder<string>
    • port: Holder<number>

    Returns boolean

Static Private parsePort

  • parsePort(portString: string): number
  • internal

    Parameters

    • portString: string

    Returns number

Static toJson

  • toJson(iceServer: IceServer): string
  • Serializes an instance to JSON.

    Parameters

    • iceServer: IceServer

      The ICE server.

    Returns string

    The serialized JSON.

Static toJsonArray

  • toJsonArray(iceServers: IceServer[]): string
  • Serializes an array of instances to JSON.

    Parameters

    • iceServers: IceServer[]

      The ICE servers.

    Returns string

    The serialized JSON.