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

STWLiveStreamCall

open class STWLiveStreamCall : STWVCall
Content copied to clipboard

Types

Link copied to clipboard
interface FeedCallback
Content copied to clipboard

Functions

Link copied to clipboard
open fun getCallerVideoCaptureSource(): Int
Content copied to clipboard
Link copied to clipboard
open fun getStreamingViewerCount(): Int
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getVideoStreamingForwardedFrom(): String
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getVideoStreamingForwardedName(): String
Content copied to clipboard
Link copied to clipboard
open fun isDispatcherSession(): Boolean
Content copied to clipboard
session configured for dispatcher dispatcher session do not handel the participant event
Link copied to clipboard
open fun isStreaming(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun resumeSession()
Content copied to clipboard
the only function to resume a session
Link copied to clipboard
open fun setDisplay(@Nullable display: STWSurfaceView): Boolean
Content copied to clipboard
Link copied to clipboard
open fun setPreviewDisplay(@Nullable display: STWSurfaceView): Boolean
Content copied to clipboard
set the preview Display for the current video stack
Link copied to clipboard
@RestrictTo(value = RestrictTo.Scope.LIBRARY)
open fun setVideoStreamingForwardedFrom(@Nullable videoStreamingForwardedFrom: String)
Content copied to clipboard
Link copied to clipboard
@RestrictTo(value = RestrictTo.Scope.LIBRARY)
open fun setVideoStreamingForwardedName(@Nullable videoStreamingForwardedName: String)
Content copied to clipboard
Link copied to clipboard
open fun startSession()
Content copied to clipboard
Link copied to clipboard
open fun startStreamWithouSurface(@Nullable sourceSize: Size, @Nullable feedCallback: STWLiveStreamCall.FeedCallback)
Content copied to clipboard
Link copied to clipboard
open fun toggleCamera()
Content copied to clipboard

Inherited functions

Link copied to clipboard
open fun canBeMerged(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun checkSameRecipient(@NonNull recipients: List<STWRecipient>): Boolean
Content copied to clipboard
Link copied to clipboard
open fun enableNoiseReduction(enable: Boolean)
Content copied to clipboard
Link copied to clipboard
open fun enableProximitySensor(enable: Boolean)
Content copied to clipboard
Link copied to clipboard
open fun enqueueDtmf(dtmf: Int)
Content copied to clipboard
Send DTMF signals while connected to a Call Out via PBX
Link copied to clipboard
open fun equals(o: Any): Boolean
Content copied to clipboard
Link copied to clipboard
open fun exitBustRecorded(): Boolean
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getActiveCamera(): STWCamera
Content copied to clipboard
Call this method to get the active camera
Link copied to clipboard
@Deprecated
@NonNull
open fun getAllParticipantPhoneItems(): ArrayList<PhoneItem>
Content copied to clipboard
get all the participants in this call session
Link copied to clipboard
@Deprecated
@NonNull
open fun getAllParticipants(): Array<String>
Content copied to clipboard
get all the participants in this call session
Link copied to clipboard
open fun getAllParticipantsCount(): Int
Content copied to clipboard
get count of all the participants in this call session
Link copied to clipboard
@NonNull
open fun getAllVoipParticipants(): List<VoipParticipant>
Content copied to clipboard
get all the participants in this call session
Link copied to clipboard
@NonNull
open fun getAttendingLinkedChannel(): ArrayList<String>
Content copied to clipboard
get all the connected linked Channel
Link copied to clipboard
@Deprecated
@NonNull
open fun getAttendingParticipantPhoneItems(): ArrayList<PhoneItem>
Content copied to clipboard
get all the connected user
Link copied to clipboard
@Deprecated
@NonNull
open fun getAttendingParticipants(): Array<String>
Content copied to clipboard
get all the connected user
Link copied to clipboard
open fun getAttendingParticipantsCount(): Int
Content copied to clipboard
get count of all the connected user
Link copied to clipboard
@NonNull
open fun getAttendingVoipParticipants(): List<VoipParticipant>
Content copied to clipboard
get all the connected user
Link copied to clipboard
open fun getAudioVolumeCapture(): Int
Content copied to clipboard
Returns the Volume level of the capture audio stream
Link copied to clipboard
open fun getAudioVolumePlay(): Int
Content copied to clipboard
Returns the Volume level of the played audio stream
Link copied to clipboard
@Nullable
open fun getAvailableCamera(): List<STWCamera>
Content copied to clipboard
This method get the list of available camera Note : Session type should support video
Link copied to clipboard
@Deprecated
@NonNull
open fun getBusyParticipantPhoneItems(): ArrayList<PhoneItem>
Content copied to clipboard
get all the users who decline the call because they are busy
Link copied to clipboard
@Deprecated
@NonNull
open fun getBusyParticipants(): Array<String>
Content copied to clipboard
get all the users who decline the call because they are busy
Link copied to clipboard
open fun getBusyParticipantsCount(): Int
Content copied to clipboard
get count of all the users who decline the call because they are busy
Link copied to clipboard
@NonNull
open fun getBusyVoipParticipants(): List<VoipParticipant>
Content copied to clipboard
get all the users who decline the call because they are busy
Link copied to clipboard
@Deprecated
open fun getCallerLevel(): Double
Content copied to clipboard
Link copied to clipboard
open fun getCallerParticipant(): VoipParticipant
Content copied to clipboard
Link copied to clipboard
@Deprecated
@NonNull
open fun getCallerPhoneItem(): PhoneItem
Content copied to clipboard
Link copied to clipboard
open fun getCallStatus(): Int
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getCallTransferor(): String
Content copied to clipboard
Get the call transferor, if any
Link copied to clipboard
@Nullable
open fun getCallTransferorParticipant(): VoipParticipant
Content copied to clipboard
Get the call transferor, if any
Link copied to clipboard
@Nullable
open fun getCallTransferorPhoneNumber(): String
Content copied to clipboard
Get the call transferor phone number if exist, null otherwise
Link copied to clipboard
@Nullable
open fun getCallTransferSubType(): String
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getChannelEmergencyInitiator(): String
Content copied to clipboard
Link copied to clipboard
open fun getCountParticipantAttendingInSession(): Int
Content copied to clipboard
Returns the count of all attending participants ATTENDING ATTENDING_ONHOLD RECONNECTING
Link copied to clipboard
open fun getCountParticipantByState(state: Int): Int
Content copied to clipboard
Link copied to clipboard
open fun getCountParticipantInSession(): Int
Content copied to clipboard
returns the count of all active participants ATTENDING ATTENDING_ONHOLD RECONNECTING INVITED
Link copied to clipboard
@Deprecated
@NonNull
open fun getCugDeniedParticipantPhoneItems(): ArrayList<PhoneItem>
Content copied to clipboard
get all the the user that cannot reach the call because they are not allowed (CUG Denied).
Link copied to clipboard
@Deprecated
@NonNull
open fun getCugDeniedParticipants(): Array<String>
Content copied to clipboard
get all the the user that cannot reach the call because they are not allowed (CUG Denied).
Link copied to clipboard
open fun getCugDeniedParticipantsCount(): Int
Content copied to clipboard
get count of all the the user that cannot reach the call because they are not allowed (CUG Denied).
Link copied to clipboard
@NonNull
open fun getCugDeniedVoipParticipants(): List<VoipParticipant>
Content copied to clipboard
get all the the user that cannot reach the call because they are not allowed (CUG Denied).
Link copied to clipboard
open fun getCurrentCallType(): Int
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getCurrentParticipantName(@Nullable participant: String): String
Content copied to clipboard
Link copied to clipboard
@Deprecated
@NonNull
open fun getDeclinedParticipantPhoneItems(): ArrayList<PhoneItem>
Content copied to clipboard
get all the users who decline the call
Link copied to clipboard
@Deprecated
@NonNull
open fun getDeclinedParticipants(): Array<String>
Content copied to clipboard
get all the users who decline the call
Link copied to clipboard
open fun getDeclinedParticipantsCount(): Int
Content copied to clipboard
get count of all the users who decline the call
Link copied to clipboard
@NonNull
open fun getDeclinedVoipParticipants(): List<VoipParticipant>
Content copied to clipboard
get all the users who decline the call
@Deprecated
@NonNull
open fun getFeatureNotAllowedParticipantPhoneItems(): ArrayList<PhoneItem>
Content copied to clipboard
get all the the user that cannot reach the call because they are not allowed (Feature not activated).
Link copied to clipboard
@Deprecated
@NonNull
open fun getFeatureNotAllowedParticipants(): Array<String>
Content copied to clipboard
get all the the user that cannot reach the call because they are not allowed (Feature not activated).
Link copied to clipboard
open fun getFeatureNotAllowedParticipantsCount(): Int
Content copied to clipboard
get count of all the the user that cannot reach the call because they are not allowed (Feature not activated).
Link copied to clipboard
@NonNull
open fun getFeatureNotAllowedVoipParticipants(): List<VoipParticipant>
Content copied to clipboard
get all the the user that cannot reach the call because they are not allowed (Feature not activated).
Link copied to clipboard
@Nullable
open fun getGroupId(): String
Content copied to clipboard
Link copied to clipboard
@NonNull
open fun getHangUpLinkedChannel(): ArrayList<String>
Content copied to clipboard
get all the linked channels who hang up
Link copied to clipboard
@Deprecated
@NonNull
open fun getHangUpParticipantPhoneItems(): ArrayList<PhoneItem>
Content copied to clipboard
get all the users who hang up
Link copied to clipboard
@Deprecated
@NonNull
open fun getHangUpParticipants(): Array<String>
Content copied to clipboard
get all the user who hang up
Link copied to clipboard
open fun getHangUpParticipantsCount(): Int
Content copied to clipboard
get count of all the userwho hang up
Link copied to clipboard
@NonNull
open fun getHangUpVoipParticipants(): List<VoipParticipant>
Content copied to clipboard
get all the user who hang up
Link copied to clipboard
@Nullable
@Deprecated
open fun getInitialVoipParticipantList(): VoipParticipantList
Content copied to clipboard
Link copied to clipboard
@NonNull
open fun getInvitedLinkedChannel(): ArrayList<String>
Content copied to clipboard
get all the invited linked channel to the call (and they are not yet joined or declined the call)
Link copied to clipboard
@Deprecated
@NonNull
open fun getInvitedParticipantPhoneItems(): ArrayList<PhoneItem>
Content copied to clipboard
get all the invited users to the call (and they are not yet joined or declined the call)
Link copied to clipboard
@Deprecated
@NonNull
open fun getInvitedParticipants(): Array<String>
Content copied to clipboard
get all the invited users to the call (and they are not yet joined or declined the call)
Link copied to clipboard
open fun getInvitedParticipantsCount(): Int
Content copied to clipboard
get count of all the invited users to the call (and they are not yet joined or declined the call)
Link copied to clipboard
@NonNull
open fun getInvitedVoipParticipants(): List<VoipParticipant>
Content copied to clipboard
get all the invited users to the call (and they are not yet joined or declined the call)
Link copied to clipboard
@NonNull
open fun getLinkedChannelByState(state: Int): ArrayList<String>
Content copied to clipboard
Link copied to clipboard
@NonNull
open fun getLocalID(): String
Content copied to clipboard
Link copied to clipboard
@NonNull
open fun getOnHoldLinkedChannel(): ArrayList<String>
Content copied to clipboard
get all the on hold linked channel
Link copied to clipboard
@Deprecated
@NonNull
open fun getOnHoldParticipantPhoneItems(): ArrayList<PhoneItem>
Content copied to clipboard
get all the on hold user
Link copied to clipboard
@Deprecated
@NonNull
open fun getOnHoldParticipants(): Array<String>
Content copied to clipboard
get all the on hold user
Link copied to clipboard
open fun getOnHoldParticipantsCount(): Int
Content copied to clipboard
get count of all the on hold user
Link copied to clipboard
@NonNull
open fun getOnHoldVoipParticipants(): List<VoipParticipant>
Content copied to clipboard
get all the on hold user
Link copied to clipboard
@Nullable
open fun getParameters(): Parameters
Content copied to clipboard
Link copied to clipboard
@Deprecated
@NonNull
open fun getParticipantByState(state: Int): ArrayList<PhoneItem>
Content copied to clipboard
Link copied to clipboard
@NonNull
open fun getParticipantNames(): String
Content copied to clipboard
Link copied to clipboard
open fun getParticipantType(@Nullable participant: String): Int
Content copied to clipboard
Use this method to retrieve the participant type
Link copied to clipboard
open fun getPriority(): Double
Content copied to clipboard
Link copied to clipboard
@Deprecated
open fun getPriorityLevel(): Int
Content copied to clipboard
Use this method to retrieve the priority of the call
Link copied to clipboard
open fun getQosIndicator(): Int
Content copied to clipboard
Returns a global qos indicator
Link copied to clipboard
@Nullable
open fun getReceptionTime(): String
Content copied to clipboard
Link copied to clipboard
@NonNull
open fun getReconnectingLinkedChannel(): ArrayList<String>
Content copied to clipboard
get all the linked channel with reconnecting status, they have a network a problem and they try to reconnect.
Link copied to clipboard
@Deprecated
@NonNull
open fun getReconnectingParticipantPhoneItems(): ArrayList<PhoneItem>
Content copied to clipboard
get all the user with reconnecting status, they have a network a problem and they try to reconnect.
Link copied to clipboard
@Deprecated
@NonNull
open fun getReconnectingParticipants(): Array<String>
Content copied to clipboard
get all the user with reconnecting status, they have a network a problem and they try to reconnect.
Link copied to clipboard
open fun getReconnectingParticipantsCount(): Int
Content copied to clipboard
get count of all the user with reconnecting status
Link copied to clipboard
@NonNull
open fun getReconnectingVoipParticipants(): List<VoipParticipant>
Content copied to clipboard
get all the user with reconnecting status, they have a network a problem and they try to reconnect.
Link copied to clipboard
@Nullable
open fun getSessionID(): String
Content copied to clipboard
Link copied to clipboard
@NonNull
open fun getSessionIdentifier(): String
Content copied to clipboard
Link copied to clipboard
open fun getSpeakerState(): Boolean
Content copied to clipboard
get speaker state for session ptt voice settings audio output options handled by STWAudioUtil
Link copied to clipboard
open fun getStartCallTime(): Long
Content copied to clipboard
Call this method to get the started VoIP call timestamp
Link copied to clipboard
@Nullable
open fun getThreadId(): Integer
Content copied to clipboard

@Deprecated
@Nullable
open fun getThreadId(@NonNull context: Context): String
Content copied to clipboard
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
Link copied to clipboard
@Nullable
open fun getTransferToParticipant(): VoipParticipant
Content copied to clipboard
Link copied to clipboard
@Deprecated
@NonNull
open fun getUnansweringParticipantPhoneItems(): ArrayList<PhoneItem>
Content copied to clipboard
get all the users who did not answer the call
Link copied to clipboard
@Deprecated
@NonNull
open fun getUnansweringParticipants(): Array<String>
Content copied to clipboard
get all the users who did not answer the call
Link copied to clipboard
open fun getUnansweringParticipantsCount(): Int
Content copied to clipboard
get count of all the users who did not answer the call
Link copied to clipboard
@NonNull
open fun getUnansweringVoipParticipants(): List<VoipParticipant>
Content copied to clipboard
get all the users who did not answer the call
Link copied to clipboard
open fun getVideoCameraId(): Int
Content copied to clipboard
Call this method to get the active camera id
Link copied to clipboard
@Deprecated
@NonNull
open fun getVoipParticipantList(): VoipParticipantList
Content copied to clipboard
Link copied to clipboard
open fun hashCode(): Int
Content copied to clipboard
Link copied to clipboard
open fun iAmOnHold(): Boolean
Content copied to clipboard
The user himself is on hold
Link copied to clipboard
open fun isAllOtherParticipantsOnHold(): Boolean
Content copied to clipboard
All the others participants are on hold
Link copied to clipboard
open fun isAllParticipantReconnecting(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun isAnEmergency(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun isCallIn(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun isCallOut(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun isInLargeGroup(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun isManDownCall(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun isMaxParticipantToDisplayNotReached(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun isMute(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun isNoiseReductionEnabled(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun isParticipantReachedReceived(): Boolean
Content copied to clipboard
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)
Link copied to clipboard
open fun isPrearrangedGroupCall(): Boolean
Content copied to clipboard
The pre-arranged PPT group call is a call to a group of which the subscriber is a member of it.
Link copied to clipboard
open fun isReconnecting(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun isSessionOnHold(): Boolean
Content copied to clipboard
all participants are on hold
Link copied to clipboard
open fun isSessionOutgoing(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun isSessionTransferredToExternal(): Boolean
Content copied to clipboard
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
Link copied to clipboard
open fun isUserAlreadyInSession(@NonNull phoneNumber: String): Boolean
Content copied to clipboard
Check whether the user is already in the session or not
Link copied to clipboard
open fun mute(): Boolean
Content copied to clipboard
make the call mute
Link copied to clipboard
open fun putOnHold()
Content copied to clipboard
the only function that put the stack on hold
Link copied to clipboard
open fun registerForVoipCallTimerListener(@Nullable voipTimerObserver: VoIPTimerObserver)
Content copied to clipboard
Call this method to register for VoIP call timer callbacks (on start / on stop / on tick)
Link copied to clipboard
open fun requestParticipantListUpdate(): Boolean
Content copied to clipboard
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
Link copied to clipboard
open fun resetAudio(): Boolean
Content copied to clipboard
destroy and restart both speakers and mics
Link copied to clipboard
open fun setAudioCaptureListner(audioCaptureListner: AudioCaptureListner)
Content copied to clipboard
Link copied to clipboard
open fun setAudioCaptureSource(audioSource: Int)
Content copied to clipboard
Call this method to change the audio Source for the ongoing call.
Link copied to clipboard
open fun setAudioPlayListner(audioPlayListner: AudioPlayListner)
Content copied to clipboard
Link copied to clipboard
open fun setAudioPlayUsage(usage: Int)
Content copied to clipboard
Call this method to change the usage for the ongoing call.
Link copied to clipboard
@RestrictTo(value = RestrictTo.Scope.LIBRARY)
@Deprecated
open fun setInitialVoipParticipantList(@Nullable voipParticipantList: VoipParticipantList)
Content copied to clipboard
Link copied to clipboard
open fun setIsCallIn(isCallIn: Boolean)
Content copied to clipboard
Link copied to clipboard
open fun setQosListener(qosListener: QosListener)
Content copied to clipboard
Link copied to clipboard
open fun setVideoCameraId(@NonNull camera: STWCamera): Boolean
Content copied to clipboard
Use this method to change the camera, Note : Session type should support video
Link copied to clipboard
open fun setVideoCaptureCamera(@NonNull camera: STWCamera): Boolean
Content copied to clipboard
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.
Link copied to clipboard
open fun startFloorControlSound(    @NonNull voipRingtonePath: String,     isLooping: Boolean,     isAsset: Boolean)
Content copied to clipboard
Link copied to clipboard
open fun stopFloorControlSound()
Content copied to clipboard
Stop floor sound
Link copied to clipboard
@NonNull
open fun toString(): String
Content copied to clipboard
Link copied to clipboard
@RestrictTo(value = RestrictTo.Scope.LIBRARY)
open fun transfer(    @NonNull context: Context,     @Nullable msisdn: String,     isTransferToExternal: Boolean,     isAnonymous: Boolean): Boolean
Content copied to clipboard
Call this method to transfer the call to a target participant
Link copied to clipboard
open fun unMute(): Boolean
Content copied to clipboard
make the call unmute
Link copied to clipboard
open fun unregisterForVoipCallTimerListener(@Nullable voipTimerObserver: VoIPTimerObserver)
Content copied to clipboard
Call this method to unregister from VoIP call timer callbacks (on start / on stop / on tick)
Link copied to clipboard
open fun updateCallParameter(isEmergency: Boolean, isAutomaticFloorRequest: Boolean): Boolean
Content copied to clipboard
methode added to the feature "raise channel to emergency mode"
Link copied to clipboard
open fun updateOpenIDToken(): Boolean
Content copied to clipboard