aace::phoneCallController::PhoneCallControllerEngineInterface Class Reference

Public Types
enum	ConnectionState {   ConnectionState::CONNECTED,   ConnectionState::DISCONNECTED }
enum	CallState {   CallState::IDLE,   CallState::DIALING,   CallState::OUTBOUND_RINGING,   CallState::ACTIVE,   CallState::CALL_RECEIVED,   CallState::INBOUND_RINGING }
enum	CallingDeviceConfigurationProperty { CallingDeviceConfigurationProperty::DTMF_SUPPORTED }
enum	CallError {   CallError::NO_CARRIER,   CallError::BUSY,   CallError::NO_ANSWER,   CallError::NO_NUMBER_FOR_REDIAL,   CallError::OTHER }
enum	DTMFError {   DTMFError::CALL_NOT_IN_PROGRESS,   DTMFError::DTMF_FAILED }

Detailed Description

PhoneCallControllerEngineInterface

Member Enumeration Documentation

ConnectionState

enum aace::phoneCallController::PhoneCallControllerEngineInterface::ConnectionState

strong

Describes the state of connection to a calling device

See also

PhoneCallController::connectionStateChanged

Enumerator
CONNECTED	A calling device is connected.
DISCONNECTED	No calling device is connected.

CallState

enum aace::phoneCallController::PhoneCallControllerEngineInterface::CallState

strong

Describes the state of a call

See also

PhoneCallController::callStateChanged

Enumerator
IDLE	The call is not in an active state. The following are possible transitions to IDLE state: While in DIALING or OUTBOUND_RINGING, the user requested to hang up or cancel the outbound call While in ACTIVE state, the user hangs up the active call. While in CALL_RECEIVED or INBOUND_RINGING state, the user requested to ignore or reject the inbound call.
DIALING	The outbound call is initiated by the user. Call setup is in progress.
OUTBOUND_RINGING	The outbound call has been set up, and the remote party is alerted.
ACTIVE	The call is active, and media is being transmitted between the caller and remote party. The following are possible transitions to ACTIVE state: While in DIALING or OUTBOUND_RINGING, outbound call setup is successfully completed. While in INBOUND_RINGING, the user accepted the call, and setup is completed. When transitioning from DISCONNECTED to CONNECTED, and the calling device is already in an active call.
CALL_RECEIVED	An alert for the inbound call has been received.
INBOUND_RINGING	The inbound call is ringing.

CallingDeviceConfigurationProperty

enum aace::phoneCallController::PhoneCallControllerEngineInterface::CallingDeviceConfigurationProperty

strong

Describes a configuration property of a connected calling device. Configure properties with PhoneCallController::deviceConfigurationUpdated

Enumerator
DTMF_SUPPORTED	Whether the device supports DTMF signaling. Set true to indicate support for DTMF. Set false when DTMF signaling is not implemented or the current calling device configuration does not support DTMF. Default setting: false

CallError

enum aace::phoneCallController::PhoneCallControllerEngineInterface::CallError

strong

Describes an error for a failed call

See also

PhoneCallController::callFailed

Enumerator
NO_CARRIER	No carrier is available on the calling device.
BUSY	The calling device is busy when setting up an outbound call, such as when a call is already in progress.
NO_ANSWER	The remote party did not answer the call.
NO_NUMBER_FOR_REDIAL	Redial was requested, but there is no previously dialed number available.
OTHER	Generic error

DTMFError

enum aace::phoneCallController::PhoneCallControllerEngineInterface::DTMFError

strong

Describes an error preventing a DTMF signal from being delivered

See also

PhoneCallController::sendDTMFFailed

Enumerator
CALL_NOT_IN_PROGRESS	There is no active call through which a DTMF signal can be sent.
DTMF_FAILED	Generic DTMF error