Class Call

see: Call

Hierarchy

EventEmitter
- Call

Index

Properties

Properties

connDuration

connDuration: number

Call connected duration in seconds (zero when call is not established).

hasMedia

hasMedia: boolean

True if the Call has active media.

isActive

isActive: boolean

True if the call has an active INVITE session and the INVITE session has not been disconnected.

totalDuration

totalDuration: number

Total call duration in seconds, including set-up time.

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

answer

answer(statusCode?: number, reason?: string): void

- Defined in Sipster.ts:89
For incoming calls, this responds to the INVITE with an optional statusCode (defaults to 200) and optional reason phrase.

Parameters
- Optional statusCode: number
- Optional reason: string
Returns void

dtmf

dtmf(digits: string): void

- Defined in Sipster.ts:107
Sends DTMF digits to the remote end using the RFC 2833 payload format.

Parameters
- digits: string
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
Returns number

getStatsDump

getStatsDump(inclMediaStats?: boolean, indent?: string): string

- Defined in Sipster.ts:114
Returns formatted statistics about the call. If inclMediaStats is true, then statistics about the Call's media is included (default is true). indent is the string to use for indenting (default is two spaces).

Parameters
- Optional inclMediaStats: boolean
- Optional indent: string
Returns string

hangup

hangup(statusCode?: number, reason?: string): void

- Defined in Sipster.ts:97
Hangs up the call with an optional statusCode (defaults to 603) and optional reason phrase. This function is different than answering the call with 3xx-6xx response (with answer()), in that this function will hangup the call regardless of the state and role of the call, while answer() only works with incoming calls on EARLY state.

Parameters
- Optional statusCode: number
- Optional reason: string
Returns void

hold

hold(): void

- Defined in Sipster.ts:99
Puts the call on hold.

Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
Parameters
- event: string | symbol
Returns Function[]

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

ref

ref(): void

- Defined in Sipster.ts:84
Attaches the Call to the event loop.

Returns void

reinvite

reinvite(): void

- Defined in Sipster.ts:101
Releases a hold.

Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
Parameters
- n: number
Returns this

transfer

transfer(destination: string): void

- Defined in Sipster.ts:105
Transfers the call to destination.

Parameters
- destination: string
Returns void

unref

unref(): void

- Defined in Sipster.ts:82
Detaches the Call from the event loop (default).

Returns void

update

update(): void

- Defined in Sipster.ts:103
Sends an UPDATE request.

Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc