telnyx_rtc/com.telnyx.webrtc.sdk/TelnyxClient

TelnyxClient

class TelnyxClient(var context: Context) : TxSocketListener

The TelnyxClient class that can be used to control the SDK. Create / Answer calls, change audio device, etc.

Parameters

context

the Context that the application is using

Constructors

constructor(context: Context)

Types

object Companion

Companion object containing constant values used throughout the client.

enum RingtoneType : Enum<TelnyxClient.RingtoneType>

Enum class that defines the type of ringtone resource.

enum SpeakerMode : Enum<TelnyxClient.SpeakerMode>

Enum class that defines the current audio output mode.

Properties

val ~~call~~: Call?

var context: Context

var sessid: String

socketResponseLiveData

lateinit var socketResponseLiveData: MutableLiveData<SocketResponse<ReceivedMessageBody>>

wsMessagesResponseLiveDate

val wsMessagesResponseLiveDate: MutableLiveData<JsonObject>

Functions

fun acceptCall(callId: UUID, destinationNumber: String, customHeaders: Map<String, String>? = null): Call

Accepts an incoming call invitation.

fun ~~connect~~(providedServerConfig: TxServerConfiguration = TxServerConfiguration(), txPushMetaData: String? = null)

fun connect(providedServerConfig: TxServerConfiguration = TxServerConfiguration(), credentialConfig: CredentialConfig, txPushMetaData: String? = null, autoLogin: Boolean = true)

Connects to the socket using this client as the listener Will respond with 'No Network Connection' if there is no network available

fun connect(providedServerConfig: TxServerConfiguration = TxServerConfiguration(), tokenConfig: TokenConfig, txPushMetaData: String? = null, autoLogin: Boolean = true)

credentialLogin

fun ~~credentialLogin~~(config: CredentialConfig)

Logs the user in with credentials provided via CredentialConfig

disablePushNotification

fun disablePushNotification(sipUserName: String?, loginToken: String?, fcmToken: String)

Disables push notifications for current user

fun endCall(callId: UUID)

Ends an active call.

fun getActiveCalls(): Map<UUID, Call>

Returns all active calls that have been stored in our calls MutableMap The MutableMap is converted into a Map - preventing any changes by the SDK User

getRawRingbackTone

fun getRawRingbackTone(): Int?

Gets the currently configured ringback tone resource.

fun getRawRingtone(): Any?

Gets the currently configured ringtone resource.

getSocketResponse

fun getSocketResponse(): LiveData<SocketResponse<ReceivedMessageBody>>

Returns the socket response in the form of LiveData The format of each message is provided in SocketResponse and ReceivedMessageBody

getWsMessageResponse

fun getWsMessageResponse(): LiveData<JsonObject>

Returns the json messages from socket in the form of LiveData used for debugging purposes

isSocketConnected

fun isSocketConnected(): Boolean

fun newInvite(callerName: String, callerNumber: String, destinationNumber: String, clientState: String, customHeaders: Map<String, String>? = null): Call

Creates a new outgoing call invitation.

onAnswerReceived

open override fun onAnswerReceived(jsonObject: JsonObject)

Fires when a user has provided an answer to a call attempt

onAttachReceived

open override fun onAttachReceived(jsonObject: JsonObject)

Fires once a connection has been reestablished during an ongoing call and a session is being reattached

open override fun onByeReceived(callId: UUID)

Fires when the TxSocket has received an indication the a call has ended or been rejected

open override fun onClientReady(jsonObject: JsonObject)

Fires once the client is ready and gateway status updates can be received

onConnectionEstablished

open override fun onConnectionEstablished()

Fires when a socket connection is established

onDisablePushReceived

open override fun onDisablePushReceived(jsonObject: JsonObject)

Fires when a disablePush response is recieved

open override fun onDisconnect()

Disconnect from the TxSocket and unregister the provided network callback

onErrorReceived

open override fun onErrorReceived(jsonObject: JsonObject)

Fires when an error has occurred with the TxSocket

onGatewayStateReceived

open override fun onGatewayStateReceived(gatewayState: String, receivedSessionId: String?)

Fires once a Gateway state has been received. These are used to find a verified registration

onIceCandidateReceived

open override fun onIceCandidateReceived(iceCandidate: IceCandidate)

Fires when a usable IceCandidate has been received

onMediaReceived

open override fun onMediaReceived(jsonObject: JsonObject)

Fires when an answer has been provided with additional media

onOfferReceived

open override fun onOfferReceived(jsonObject: JsonObject)

Fires when the TxSocket has received an invitation to communicate

onRingingReceived

open override fun onRingingReceived(jsonObject: JsonObject)

Fires once we receive a ringing socket response, containing Telnyx information

open override fun pingPong()

Fires when a ping message is received from the server, requiring a pong response

setAudioOutputDevice

fun setAudioOutputDevice(audioDevice: AudioDevice)

Sets the audio device that the SDK should use

setCallRecovering

open override fun setCallRecovering()

Fires when network has dropped during an ongoing call. Signifies that the SDK will attempt to recover once network has returned

fun ~~tokenLogin~~(config: TokenConfig)

Logs the user in with credentials provided via TokenConfig