STREAMWIDE SDK Android 3.12.1/com.streamwide.smartms.lib.core.network.voip/STWPTTCall

STWPTTCall

open class STWPTTCall : STWVCall, IDenyToTransmitChangesFromCug

Constructors

~~open~~ ~~fun~~ ~~STWPTTCall~~( @NonNull context: Context, @NonNull call: Call, isCallReceivedFromUA: Boolean, @Nullable parameters: Parameters, @Nullable receptionTime: String, @NonNull caller: PhoneItem, callerLevel: Double, isInLargeGroup: Boolean, isOutgoing: Boolean, status: Int, callPriority: Double, @Nullable callTransferor: String)

open fun STWPTTCall( context: Context, call: Call, isCallReceivedFromUA: Boolean, parameters: Parameters, @Nullable threadId: Integer, @NonNull callerParticipant: VoipParticipant, @Nullable calleeParticipantList: List<VoipParticipant>, isOutgoing: Boolean, callPriority: Integer)

Types

STWVCallFloorState

@Retention(value = RetentionPolicy.SOURCE)

annotation class STWVCallFloorState

Properties

isSupervisoryRevokeFloor

private open val isSupervisoryRevokeFloor: Boolean

the supervisory revoke the floor

Functions

getCurrentFloorStateValue

open fun getCurrentFloorStateValue(): Int

getFallBackCallBack

open fun getFallBackCallBack(): FallbackCallback

getFloorDenyReasonValue

open fun getFloorDenyReasonValue(): Int

getFloorOwnerNameAndType

open fun getFloorOwnerNameAndType(): Pair<String, Integer>

retrieve the floor owner name and his type (participant, external group or radio channel)

getFloorOwnerParticipant

open fun getFloorOwnerParticipant(): VoipParticipant

getFloorRevokeReasonValue

open fun getFloorRevokeReasonValue(): Int

getPreviousFloorOwnerAndReleaseTimeStamp

open fun getPreviousFloorOwnerAndReleaseTimeStamp(): Pair<String, Long>

Return last floor owner and time taken:

getPreviousFloorOwnerNameAndType

open fun getPreviousFloorOwnerNameAndType(): Pair<String, Integer>

getPreviousFloorOwnerParticipant

open fun getPreviousFloorOwnerParticipant(): VoipParticipant

getPreviousFloorOwnerParticipantAndTimeStamp

open fun getPreviousFloorOwnerParticipantAndTimeStamp(): Pair<VoipParticipant, Long>

getPreviousFloorOwnerState

open fun getPreviousFloorOwnerState(): Int

getPreviousFloorStateValue

open fun getPreviousFloorStateValue(): Int

getPushButtonState

open fun getPushButtonState(): Int

getUpdatedFloorOwner

open fun getUpdatedFloorOwner(): String

retrieve the updated floor owner

getWTPrioritiesMap

open fun getWTPrioritiesMap(): Map<String, Integer>

handleFloorControlEvent

open fun handleFloorControlEvent(@NonNull event: FloorControl.Event)

check the event and make changes to the floor owner and the possibility to talk

hasPermissionToRequestFloor

open fun hasPermissionToRequestFloor(): Boolean

open fun iAmTalking(): Boolean

inviteNewParticipants

open fun inviteNewParticipants( @Nullable numbersAtFqdns: String, @Nullable externalNumbers: String, @Nullable newSessionGroupId: String): Boolean

isBroadcastCall

open fun isBroadcastCall(): Boolean

either the session is a broadcastCall or not

open fun isChannel(): Boolean

isChannelAutoConnection

open fun isChannelAutoConnection(@NonNull context: Context): Boolean

isEmergencyCall

open fun isEmergencyCall(): Boolean

either the session is for emergency or not

isFloorRequestOnInvite

open fun isFloorRequestOnInvite(): Boolean

either the session is started with floor request on invite enabled

isGroupDenyTransmission

open fun isGroupDenyTransmission(): Boolean

