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.
| Constructors |
|---|
| StringeeCall(StringeeClient client) |
| Properties |
|---|
| Events | |
|---|---|
|
Invoked when get Signaling state. |
|
|
Invoked when get Media state. |
|
|
Invoked when get Call info. |
|
|
Invoked when an incoming call is handled on another device. |
|
|
Invoked when get Local stream in video call. |
|
|
Invoked when get Remote stream in video call. |
| Methods |
|---|
|
makeCall(Map<dynamic, dynamic> parameters) → result Make a call. |
|
makeCallFromParams(MakeCallParams params) → result Make a call. |
|
Initializes an answer. |
|
Answers a call. |
|
Terminates a call. |
|
Reject a call. |
|
sendDtmf(String dtmf) → result Send a DTMF code. |
|
sendCallInfo(Map<dynamic, dynamic> callInfo) → result Send any data to other clients. |
|
Get the call's statistics. |
|
Toggle audio on or off. |
|
enableVideo(bool enableVideo) → result Enables or disables the local stream. |
|
Switches the device's camera. |
|
setMirror(bool isLocal, bool isMirror) → result Set stream like a mirror in android. |
|
Resume local stream in android. |
|
Close event stream. |
| StringeeCall(StringeeClient client) |
|---|
| Create a new StringeeCall with StringeeClient. |
| 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 a type of call: StringeeCallType. |
| customDataFromYourServer → String |
|---|
| It's custom data received from another user. |
| eventStreamController → StreamController<dynamic> |
|---|
| It's a controller of event stream which was sent from the plugin. |
| 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 sent by another user. |
| didHandleOnAnotherDevice |
|---|
| Invoked when an incoming call is handled 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']. |
| 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 |
|---|
| Send a DTMF code. |
| sendCallInfo(Map<dynamic, dynamic>) → result |
|---|
| Send any data to other clients. |
| getCallStats() → result |
|---|
| Get the call's statistics. If success, call's statistics are returned in result['stats']: - 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. |
| switchCamera() → result |
|---|
| Switches the device's camera. By default, Stringee SDK uses the front camera. |
| setMirror(bool isLocal, bool isMirror) → result |
|---|
| This method is only available on android. Set stream like a mirror in android. |
| resumeVideo() → result |
|---|
| This method is only available on android. When lost local stream, then call resumeVideo to resume local stream in android. |
| destroy() → void |
|---|
| Close event stream. |
