RemoteConference
public
final
class
RemoteConference
extends Object
java.lang.Object | |
↳ | 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 | |
---|---|
class |
RemoteConference.Callback
Callback base class for |
Public methods | |
---|---|
void
|
disconnect()
Disconnects the conference call as well as the child |
List<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. |
List<RemoteConnection>
|
getConnections()
Returns the list of |
DisconnectCause
|
getDisconnectCause()
Returns the |
Bundle
|
getExtras()
Obtain the extras associated with this |
int
|
getState()
Gets the state of the conference call. |
void
|
hold()
Puts the conference on hold. |
void
|
merge()
Merges all |
void
|
playDtmfTone(char digit)
Requests that the conference start playing the specified DTMF tone. |
void
|
registerCallback(RemoteConference.Callback callback, Handler handler)
Registers a callback through which to receive state updates for this conference. |
void
|
registerCallback(RemoteConference.Callback callback)
Register a callback through which to receive state updates for this conference. |
void
|
separate(RemoteConnection connection)
Removes the specified |
void
|
setCallAudioState(CallAudioState state)
Request to change the conference's audio routing to the specified state. |
void
|
stopDtmfTone()
Stops the most recent request to play a DTMF tone. |
void
|
swap()
Swaps the active audio stream between the conference's child |
void
|
unhold()
Unholds the conference call. |
void
|
unregisterCallback(RemoteConference.Callback callback)
Unregisters a previously registered callback. |
Inherited methods | |
---|---|
Public methods
disconnect
public void disconnect ()
Disconnects the conference call as well as the child RemoteConnection
s.
getConferenceableConnections
public List<RemoteConnection> getConferenceableConnections ()
Returns a list of independent connections that can me merged with this conference.
Returns | |
---|---|
List<RemoteConnection> |
A list of conferenceable connections. |
getConnectionCapabilities
public int getConnectionCapabilities ()
Returns the capabilities of the conference. See CAPABILITY_*
constants in class
Connection
for valid values.
Returns | |
---|---|
int |
A bitmask of the capabilities of the conference call. |
getConnectionProperties
public int getConnectionProperties ()
Returns the properties of the conference. See PROPERTY_*
constants in class
Connection
for valid values.
Returns | |
---|---|
int |
A bitmask of the properties of the conference call. |
getConnections
public List<RemoteConnection> getConnections ()
Returns the list of RemoteConnection
s contained in this conference.
Returns | |
---|---|
List<RemoteConnection> |
A list of child connections. |
getDisconnectCause
public DisconnectCause getDisconnectCause ()
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.
Returns | |
---|---|
DisconnectCause |
The disconnect cause. |
getExtras
public Bundle getExtras ()
Obtain the extras associated with this RemoteConnection
.
Returns | |
---|---|
Bundle |
The extras for this connection. |
getState
public int getState ()
Gets the state of the conference call. See Connection
for valid values.
Returns | |
---|---|
int |
A constant representing the state the conference call is currently in. |
merge
public void merge ()
Merges all RemoteConnection
s 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
public void playDtmfTone (char digit)
Requests that the conference start playing the specified DTMF tone.
Parameters | |
---|---|
digit |
char : The digit for which to play a DTMF tone. |
registerCallback
public void registerCallback (RemoteConference.Callback callback, Handler handler)
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. |
registerCallback
public void registerCallback (RemoteConference.Callback callback)
Register a callback through which to receive state updates for this conference.
Parameters | |
---|---|
callback |
RemoteConference.Callback : The callback to notify of state changes. |
separate
public void separate (RemoteConnection connection)
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
public void setCallAudioState (CallAudioState state)
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.
Parameters | |
---|---|
state |
CallAudioState |
stopDtmfTone
public void stopDtmfTone ()
Stops the most recent request to play a DTMF tone.
See also:
swap
public void swap ()
Swaps the active audio stream between the conference's child RemoteConnection
s.
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
ConnectionService
s 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.
unregisterCallback
public void unregisterCallback (RemoteConference.Callback callback)
Unregisters a previously registered callback.
Parameters | |
---|---|
callback |
RemoteConference.Callback : The callback to unregister. |
See also:
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-04 UTC.