Just used in the start session to avoid access data base

open fun isPendingMode(): Boolean

isPendingRealiseMode

open fun isPendingRealiseMode(): Boolean

open fun isPocTalking(): Boolean

isPrearrangedGroupCall

open fun isPrearrangedGroupCall(): Boolean

The pre-arranged PPT group call is a call to a group of which the subscriber is a member of it.

isVisitorChannel

open fun isVisitorChannel(): Boolean

onDenyToTransmitChanges

open fun onDenyToTransmitChanges(isDenyToTransmit: Boolean)

open fun putOnHold()

the only function that put the stack on hold

registerForFloorGrantedPercentProgressListener

open fun registerForFloorGrantedPercentProgressListener(@Nullable observer: FloorGrantedPercentProgressObserver)

Call this method to register for Floor Granted percent progress callbacks (percentage of granted floor)

registerForFloorGrantedTimerListener

open fun registerForFloorGrantedTimerListener(@Nullable observer: FloorGrantedTimerObserver)

Call this method to register for Floor Granted timer callbacks

releaseFloorRequestOnInvite

open fun releaseFloorRequestOnInvite(@Nullable completion: CompletionCallback)

releaseMediaBurst

~~open~~ ~~fun~~ ~~releaseMediaBurst~~(): Boolean

open fun releaseMediaBurst(@Nullable completion: CompletionCallback): Boolean

end a push to talk message

~~open~~ ~~fun~~ ~~releaseMediaBurst~~(forceRelease: Boolean): Boolean

open fun releaseMediaBurst(forceRelease: Boolean, @Nullable completion: CompletionCallback): Boolean

need to force releaseMediaBurst when revoke too long the floor

requestMediaBurst

open fun requestMediaBurst(@Nullable completion: CompletionCallback): Boolean

send a push to talk message

requestParticipantList

open fun requestParticipantList(@NonNull stwRequestParticipantListListener: STWRequestParticipantListListener)

open fun resumeSession()

the only function to resume a session

retrievePocFloorOwnerPhoneItem

~~open~~ ~~fun~~ ~~retrievePocFloorOwnerPhoneItem~~(): PhoneItem

Use this method to retrieve the floor owner's PhoneItem.

sendReachBackRequest

open fun sendReachBackRequest(isEmergency: Boolean): Boolean

Send reach back request

setFallBackCallBack

open fun setFallBackCallBack(@NonNull mFallBackCallBack: FallbackCallback)

open fun startSession()

open fun startSession(isChannel: Boolean, isVisitor: Boolean)

unregisterFromFloorGrantedPercentProgressListener

open fun unregisterFromFloorGrantedPercentProgressListener(@Nullable observer: FloorGrantedPercentProgressObserver)

Call this method to unregister from Floor Granted percent progress callbacks (percentage of granted floor)

unregisterFromFloorGrantedTimerListener

open fun unregisterFromFloorGrantedTimerListener(@Nullable observer: FloorGrantedTimerObserver)

Call this method to unregister from Floor Granted timer callbacks (percentage of granted floor)

Inherited functions

open fun canBeMerged(): Boolean

checkSameRecipient

open fun checkSameRecipient(@NonNull recipients: List<STWRecipient>): Boolean

enableNoiseReduction

open fun enableNoiseReduction(enable: Boolean)

enableProximitySensor

open fun enableProximitySensor(enable: Boolean)

open fun enqueueDtmf(dtmf: Int)

Send DTMF signals while connected to a Call Out via PBX

open fun equals(o: Any): Boolean

exitBustRecorded

open fun exitBustRecorded(): Boolean

getActiveCamera

open fun getActiveCamera(): STWCamera

Call this method to get the active camera

getAllParticipantPhoneItems

~~open~~ ~~fun~~ ~~getAllParticipantPhoneItems~~(): ArrayList<PhoneItem>

get all the participants in this call session

getAllParticipants

~~open~~ ~~fun~~ ~~getAllParticipants~~(): Array<String>

