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.

StringeeCall(props: StringeeCallOptions)

Create a new StringeeCall.

stringeeClient: StringeeClient

The connected StringeeClient that owns the call.

from: string

The caller user identifier or phone number.

to: string

The callee user identifier or phone number.

uuid?: string

An existing native wrapper identifier. This property is reserved for incoming calls created by the SDK.

callId: string

It's the unique identifier of the call on Stringee system.

serial: number

This property is only available on Ios. 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 identifier.

fromAlias: string

It's the Caller's alias.

to: string

It's the Callee's identifier.

toAlias: string

It's the Callee's alias.

callType: CallType

It's type of call

isVideoCall: boolean

Whether the call is a video call:

• true: is a video call.
• false: is not a video call.

customData: string

It's custom data received from other user.

videoResolution: VideoResolution

It's resolution of local stream.

uuid: string

It's the unique identifier of the call.

canAnswer: boolean

Whether this incoming call can be answered.

setListener(stringeeCallListener?: StringeeCallListener | null): void

Set, replace, or clear the listener for StringeeCall.

unregisterEvents(): void

Unregister all native event subscriptions owned by this StringeeCall.

makeCall(): Promise<void>

Make a call.

initAnswer(): Promise<void>

Initializes an answer. Must be called before answering a call.

answer(): Promise<void>

Answers a call.

hangup(): Promise<void>

Terminates a call.

reject(): Promise<void>

Reject a call.

sendDTMF(dtmf: string): Promise<void>

Sends a DTMF code.

sendCallInfo(callInfo: string): Promise<void>

Sends any data to other clients.

getCallStats(): Promise<string>

Get the call's statistics. If successful return statistics in JSON string.

switchCamera(): Promise<void>

Switches the device's camera. By default, Stringee SDK uses the front camera.

enableVideo(enabled: boolean): Promise<void>

Enables or disables the local stream.

mute(mute: boolean): Promise<void>

Toggle audio on or off.

setSpeakerphoneOn(on: boolean): Promise<void>

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.

resumeVideo(): Promise<void | StringeeError>

This method is only available on Android. When lost local stream then call resumeVideo to resume local stream in Android.

generateUUID(): Promise<string>

Generate and return the uuid of the call to display CallKeep in iOS.

clean(): void

Remove native event subscriptions and release resources owned by this StringeeCall wrapper.