Merge "Add RemoteConference javadocs." into mnc-dev (2d9a9c2a) · Commits · e / os / android_frameworks_base

telecomm/java/android/telecom/Conference.java

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -116,7 +116,7 @@ public abstract class Conference implements Conferenceable {
	}		}

	/**		/**
	* Returns the capabilities of a conference. See {@code CAPABILITY_*} constants in class		* Returns the capabilities of the conference. See {@code CAPABILITY_*} constants in class
	* {@link Connection} for valid values.		* {@link Connection} for valid values.
	*		*
	* @return A bitmask of the capabilities of the conference call.		* @return A bitmask of the capabilities of the conference call.

telecomm/java/android/telecom/RemoteConference.java

+110 −9

Original line number	Original line	Diff line number	Diff line
	@@ -29,7 +29,10 @@ import java.util.concurrent.CopyOnWriteArrayList;
	import java.util.concurrent.CopyOnWriteArraySet;		import java.util.concurrent.CopyOnWriteArraySet;

	/**		/**
	* Represents a conference call which can contain any number of {@link Connection} objects.		* A conference provided to a {@link ConnectionService} by another {@code ConnectionService}
			* running in a different process.
			*
			* @see ConnectionService#onRemoteConferenceAdded
	*/		*/
	public final class RemoteConference {		public final class RemoteConference {

	@@ -62,18 +65,18 @@ public final class RemoteConference {
	private DisconnectCause mDisconnectCause;		private DisconnectCause mDisconnectCause;
	private int mConnectionCapabilities;		private int mConnectionCapabilities;

	/** {@hide} */		/** @hide */
	RemoteConference(String id, IConnectionService connectionService) {		RemoteConference(String id, IConnectionService connectionService) {
	mId = id;		mId = id;
	mConnectionService = connectionService;		mConnectionService = connectionService;
	}		}

	/** {@hide} */		/** @hide */
	String getId() {		String getId() {
	return mId;		return mId;
	}		}

	/** {@hide} */		/** @hide */
	void setDestroyed() {		void setDestroyed() {
	for (RemoteConnection connection : mChildConnections) {		for (RemoteConnection connection : mChildConnections) {
	connection.setConference(null);		connection.setConference(null);
	@@ -90,7 +93,7 @@ public final class RemoteConference {
	}		}
	}		}

	/** {@hide} */		/** @hide */
	void setState(final int newState) {		void setState(final int newState) {
	if (newState != Connection.STATE_ACTIVE &&		if (newState != Connection.STATE_ACTIVE &&
	newState != Connection.STATE_HOLDING &&		newState != Connection.STATE_HOLDING &&
	@@ -116,7 +119,7 @@ public final class RemoteConference {
	}		}
	}		}

	/** {@hide} */		/** @hide */
	void addConnection(final RemoteConnection connection) {		void addConnection(final RemoteConnection connection) {
	if (!mChildConnections.contains(connection)) {		if (!mChildConnections.contains(connection)) {
	mChildConnections.add(connection);		mChildConnections.add(connection);
	@@ -134,7 +137,7 @@ public final class RemoteConference {
	}		}
	}		}

	/** {@hide} */		/** @hide */
	void removeConnection(final RemoteConnection connection) {		void removeConnection(final RemoteConnection connection) {
	if (mChildConnections.contains(connection)) {		if (mChildConnections.contains(connection)) {
	mChildConnections.remove(connection);		mChildConnections.remove(connection);
	@@ -152,7 +155,7 @@ public final class RemoteConference {
	}		}
	}		}

	/** {@hide} */		/** @hide */
	void setConnectionCapabilities(final int connectionCapabilities) {		void setConnectionCapabilities(final int connectionCapabilities) {
	if (mConnectionCapabilities != connectionCapabilities) {		if (mConnectionCapabilities != connectionCapabilities) {
	mConnectionCapabilities = connectionCapabilities;		mConnectionCapabilities = connectionCapabilities;
	@@ -187,7 +190,7 @@ public final class RemoteConference {
	}		}
	}		}

	/** {@hide} */		/** @hide */
	void setDisconnected(final DisconnectCause disconnectCause) {		void setDisconnected(final DisconnectCause disconnectCause) {
	if (mState != Connection.STATE_DISCONNECTED) {		if (mState != Connection.STATE_DISCONNECTED) {
	mDisconnectCause = disconnectCause;		mDisconnectCause = disconnectCause;
	@@ -205,18 +208,37 @@ public final class RemoteConference {
	}		}
	}		}

			/**
			* Returns the list of {@link RemoteConnection}s contained in this conference.
			*
			* @return A list of child connections.
			*/
	public final List<RemoteConnection> getConnections() {		public final List<RemoteConnection> getConnections() {
	return mUnmodifiableChildConnections;		return mUnmodifiableChildConnections;
	}		}

			/**
			* Gets the state of the conference call. See {@link Connection} for valid values.
			*
			* @return A constant representing the state the conference call is currently in.
			*/
	public final int getState() {		public final int getState() {
	return mState;		return mState;
	}		}

			/**
			* Returns the capabilities of the conference. See {@code CAPABILITY_*} constants in class
			* {@link Connection} for valid values.
			*
			* @return A bitmask of the capabilities of the conference call.
			*/
	public final int getConnectionCapabilities() {		public final int getConnectionCapabilities() {
	return mConnectionCapabilities;		return mConnectionCapabilities;
	}		}

			/**
			* Disconnects the conference call as well as the child {@link RemoteConnection}s.
			*/
	public void disconnect() {		public void disconnect() {
	try {		try {
	mConnectionService.disconnect(mId);		mConnectionService.disconnect(mId);
	@@ -224,6 +246,13 @@ public final class RemoteConference {
	}		}
	}		}

			/**
			* Removes the specified {@link RemoteConnection} from the conference. This causes the
			* {@link RemoteConnection} to become a standalone connection. This is a no-op if the
			* {@link RemoteConnection} does not belong to this conference.
			*
			* @param connection The remote-connection to remove.
			*/
	public void separate(RemoteConnection connection) {		public void separate(RemoteConnection connection) {
	if (mChildConnections.contains(connection)) {		if (mChildConnections.contains(connection)) {
	try {		try {
	@@ -233,6 +262,16 @@ public final class RemoteConference {
	}		}
	}		}

			/**
			* Merges all {@link RemoteConnection}s of this conference into a single call. This should be
			* invoked only if the conference contains the capability
			* {@link 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.
			*/
	public void merge() {		public void merge() {
	try {		try {
	mConnectionService.mergeConference(mId);		mConnectionService.mergeConference(mId);
	@@ -240,6 +279,15 @@ public final class RemoteConference {
	}		}
	}		}

			/**
			* Swaps the active audio stream between the conference's child {@link RemoteConnection}s.
			* This should be invoked only if the conference contains the capability
			* {@link Connection#CAPABILITY_SWAP_CONFERENCE}, otherwise it is a no-op. This is only used by
			* {@link 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.
			*/
	public void swap() {		public void swap() {
	try {		try {
	mConnectionService.swapConference(mId);		mConnectionService.swapConference(mId);
	@@ -247,6 +295,9 @@ public final class RemoteConference {
	}		}
	}		}

			/**
			* Puts the conference on hold.
			*/
	public void hold() {		public void hold() {
	try {		try {
	mConnectionService.hold(mId);		mConnectionService.hold(mId);
	@@ -254,6 +305,9 @@ public final class RemoteConference {
	}		}
	}		}

			/**
			* Unholds the conference call.
			*/
	public void unhold() {		public void unhold() {
	try {		try {
	mConnectionService.unhold(mId);		mConnectionService.unhold(mId);
	@@ -261,10 +315,22 @@ public final class RemoteConference {
	}		}
	}		}

			/**
			* Returns the {@link DisconnectCause} for the conference if it is in the state
			* {@link Connection#STATE_DISCONNECTED}. If the conference is not disconnected, this will
			* return null.
			*
			* @return The disconnect cause.
			*/
	public DisconnectCause getDisconnectCause() {		public DisconnectCause getDisconnectCause() {
	return mDisconnectCause;		return mDisconnectCause;
	}		}

			/**
			* Requests that the conference start playing the specified DTMF tone.
			*
			* @param digit The digit for which to play a DTMF tone.
			*/
	public void playDtmfTone(char digit) {		public void playDtmfTone(char digit) {
	try {		try {
	mConnectionService.playDtmfTone(mId, digit);		mConnectionService.playDtmfTone(mId, digit);
	@@ -272,6 +338,11 @@ public final class RemoteConference {
	}		}
	}		}

			/**
			* Stops the most recent request to play a DTMF tone.
			*
			* @see #playDtmfTone
			*/
	public void stopDtmfTone() {		public void stopDtmfTone() {
	try {		try {
	mConnectionService.stopDtmfTone(mId);		mConnectionService.stopDtmfTone(mId);
	@@ -279,6 +350,12 @@ public final class RemoteConference {
	}		}
	}		}

			/**
			* 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.
			*
			* @see android.telecom.AudioState
			*/
	public void setAudioState(AudioState state) {		public void setAudioState(AudioState state) {
	try {		try {
	mConnectionService.onAudioStateChanged(mId, state);		mConnectionService.onAudioStateChanged(mId, state);
	@@ -286,14 +363,31 @@ public final class RemoteConference {
	}		}
	}		}

			/**
			* Returns a list of independent connections that can me merged with this conference.
			*
			* @return A list of conferenceable connections.
			*/
	public List<RemoteConnection> getConferenceableConnections() {		public List<RemoteConnection> getConferenceableConnections() {
	return mUnmodifiableConferenceableConnections;		return mUnmodifiableConferenceableConnections;
	}		}

			/**
			* Register a callback through which to receive state updates for this conference.
			*
			* @param callback The callback to notify of state changes.
			*/
	public final void registerCallback(Callback callback) {		public final void registerCallback(Callback callback) {
	registerCallback(callback, new Handler());		registerCallback(callback, new Handler());
	}		}

			/**
			* Registers a callback through which to receive state updates for this conference.
			* Callbacks will be notified using the specified handler, if provided.
			*
			* @param callback The callback to notify of state changes.
			* @param handler The handler on which to execute the callbacks.
			*/
	public final void registerCallback(Callback callback, Handler handler) {		public final void registerCallback(Callback callback, Handler handler) {
	unregisterCallback(callback);		unregisterCallback(callback);
	if (callback != null && handler != null) {		if (callback != null && handler != null) {
	@@ -301,6 +395,13 @@ public final class RemoteConference {
	}		}
	}		}

			/**
			* Unregisters a previously registered callback.
			*
			* @see #registerCallback
			*
			* @param callback The callback to unregister.
			*/
	public final void unregisterCallback(Callback callback) {		public final void unregisterCallback(Callback callback) {
	if (callback != null) {		if (callback != null) {
	for (CallbackRecord<Callback> record : mCallbackRecords) {		for (CallbackRecord<Callback> record : mCallbackRecords) {