get all the participants in this call session

getAllParticipantsCount

open fun getAllParticipantsCount(): Int

get count of all the participants in this call session

getAllVoipParticipants

open fun getAllVoipParticipants(): List<VoipParticipant>

get all the participants in this call session

getAttendingLinkedChannel

open fun getAttendingLinkedChannel(): ArrayList<String>

get all the connected linked Channel

getAttendingParticipantPhoneItems

~~open~~ ~~fun~~ ~~getAttendingParticipantPhoneItems~~(): ArrayList<PhoneItem>

get all the connected user

getAttendingParticipants

~~open~~ ~~fun~~ ~~getAttendingParticipants~~(): Array<String>

get all the connected user

getAttendingParticipantsCount

open fun getAttendingParticipantsCount(): Int

get count of all the connected user

getAttendingVoipParticipants

open fun getAttendingVoipParticipants(): List<VoipParticipant>

get all the connected user

getAudioVolumeCapture

open fun getAudioVolumeCapture(): Int

Returns the Volume level of the capture audio stream

getAudioVolumePlay

open fun getAudioVolumePlay(): Int

Returns the Volume level of the played audio stream

getAvailableCamera

open fun getAvailableCamera(): List<STWCamera>

This method get the list of available camera Note : Session type should support video

getBusyParticipantPhoneItems

~~open~~ ~~fun~~ ~~getBusyParticipantPhoneItems~~(): ArrayList<PhoneItem>

get all the users who decline the call because they are busy

getBusyParticipants

~~open~~ ~~fun~~ ~~getBusyParticipants~~(): Array<String>

get all the users who decline the call because they are busy

getBusyParticipantsCount

open fun getBusyParticipantsCount(): Int

get count of all the users who decline the call because they are busy

getBusyVoipParticipants

open fun getBusyVoipParticipants(): List<VoipParticipant>

get all the users who decline the call because they are busy

~~open~~ ~~fun~~ ~~getCallerLevel~~(): Double

getCallerParticipant

open fun getCallerParticipant(): VoipParticipant

getCallerPhoneItem

~~open~~ ~~fun~~ ~~getCallerPhoneItem~~(): PhoneItem

open fun getCallStatus(): Int

getCallTransferor

open fun getCallTransferor(): String

Get the call transferor, if any

getCallTransferorParticipant

open fun getCallTransferorParticipant(): VoipParticipant

Get the call transferor, if any

getCallTransferorPhoneNumber

open fun getCallTransferorPhoneNumber(): String

Get the call transferor phone number if exist, null otherwise

getCallTransferSubType

open fun getCallTransferSubType(): String

getChannelEmergencyInitiator

open fun getChannelEmergencyInitiator(): String

getCountParticipantAttendingInSession

open fun getCountParticipantAttendingInSession(): Int

Returns the count of all attending participants ATTENDING ATTENDING_ONHOLD RECONNECTING

getCountParticipantByState

open fun getCountParticipantByState(state: Int): Int

getCountParticipantInSession

open fun getCountParticipantInSession(): Int

returns the count of all active participants ATTENDING ATTENDING_ONHOLD RECONNECTING INVITED

getCugDeniedParticipantPhoneItems

~~open~~ ~~fun~~ ~~getCugDeniedParticipantPhoneItems~~(): ArrayList<PhoneItem>

get all the the user that cannot reach the call because they are not allowed (CUG Denied).

getCugDeniedParticipants

~~open~~ ~~fun~~ ~~getCugDeniedParticipants~~(): Array<String>

get all the the user that cannot reach the call because they are not allowed (CUG Denied).

getCugDeniedParticipantsCount

open fun getCugDeniedParticipantsCount(): Int

get count of all the the user that cannot reach the call because they are not allowed (CUG Denied).

getCugDeniedVoipParticipants

open fun getCugDeniedVoipParticipants(): List<VoipParticipant>

get all the the user that cannot reach the call because they are not allowed (CUG Denied).

