public
final
class
RemoteConference
extends Object
java.lang.Object | |
↳ | android.telecom.RemoteConference |
A conference provided to a ConnectionService
by another ConnectionService
through
conferenceRemoteConnections(RemoteConnection, RemoteConnection)
. Once created, a RemoteConference
can be used to control the conference call or monitor changes through
RemoteConnection.Callback
.
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. |
final
int
|
getConnectionCapabilities()
Returns the capabilities of the conference. |
final
int
|
getConnectionProperties()
Returns the properties of the conference. |
final
List<RemoteConnection>
|
getConnections()
Returns the list of |
DisconnectCause
|
getDisconnectCause()
Returns the |
final
Bundle
|
getExtras()
Obtain the extras associated with this |
final
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. |
final
void
|
registerCallback(RemoteConference.Callback callback, Handler handler)
Registers a callback through which to receive state updates for this conference. |
final
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. |
final
void
|
unregisterCallback(RemoteConference.Callback callback)
Unregisters a previously registered callback. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
void disconnect ()
Disconnects the conference call as well as the child RemoteConnection
s.
List<RemoteConnection> getConferenceableConnections ()
Returns a list of independent connections that can me merged with this conference.
Returns | |
---|---|
List<RemoteConnection> |
A list of conferenceable connections. |
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. |
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. |
List<RemoteConnection> getConnections ()
Returns the list of RemoteConnection
s contained in this conference.
Returns | |
---|---|
List<RemoteConnection> |
A list of child connections. |
DisconnectCause getDisconnectCause ()
Returns the DisconnectCause
for the conference if it is in the state
STATE_DISCONNECTED
. If the conference is not disconnected, this will
return null.
Returns | |
---|---|
DisconnectCause |
The disconnect cause. |
Bundle getExtras ()
Obtain the extras associated with this RemoteConnection
.
Returns | |
---|---|
Bundle |
The extras for this connection. |
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. |
void merge ()
Merges all RemoteConnection
s of this conference into a single call. This should be
invoked only if the conference contains the capability
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.
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.
|
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.
|
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.
|
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.
|
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
|
void stopDtmfTone ()
Stops the most recent request to play a DTMF tone.
See also:
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
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.
void unregisterCallback (RemoteConference.Callback callback)
Unregisters a previously registered callback.
Parameters | |
---|---|
callback |
RemoteConference.Callback :
The callback to unregister.
|