Rate this page:

SharingCall

Methods

displayName

Copy URL
displayName(): 

string

Returns

  • type:

    string

getCallDuration

Copy URL
getCallDuration(): 

number

Returns

  • type:

    number

getEndpoints

Copy URL
getEndpoints(): 

Endpoint[]

Returns

hangup

Copy URL
hangup(extraHeaders: 

{[id: string]: string}

):

void

Parameters

  • extraHeaders:

    {[id: string]: string}

    Optional

Returns

  • type:

    void

headers

Copy URL
headers(): 

{[id: string]: string}

Returns headers

Returns

  • type:

    {[id: string]: string}

id

Copy URL
id(): 

string

Returns

  • type:

    string

mutePlayback

Copy URL
mutePlayback(): 

void

Mutes the sound

Returns

  • type:

    void

number

Copy URL
number(): 

string

Returns

  • type:

    string

off

Copy URL
off(event: 

CallEvents

,
handler:

Function

):

void

Remove a handler for the specified event. The method is a shorter equivalent for removeEventListener. If a number of events has the same function as a handler, the method can be called multiple times with the same handler argument.

Parameters

Returns

  • type:

    void

on

Copy URL
on(event: 

CallEvents

,
handler:

Function

,
options:

EventListenerOption

):

void

Register a handler for the specified event. The method is a shorter equivalent for addEventListener. One event can have more than one handler; handlers are executed in order of registration. Use the Call.off method to delete a handler.

Parameters

Returns

  • type:

    void

sendInfo

Copy URL
sendInfo(mimeType: 

string

,
body:

string

,
extraHeaders:

{[id: string]: string}

):

void

Send Info (SIP INFO) message inside the callYou can get this message via the Voxengine CallEvents.InfoReceived event in our cloud.

You can get this message in Web SDK on other side via the CallEvents.InfoReceived event; see the similar events for the iOS and Android SDKs.

Parameters

  • mimeType:

    string

    MIME type of the message, e.g. "text/plain", "multipart/mixed" etc.

  • body:

    string

    Message content

  • extraHeaders:

    {[id: string]: string}

    Optional

    Optional headers to be passed with the message

Returns

  • type:

    void

sendMessage

Copy URL
sendMessage(msg: 

string

):

void

Parameters

  • msg:

    string

Returns

  • type:

    void

state

Copy URL
state(): 

CallState

Returns

unmutePlayback

Copy URL
unmutePlayback(): 

void

Unmutes the sound

Returns

  • type:

    void