getCurrentCallType

open fun getCurrentCallType(): Int

getCurrentParticipantName

open fun getCurrentParticipantName(@Nullable participant: String): String

getDeclinedParticipantPhoneItems

~~open~~ ~~fun~~ ~~getDeclinedParticipantPhoneItems~~(): ArrayList<PhoneItem>

get all the users who decline the call

getDeclinedParticipants

~~open~~ ~~fun~~ ~~getDeclinedParticipants~~(): Array<String>

get all the users who decline the call

getDeclinedParticipantsCount

open fun getDeclinedParticipantsCount(): Int

get count of all the users who decline the call

getDeclinedVoipParticipants

open fun getDeclinedVoipParticipants(): List<VoipParticipant>

get all the users who decline the call

getFeatureNotAllowedParticipantPhoneItems

~~open~~ ~~fun~~ ~~getFeatureNotAllowedParticipantPhoneItems~~(): ArrayList<PhoneItem>

get all the the user that cannot reach the call because they are not allowed (Feature not activated).

getFeatureNotAllowedParticipants

~~open~~ ~~fun~~ ~~getFeatureNotAllowedParticipants~~(): Array<String>

get all the the user that cannot reach the call because they are not allowed (Feature not activated).

getFeatureNotAllowedParticipantsCount

open fun getFeatureNotAllowedParticipantsCount(): Int

get count of all the the user that cannot reach the call because they are not allowed (Feature not activated).

getFeatureNotAllowedVoipParticipants

open fun getFeatureNotAllowedVoipParticipants(): List<VoipParticipant>

get all the the user that cannot reach the call because they are not allowed (Feature not activated).

open fun getGroupId(): String

getHangUpLinkedChannel

open fun getHangUpLinkedChannel(): ArrayList<String>

get all the linked channels who hang up

getHangUpParticipantPhoneItems

~~open~~ ~~fun~~ ~~getHangUpParticipantPhoneItems~~(): ArrayList<PhoneItem>

get all the users who hang up

getHangUpParticipants

~~open~~ ~~fun~~ ~~getHangUpParticipants~~(): Array<String>

get all the user who hang up

getHangUpParticipantsCount

open fun getHangUpParticipantsCount(): Int

get count of all the userwho hang up

getHangUpVoipParticipants

open fun getHangUpVoipParticipants(): List<VoipParticipant>

get all the user who hang up

getInitialVoipParticipantList

~~open~~ ~~fun~~ ~~getInitialVoipParticipantList~~(): VoipParticipantList

getInvitedLinkedChannel

open fun getInvitedLinkedChannel(): ArrayList<String>

get all the invited linked channel to the call (and they are not yet joined or declined the call)

getInvitedParticipantPhoneItems

~~open~~ ~~fun~~ ~~getInvitedParticipantPhoneItems~~(): ArrayList<PhoneItem>

get all the invited users to the call (and they are not yet joined or declined the call)

getInvitedParticipants

~~open~~ ~~fun~~ ~~getInvitedParticipants~~(): Array<String>

get all the invited users to the call (and they are not yet joined or declined the call)

getInvitedParticipantsCount

open fun getInvitedParticipantsCount(): Int

get count of all the invited users to the call (and they are not yet joined or declined the call)

getInvitedVoipParticipants

open fun getInvitedVoipParticipants(): List<VoipParticipant>

get all the invited users to the call (and they are not yet joined or declined the call)

getLinkedChannelByState

open fun getLinkedChannelByState(state: Int): ArrayList<String>

open fun getLocalID(): String

getOnHoldLinkedChannel

open fun getOnHoldLinkedChannel(): ArrayList<String>

get all the on hold linked channel

getOnHoldParticipantPhoneItems

~~open~~ ~~fun~~ ~~getOnHoldParticipantPhoneItems~~(): ArrayList<PhoneItem>

get all the on hold user

getOnHoldParticipants

~~open~~ ~~fun~~ ~~getOnHoldParticipants~~(): Array<String>

