Constructor
new VoiceCall(api, callReq)
- Description:
Create a VoiceCall
Parameters:
| Name | Type | Description |
|---|---|---|
api |
Api | api instance |
callReq |
CallRequest | call request information |
Fires:
- VoiceCall#event:callConnected
- VoiceCall#event:callCompleted
- VoiceCall#event:interlocutorInfo
- VoiceCall#event:localAudioShared
- VoiceCall#event:remoteAudioShared
- VoiceCall#event:localAudioUnshared
- VoiceCall#event:remoteAudioUnshared
- VoiceCall#event:localAudioEnabled
- VoiceCall#event:remoteAudioEnabled
- VoiceCall#event:localAudioDisabled
- VoiceCall#event:remoteAudioDisabled
Extends
Members
type
- Description:
Returns the type of this object
- Overrides:
Returns the type of this object
Methods
(protected) _callCompleted()
- Description:
Officially completes the call. This should be called by all derived classes
- Overrides:
(protected) _callConnected()
- Description:
Officially starts the call when the interpreter has joined and begins process of obtaining interlocutor info. This should be called by all derived classes
- Overrides:
disableAudio()
- Description:
Disables audio. Essentially a mute.
- Overrides:
enableAudio(enableopt)
- Description:
Enables/disables audio. Essentially mute/unmute. With no param true is assumed, but boolean can be used to perform mute
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
enable |
boolean |
<optional> |
true
|
getInterlocutorInfo() → {InterlocutorInfo}
- Description:
Used for retrieving interlocutor info after event has already been fired. Will return null if information is not yet ready
- Overrides:
Returns:
details on call participant
- Type
- InterlocutorInfo
hangup() → {Promise.<boolean>}
- Description:
Overrides base class hangup to provide some additional VoiceCall cleanup
- Overrides:
Returns:
- Type
- Promise.<boolean>
isVideo() → {boolean}
- Description:
Returns true if this is a video call, false otherwise
- Overrides:
Returns:
- Type
- boolean
isVoice() → {boolean}
- Description:
Returns true if this is a voice call, false otherwise
- Overrides:
Returns:
- Type
- boolean
start() → {Promise}
- Description:
Calls start from the super class, but then performs the voice specific start.
- Overrides:
Returns:
- Type
- Promise