RemoteConference

Kotlin |Java

class RemoteConference

kotlin.Any
↳	android.telecom.RemoteConference

A conference provided to a ConnectionService by another ConnectionService through ConnectionService#conferenceRemoteConnections. Once created, a RemoteConference can be used to control the conference call or monitor changes through RemoteConnection.Callback.

Summary

Nested classes
abstract	`Callback` Callback base class for `RemoteConference`.

Public methods
Unit	`disconnect()` Disconnects the conference call as well as the child `RemoteConnection`s.
MutableList<RemoteConnection!>!	`getConferenceableConnections()` Returns a list of independent connections that can me merged with this conference.
Int	`getConnectionCapabilities()` Returns the capabilities of the conference.
Int	`getConnectionProperties()` Returns the properties of the conference.
MutableList<RemoteConnection!>!	`getConnections()` Returns the list of `RemoteConnection`s contained in this conference.
DisconnectCause!	`getDisconnectCause()` Returns the `DisconnectCause` for the conference if it is in the state `Connection#STATE_DISCONNECTED`.
Bundle!	`getExtras()` Obtain the extras associated with this `RemoteConnection`.
Int	`getState()` Gets the state of the conference call.
Unit	`hold()` Puts the conference on hold.
Unit	`merge()` Merges all `RemoteConnection`s of this conference into a single call.
Unit	`playDtmfTone(digit: Char)` Requests that the conference start playing the specified DTMF tone.
Unit	`registerCallback(callback: RemoteConference.Callback!)` Register a callback through which to receive state updates for this conference.
Unit	`registerCallback(callback: RemoteConference.Callback!, handler: Handler!)` Registers a callback through which to receive state updates for this conference.
Unit	`separate(connection: RemoteConnection!)` Removes the specified `RemoteConnection` from the conference.
Unit	`setCallAudioState(state: CallAudioState!)` Request to change the conference's audio routing to the specified state.
Unit	`stopDtmfTone()` Stops the most recent request to play a DTMF tone.
Unit	`swap()` Swaps the active audio stream between the conference's child `RemoteConnection`s.
Unit	`unhold()` Unholds the conference call.
Unit	`unregisterCallback(callback: RemoteConference.Callback!)` Unregisters a previously registered callback.

Public methods

disconnect

Added in API level 23

fun disconnect(): Unit

Disconnects the conference call as well as the child RemoteConnections.

getConferenceableConnections

Added in API level 23

fun getConferenceableConnections(): MutableList<RemoteConnection!>!

Returns a list of independent connections that can me merged with this conference.

Return
`MutableList<RemoteConnection!>!`	A list of conferenceable connections.

getConnectionCapabilities

Added in API level 23

fun getConnectionCapabilities(): Int

Returns the capabilities of the conference. See CAPABILITY_* constants in class Connection for valid values.

Return
`Int`	A bitmask of the capabilities of the conference call.

getConnectionProperties

Added in API level 24

fun getConnectionProperties(): Int

Returns the properties of the conference. See PROPERTY_* constants in class Connection for valid values.

Return
`Int`	A bitmask of the properties of the conference call.

getConnections

Added in API level 23

fun getConnections(): MutableList<RemoteConnection!>!

Returns the list of RemoteConnections contained in this conference.

Return
`MutableList<RemoteConnection!>!`	A list of child connections.

getDisconnectCause

Added in API level 23

fun getDisconnectCause(): DisconnectCause!

Returns the DisconnectCause for the conference if it is in the state Connection#STATE_DISCONNECTED. If the conference is not disconnected, this will return null.

Return
`DisconnectCause!`	The disconnect cause.

getExtras

Added in API level 23

fun getExtras(): Bundle!

Obtain the extras associated with this RemoteConnection.

Return
`Bundle!`	The extras for this connection.

getState

Added in API level 23

fun getState(): Int

Gets the state of the conference call. See Connection for valid values.

Return
`Int`	A constant representing the state the conference call is currently in.

hold

Added in API level 23

fun hold(): Unit

Puts the conference on hold.

merge

Added in API level 23

fun merge(): Unit

Merges all RemoteConnections of this conference into a single call. This should be invoked only if the conference contains the capability Connection#CAPABILITY_MERGE_CONFERENCE, otherwise it is a no-op. The presence of said capability indicates that the connections of this conference, despite being part of the same conference object, are yet to have their audio streams merged; this is a common pattern for CDMA conference calls, but the capability is not used for GSM and SIP conference calls. Invoking this method will cause the unmerged child connections to merge their audio streams.

playDtmfTone

Added in API level 23

fun playDtmfTone(digit: Char): Unit

Requests that the conference start playing the specified DTMF tone.

Parameters
`digit`	Char: The digit for which to play a DTMF tone.

registerCallback

Added in API level 23

fun registerCallback(callback: RemoteConference.Callback!): Unit

Parameters
`callback`	RemoteConference.Callback!: The callback to notify of state changes.

registerCallback

Added in API level 23

fun registerCallback(
    callback: RemoteConference.Callback!, 
    handler: Handler!
): Unit

Registers a callback through which to receive state updates for this conference. Callbacks will be notified using the specified handler, if provided.

Parameters
`callback`	RemoteConference.Callback!: The callback to notify of state changes.
`handler`	Handler!: The handler on which to execute the callbacks.

separate

Added in API level 23

fun separate(connection: RemoteConnection!): Unit

Removes the specified RemoteConnection from the conference. This causes the RemoteConnection to become a standalone connection. This is a no-op if the RemoteConnection does not belong to this conference.

Parameters
`connection`	RemoteConnection!: The remote-connection to remove.

setCallAudioState

Added in API level 23

fun setCallAudioState(state: CallAudioState!): Unit

Request to change the conference's audio routing to the specified state. The specified state can include audio routing (Bluetooth, Speaker, etc) and muting state.

stopDtmfTone

Added in API level 23

fun stopDtmfTone(): Unit

Stops the most recent request to play a DTMF tone.

See Also

#playDtmfTone

swap

Added in API level 23

fun swap(): Unit

Swaps the active audio stream between the conference's child RemoteConnections. This should be invoked only if the conference contains the capability Connection#CAPABILITY_SWAP_CONFERENCE, otherwise it is a no-op. This is only used by ConnectionServices that create conferences for connections that do not yet have their audio streams merged; this is a common pattern for CDMA conference calls, but the capability is not used for GSM and SIP conference calls. Invoking this method will change the active audio stream to a different child connection.

unhold

Added in API level 23

fun unhold(): Unit

Unholds the conference call.

unregisterCallback

Added in API level 23

fun unregisterCallback(callback: RemoteConference.Callback!): Unit

Unregisters a previously registered callback.

Parameters
`callback`	RemoteConference.Callback!: The callback to unregister.

See Also