Quobis Android SDK (internal 0.81.2)/com.quobis.sippo.sipposdk.conference/Conference

Conference

A conference instance.

This class allows performing actions over this specific conference like joining the conference, hanging up or managing its participants. It also allows adding a listener to receive events related to this particular instance (@see ConferenceListener).

In order to share the media successfully, it is necessary to declare the pertinent permissions on the manifest:

"android.permission.CAMERA" for sharing video.
"android.permission.RECORD_AUDIO" for sharing audio.

Properties

caller

val caller: Contact?

Who has started this conference if the user was invited. If not, it will be null.

currentMediaTypes

val currentMediaTypes: List<MediaType>

Current conference mediatypes.

currentState

lateinit var currentState: JanusConference.State

Current conference state.

val id: String

Conference identifier (which is the same as the room identifier).

isLocalAudioEnabled

val isLocalAudioEnabled: Boolean

True if the user is sharing audio and it is enabled.

isLocalVideoEnabled

val isLocalVideoEnabled: Boolean

True if the user is sharing video and it is enabled.

isRecordingEnabled

val isRecordingEnabled: Boolean

True if the conference is being recorded.

isRemoteAudioEnabled

val isRemoteAudioEnabled: Boolean

True if the remote audio is enabled.

val rx: ConferenceRx

Access to the reactive API of the conference.

Functions

acceptAttendedTransfer

fun acceptAttendedTransfer(onCompletion: (ConferenceError?) -> Unit)

Accepts an attended transfer in progress.

acceptTransfer

fun ~~acceptTransfer~~(context: Context, transfer: Transfer, mediaTypes: List<MediaType>? = null)

Accept an incoming transfer.

addListener

fun addListener(listener: ConferenceListener)

Adds a listener to receive different events related to this conference.

addMediaListener

fun addMediaListener(listener: ConferenceMediaListener)

Adds a listener to receive different media events related to this conference.

cancelAttendedTransfer

fun cancelAttendedTransfer(onCompletion: (ConferenceError?) -> Unit)

Cancels an attended transfer in progress.

cancelInviteToParticipant

fun cancelInviteToParticipant(participant: Participant, onCompletion: (ConferenceError?) -> Unit)

Cancels the invitation made for the user to the specified participant.

displayLocalVideo

fun displayLocalVideo(videoRenderer: SurfaceViewRenderer, aspect: RendererCommon.ScalingType, pip: Boolean)

Displays the local video in the specified videoRenderer if the user is sharing it. It should be called after receiving the event notifying that the local video has been added to the conference or when, once the video is being rendered, the videoRenderer needs to be changed. IMPORTANT: The videoRenderer used should be released (videoRenderer.release()) once the view is destroyed.

displayRemoteVideo

fun displayRemoteVideo(participantName: String, videoRenderer: SurfaceViewRenderer, aspect: RendererCommon.ScalingType, pip: Boolean)

Displays the remote video of the participant specified by participantName in the indicated videoRenderer if they are sharing it. It should be called after receiving the event notifying that the video for that participant has been added to the conference or when, once the video is being rendered, the videoRenderer needs to be changed. IMPORTANT: The videoRenderer used should be released (videoRenderer.release()) once the view is destroyed.

enableLocalAudio

fun enableLocalAudio(isEnabled: Boolean)

Enables/disables the local audio.

enableLocalVideo

fun enableLocalVideo(isEnabled: Boolean)

Enables/disables the local video.

enableRemoteAudio

fun enableRemoteAudio(isEnabled: Boolean)

Enables/disables the remote audio of the current Conference.

enableRemoteVideo

fun enableRemoteVideo(participantName: String, isEnabled: Boolean)

Enables/disables the remote video of the participant specified by participantName.

expelParticipant

fun expelParticipant(participant: Participant, onCompletion: (ConferenceError?) -> Unit)

Expels the specified participant from this conference.

getInvitations

fun getInvitations(onCompletion: (List<Invitation>) -> Unit)

Fetches all the invitations made for the user to this conference.

getParticipants

fun getParticipants(onCompletion: (Either<List<Participant>, ConferenceError>) -> Unit)

Fetches the current conference participants, including the local user.

hangup

fun hangup()

Declines this conference.

hold

fun hold(onCompletion: (ConferenceError?) -> Unit)

Hold the current conference.

inviteParticipant

fun inviteParticipant(callee: String, context: Context, requestedMediaTypes: List<MediaType> = listOf(MediaType.AUDIO, MediaType.VIDEO), joinOnAnswer: Boolean = true)

Invites a new participant to this conference.

join

fun join(context: Context, mediaTypes: List<MediaType>? = null)

Allows the user to join this conference.

previewRemoteVideo

fun previewRemoteVideo()

Allows the user to preview remote media before joining/declining the conference. IMPORTANT: This method does not join the user to the conference. The join action has to be explicit.

removeListener

fun removeListener(listener: ConferenceListener)

Removes the specified listener.

removeMediaListener

fun removeMediaListener(listener: ConferenceMediaListener)

Removes the specified listener.

sendDtmf

fun sendDtmf(digit: Dtmf, onCompletion: (ConferenceError?) -> Unit)

Sends the provided digit tone to the current Conference.

swapVideos

fun swapVideos(participantNameA: String, participantNameB: String)

Swaps the videos of the specified participants. It should be called once both videos are being displayed if the surfaces on which they are being rendered are to be exchanged.

switchCamera

fun switchCamera()

Swaps the physical device used to capture the video. It should be used when the local user is already sharing video.

transferConference

fun transferConference(callee: String, mediaTypes: List<MediaType>? = null, onCompletion: (ConferenceError?) -> Unit)

Transfer the current conference to the specified Callee.

unhold

fun unhold(onCompletion: (ConferenceError?) -> Unit)

Unhold the current conference.

updateMedia

fun updateMedia(context: Context, mediaTypes: List<MediaType>, onCompletion: (ConferenceError?) -> Unit)

Updates the media types shared by the user, overridden the current ones.