ViewerCall
Methods
displayName
displayName(): string
Returns
type:
string
getCallDuration
getCallDuration(): number
Returns
type:
number
hangup
hangup(extraHeaders: {[id: string]: string}
): void
Parameters
extraHeaders:
{[id: string]: string}
Optional
Returns
type:
void
headers
headers(): {[id: string]: string}
Returns headers
Returns
type:
{[id: string]: string}
id
id(): string
Returns
type:
string
mutePlayback
mutePlayback(): void
Mutes the sound from all participants
Returns
type:
void
number
number(): string
Returns
type:
string
off
off(event: , 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
event:
Event name (i.e. CallEvents.Connected). See CallEvents.
handler:
Function
OptionalHandler function, if not specified all event handlers for the specified event are removed
Returns
type:
void
on
on(event: , 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
event:
Event name (i.e. CallEvents.Connected. See CallEvents.
handler:
Function
Handler function. A single parameter is passed - object with event information
options:
EventListenerOption
Optional
Returns
type:
void
sendInfo
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}
OptionalOptional headers to be passed with the message
Returns
type:
void
sendMessage
sendMessage(msg: string
): void
Parameters
msg:
string
Returns
type:
void
unmutePlayback
unmutePlayback(): void
Unmutes the sound from all participants
Returns
type:
void