get all the on hold user

getOnHoldParticipantsCount

open fun getOnHoldParticipantsCount(): Int

get count of all the on hold user

getOnHoldVoipParticipants

open fun getOnHoldVoipParticipants(): List<VoipParticipant>

get all the on hold user

open fun getParameters(): Parameters

getParticipantByState

~~open~~ ~~fun~~ ~~getParticipantByState~~(state: Int): ArrayList<PhoneItem>

getParticipantNames

open fun getParticipantNames(): String

getParticipantType

open fun getParticipantType(@Nullable participant: String): Int

Use this method to retrieve the participant type

open fun getPriority(): Double

getPriorityLevel

~~open~~ ~~fun~~ ~~getPriorityLevel~~(): Int

Use this method to retrieve the priority of the call

getQosIndicator

open fun getQosIndicator(): Int

Returns a global qos indicator

getReceptionTime

open fun getReceptionTime(): String

getReconnectingLinkedChannel

open fun getReconnectingLinkedChannel(): ArrayList<String>

get all the linked channel with reconnecting status, they have a network a problem and they try to reconnect.

getReconnectingParticipantPhoneItems

~~open~~ ~~fun~~ ~~getReconnectingParticipantPhoneItems~~(): ArrayList<PhoneItem>

get all the user with reconnecting status, they have a network a problem and they try to reconnect.

getReconnectingParticipants

~~open~~ ~~fun~~ ~~getReconnectingParticipants~~(): Array<String>

get all the user with reconnecting status, they have a network a problem and they try to reconnect.

getReconnectingParticipantsCount

open fun getReconnectingParticipantsCount(): Int

get count of all the user with reconnecting status

getReconnectingVoipParticipants

open fun getReconnectingVoipParticipants(): List<VoipParticipant>

get all the user with reconnecting status, they have a network a problem and they try to reconnect.

open fun getSessionID(): String

getSessionIdentifier

open fun getSessionIdentifier(): String

getSpeakerState

open fun getSpeakerState(): Boolean

get speaker state for session ptt voice settings audio output options handled by STWAudioUtil

getStartCallTime

open fun getStartCallTime(): Long

Call this method to get the started VoIP call timestamp

open fun getThreadId(): Integer

~~open~~ ~~fun~~ ~~getThreadId~~(@NonNull context: Context): String

Call this method to retrieve the related thread conversation linked to a specific VoIP call Note that : this method has access to data base to retrieve the thread ID

getTransferToParticipant

open fun getTransferToParticipant(): VoipParticipant

getUnansweringParticipantPhoneItems

~~open~~ ~~fun~~ ~~getUnansweringParticipantPhoneItems~~(): ArrayList<PhoneItem>

get all the users who did not answer the call

getUnansweringParticipants

~~open~~ ~~fun~~ ~~getUnansweringParticipants~~(): Array<String>

get all the users who did not answer the call

getUnansweringParticipantsCount

open fun getUnansweringParticipantsCount(): Int

get count of all the users who did not answer the call

getUnansweringVoipParticipants

open fun getUnansweringVoipParticipants(): List<VoipParticipant>

get all the users who did not answer the call

getVideoCameraId

open fun getVideoCameraId(): Int

Call this method to get the active camera id

getVoipParticipantList

~~open~~ ~~fun~~ ~~getVoipParticipantList~~(): VoipParticipantList

open fun hashCode(): Int

open fun iAmOnHold(): Boolean

The user himself is on hold

isAllOtherParticipantsOnHold

open fun isAllOtherParticipantsOnHold(): Boolean

All the others participants are on hold

isAllParticipantReconnecting

open fun isAllParticipantReconnecting(): Boolean

open fun isAnEmergency(): Boolean

open fun isCallIn(): Boolean

open fun isCallOut(): Boolean

open fun isInLargeGroup(): Boolean

open fun isManDownCall(): Boolean

isMaxParticipantToDisplayNotReached

