Suggestions

close search

StringeeCall class

Represents a voice, video call. Used to capture an audio-video stream from the device's microphone and camera for use to make or answer a call.


Summary


Constructors
StringeeCall()
Properties

id → String

serial → int

from → String

to → String

fromAlias → String

toAlias → String

isVideoCall → bool

callType → StringeeCallType

customDataFromYourServer → String

eventStreamController → StreamController<dynamic>

Events  

didChangeSignalingState

Invoked when get Signaling state.

didChangeMediaState

Invoked when get Media state.

didReceiveCallInfo

Invoked when get Call info.

didHandleOnAnotherDevice

Invoked when an incoming call is handle on another device.

didReceiveLocalStream

Invoked when get Local stream in video call.

didReceiveRemoteStream

Invoked when get Remote stream in video call.

didChangeAudioDevice

Invoked when change Audio device in android.

Methods

makeCall(Map<dynamic, dynamic> parameters) → result

Make a call.

makeCallFromParams(MakeCallParams params) → result

Make a call.

initAnswer() → result

Initializes an answer.

answer() → result

Answers a call.

hangup() → result

Terminates a call.

reject() → result

Reject a call.

sendDtmf(String dtmf) → result

Sends a DTMF code.

sendCallInfo(Map<dynamic, dynamic> callInfo) → result

Sends any data to other clients.

getCallStats() → result

Get the call's statistics.

mute(bool mute) → result

Toggle audio on or off.

enableVideo(bool enableVideo) → result

Enables or disables the local stream.

setSpeakerphoneOn(bool speakerPhoneOn) → result

Set the audio output mode.

switchCamera(bool isMirror) → result

Switches the device's camera.

resumeVideo() → result

Resume local stream in android.

destroy() → void

Close event stream.

Constructors


StringeeCall()
Create a new StringeeCall.

Properties


id → String
It's the unique identification of the call on Stringee system.
serial → int
When you use the StringeeX API, the call can be routed to the client multiple times. This property indicates the number of times the call is being routed.
from → String
It's the Caller's id.
to → String
It's the Callee's id.
fromAlias → String
It's the Caller's alias.
toAlias → String
It's the Callee's alias.
isVideoCall → bool
Whether the call is a video call:
- true - is video call.
- false - is not video call.
callType → StringeeCallType
It's type of call : StringeeCallType.
customDataFromYourServer → String
It's custom data received from other user.
eventStreamController → StreamController<dynamic>
It's controller of event stream which was sended from plugin.

Events


didChangeSignalingState
Invoked when get Signaling state.
Receive StringeeSignalingState from event['body'].
didChangeMediaState
Invoked when get Media state.
Receive StringeeMediaState from event['body'].
didReceiveCallInfo
Invoked when get Call info.
Receive from event['body']:
- callId: call's id.
- info: call info sended by other user.
didHandleOnAnotherDevice
Invoked when an incoming call is handle on another device.
Receive StringeeSignalingState from event['body'].
didReceiveLocalStream
Invoked when get Local stream in video call.
Receive callId from event['body'].
didReceiveRemoteStream
Invoked when get Remote stream in video call.
Receive callId from event['body'].
didChangeAudioDevice
Invoked when change Audio device in android.
Receive from event['body']:
- selectedAudioDevice: AudioDevice.
- availableAudioDevices: List<AudioDevice>.

Methods


makeCall(Map<dynamic, dynamic> parameters) → result
Using custom parameters to make a call.
makeCallFromParams(MakeCallParams params) → result
Using MakeCallParams to make a call.
initAnswer() → result
Initializes an answer. Must be called before answering a call.
answer() → result
Answers a call.
hangup() → result
Terminates a call.
reject() → result
Reject a call.
sendDtmf(String dtmf) → result
Sends a DTMF code.
sendCallInfo(Map<dynamic, dynamic>) → result
Sends any data to other clients.
getCallStats() → result
Get the call's statistics.
If success return in result['body']:
- bytesReceived: bytes received in timeStamp.
- packetsLost: number of packets lost in timeStamp.
- packetsReceived: number of packets received in timeStamp.
- timeStamp: current time.
mute(bool mute) → result
Toggle audio on or off.
enableVideo(bool enableVideo) → result
Enables or disables the local stream.
setSpeakerphoneOn(bool speakerPhoneOn) → result
Set the audio output mode. If you want to use the device loudspeaker for playing audio, call the setSpeakerphoneOn(true) method. Otherwise, call the setSpeakerphoneOn(false) method to use headset speaker for playing audio.
switchCamera(bool isMirror) → result
Switches the device's camera. By defalt, Stringee SDK uses the front camera.
Field isMirror is only available in android for set video capture from camera is like a mirror or not.
resumeVideo() → result
This method only available in android.
When lost local stream then call resumeVideo to resume local stream in android.
destroy() → void
Close event stream.