Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RTCSession

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

C

  • Returns typeof SessionStatus

causes

  • Returns typeof causes

connection

contact

  • get contact(): string

  • Returns string

data

  • get data(): any
  • set data(_data: any): void

  • Returns any

  • Parameters

    • _data: any

    Returns void

direction

end_time

  • get end_time(): Date

  • Returns Date

id

  • get id(): string

  • Returns string

local_identity

  • Returns NameAddrHeader

remote_identity

  • Returns NameAddrHeader

start_time

  • get start_time(): Date

  • Returns Date

status

  • Returns SessionStatus

Static C

  • Returns typeof SessionStatus

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): RTCSession

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RTCSession

answer

  • Parameters

    Returns void

emit

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

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

hold

  • Parameters

    Returns boolean

isEnded

  • isEnded(): boolean

  • Returns boolean

isEstablished

  • isEstablished(): boolean

  • Returns boolean

isInProgress

  • isInProgress(): boolean

  • Returns boolean

isMuted

isOnHold

  • Returns OnHoldResult

isReadyToReOffer

  • isReadyToReOffer(): boolean

  • Returns boolean

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

mute

  • Parameters

    Returns void

off

  • off(event: string | symbol, listener: (...args: any[]) => void): RTCSession

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RTCSession

on

once

  • once(event: string | symbol, listener: (...args: any[]) => void): RTCSession

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RTCSession

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): RTCSession

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RTCSession

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): RTCSession

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RTCSession

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

refer

  • Parameters

    Returns void

removeAllListeners

  • removeAllListeners(event?: string | symbol): RTCSession

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): RTCSession

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RTCSession

renegotiate

resetLocalMedia

  • resetLocalMedia(): void

  • Returns void

sendDTMF

  • sendDTMF(tones: string | number, options?: DTFMOptions): void

  • Parameters

    Returns void

sendInfo

  • sendInfo(contentType: string, body?: string, options?: ExtraHeaders): void

  • Parameters

    • contentType: string
    • Optional body: string
    • Optional options: ExtraHeaders

    Returns void

setMaxListeners

terminate

  • Parameters

    Returns void

unhold

  • Parameters

    Returns boolean

unmute

  • Parameters

    Returns void

Static listenerCount

Generated using TypeDoc