open fun isMaxParticipantToDisplayNotReached(): Boolean

open fun isMute(): Boolean

isNoiseReductionEnabled

open fun isNoiseReductionEnabled(): Boolean

isParticipantReachedReceived

open fun isParticipantReachedReceived(): Boolean

participant reached is received when session is outgoing and at least one called party has been reached (that is has received the VoIP session invitation)

open fun isReconnecting(): Boolean

isSessionOnHold

open fun isSessionOnHold(): Boolean

all participants are on hold

isSessionOutgoing

open fun isSessionOutgoing(): Boolean

isSessionTransferredToExternal

open fun isSessionTransferredToExternal(): Boolean

Returns if the session is transferred to an external in order to update the view accordingly: Scenario: User A invites user B User B invites an external user C For user A, the session is not with an external (he was put on hold) For user B, the session is with an external When the user B left the session, for user A the session is now with an external

isUserAlreadyInSession

open fun isUserAlreadyInSession(@NonNull phoneNumber: String): Boolean

Check whether the user is already in the session or not

open fun mute(): Boolean

make the call mute

registerForVoipCallTimerListener

open fun registerForVoipCallTimerListener(@Nullable voipTimerObserver: VoIPTimerObserver)

Call this method to register for VoIP call timer callbacks (on start / on stop / on tick)

requestParticipantListUpdate

open fun requestParticipantListUpdate(): Boolean

Call this method to request participant list in case of large group call The result will be dispatched with the event com.streamwide.smartms.lib.core.api_ktx.call.events.ParticipantListUpdated

open fun resetAudio(): Boolean

destroy and restart both speakers and mics

setAudioCaptureListner

open fun setAudioCaptureListner(audioCaptureListner: AudioCaptureListner)

setAudioCaptureSource

open fun setAudioCaptureSource(audioSource: Int)

Call this method to change the audio Source for the ongoing call.

setAudioPlayListner

open fun setAudioPlayListner(audioPlayListner: AudioPlayListner)

setAudioPlayUsage

open fun setAudioPlayUsage(usage: Int)

Call this method to change the usage for the ongoing call.

setInitialVoipParticipantList

@RestrictTo(value = RestrictTo.Scope.LIBRARY)

~~open~~ ~~fun~~ ~~setInitialVoipParticipantList~~(@Nullable voipParticipantList: VoipParticipantList)

open fun setIsCallIn(isCallIn: Boolean)

open fun setQosListener(qosListener: QosListener)

setVideoCameraId

open fun setVideoCameraId(@NonNull camera: STWCamera): Boolean

Use this method to change the camera, Note : Session type should support video

setVideoCaptureCamera

open fun setVideoCaptureCamera(@NonNull camera: STWCamera): Boolean

Call this method to change the active camera Note : use this method for call type that support use of camera : - Video call : [STWVCallType.STWVCallLiveVideoCallType] - Live streaming : [STWVCallType.

startFloorControlSound

open fun startFloorControlSound( @NonNull voipRingtonePath: String, isLooping: Boolean, isAsset: Boolean)

stopFloorControlSound

open fun stopFloorControlSound()

Stop floor sound

open fun toString(): String

@RestrictTo(value = RestrictTo.Scope.LIBRARY)

open fun transfer( @NonNull context: Context, @Nullable msisdn: String, isTransferToExternal: Boolean, isAnonymous: Boolean): Boolean

Call this method to transfer the call to a target participant

open fun unMute(): Boolean

make the call unmute

unregisterForVoipCallTimerListener

open fun unregisterForVoipCallTimerListener(@Nullable voipTimerObserver: VoIPTimerObserver)

Call this method to unregister from VoIP call timer callbacks (on start / on stop / on tick)

updateCallParameter

open fun updateCallParameter(isEmergency: Boolean, isAutomaticFloorRequest: Boolean): Boolean

methode added to the feature "raise channel to emergency mode"

updateOpenIDToken

open fun updateOpenIDToken(): Boolean