Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

A XirSys v3 client.

Hierarchy

  • Client

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Client(ident: string, secret: string, channel: string, secure: boolean): Client
  • new Client(ident: string, secret: string, channel: string): Client
  • Initializes a new instance of the fm.icelink.xirsys.v3.client class.

    Parameters

    • ident: string

      The "ident" value.

    • secret: string

      The "secret" value.

    • channel: string

      The "channel" value.

    • secure: boolean

      The "secure" value.

    Returns Client

  • Initializes a new instance of the fm.icelink.xirsys.v3.client class.

    Parameters

    • ident: string

      The "ident" value.

    • secret: string

      The "secret" value.

    • channel: string

      The "channel" value.

    Returns Client

Properties

Private _channel

_channel: string
internal

Private _endpoint

_endpoint: string
internal

Private _ident

_ident: string
internal

Private _secret

_secret: string
internal

Private _secure

_secure: boolean
internal

Static Private __fmicelinkxirsysv3ClientInitialized

__fmicelinkxirsysv3ClientInitialized: boolean = false
internal

Static Private fm_icelink_xirsys_v3_Client___defaultEndpoint

fm_icelink_xirsys_v3_Client___defaultEndpoint: string
internal

Methods

Private doGetIceServers

  • doGetIceServers(promise: Promise<IceServer[]>): void
  • internal

    Parameters

    • promise: Promise<IceServer[]>

    Returns void

getChannel

  • getChannel(): string
  • Gets the "channel" value.

    Returns string

getEndpoint

  • getEndpoint(): string
  • Gets the HTTP endpoint.

    Returns string

getIceServers

  • getIceServers(): Future<IceServer[]>
  • Gets an array of XirSys ICE servers.

    Returns Future<IceServer[]>

getIdent

  • getIdent(): string
  • Gets the "ident" value.

    Returns string

getSecret

  • getSecret(): string
  • Gets the "secret" value.

    Returns string

getSecure

  • getSecure(): boolean
  • Gets the "secure" value. Defaults to true.

    Returns boolean

getTypeString

  • getTypeString(): string

  • Returns string

setChannel

  • setChannel(value: string): void
  • Sets the "channel" value.

    Parameters

    • value: string

    Returns void

setEndpoint

  • setEndpoint(value: string): void
  • Sets the HTTP endpoint.

    Parameters

    • value: string

    Returns void

setIdent

  • setIdent(value: string): void
  • Sets the "ident" value.

    Parameters

    • value: string

    Returns void

setSecret

  • setSecret(value: string): void
  • Sets the "secret" value.

    Parameters

    • value: string

    Returns void

setSecure

  • setSecure(value: boolean): void
  • Sets the "secure" value. Defaults to true.

    Parameters

    • value: boolean

    Returns void

Static fmicelinkxirsysv3ClientInitialize

  • fmicelinkxirsysv3ClientInitialize(): void
  • internal

    Returns void

Static getDefaultEndpoint

  • getDefaultEndpoint(): string

Static setDefaultEndpoint

  • setDefaultEndpoint(value: string): void
  • Sets the default HTTP endpoint. Defaults to "https://global.xirsys.net/_turn".

    Parameters

    • value: string

    Returns void