Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#nestedclasses) \| [Constants](https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#constants) \| [Inherited Constants](https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#inhconstants) \| [Methods](https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#inhmethods)
# ImsMmTelManager
*** ** * ** ***
`
public
class
ImsMmTelManager
`
`
extends https://developer.android.com/reference/java/lang/Object
`
`
implements
https://developer.android.com/reference/android/telephony/ims/RegistrationManager
`
|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.telephony.ims.ImsMmTelManager |
*** ** * ** ***
A manager for the MmTel (Multimedia Telephony) feature of an IMS network, given an associated
subscription.
Allows a user to query the IMS MmTel feature information for a subscription, register for
registration and MmTel capability status callbacks, as well as query/modify user settings for the
associated subscription.
Use `https://developer.android.com/reference/android/telephony/ims/ImsManager#getImsMmTelManager(int)` to get an instance of this
manager.
Requires the `https://developer.android.com/reference/android/content/pm/PackageManager#FEATURE_TELEPHONY_IMS` feature which can be detected using `https://developer.android.com/reference/android/content/pm/PackageManager#hasSystemFeature(java.lang.String)`.
## Summary
| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager.CapabilityCallback` Receives IMS capability status updates from the ImsService. |
| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#WIFI_MODE_CELLULAR_PREFERRED` Prefer registering for IMS over LTE if LTE signal quality is high enough. |
| `int` | `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#WIFI_MODE_WIFI_ONLY` Register for IMS over IWLAN if WiFi signal quality is high enough. |
| `int` | `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#WIFI_MODE_WIFI_PREFERRED` Prefer registering for IMS over IWLAN if possible if WiFi signal quality is high enough. |
| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/telephony/ims/RegistrationManager` |---|---| | `int` | `https://developer.android.com/reference/android/telephony/ims/RegistrationManager#REGISTRATION_STATE_NOT_REGISTERED` The IMS service is currently not registered to the carrier network. | | `int` | `https://developer.android.com/reference/android/telephony/ims/RegistrationManager#REGISTRATION_STATE_REGISTERED` The IMS service is currently registered to the carrier network. | | `int` | `https://developer.android.com/reference/android/telephony/ims/RegistrationManager#REGISTRATION_STATE_REGISTERING` The IMS service is currently in the process of registering to the carrier network. | |
| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#getRegistrationState(java.util.concurrent.Executor,%20java.util.function.Consumer)(https://developer.android.com/reference/java/util/concurrent/Executor executor, https://developer.android.com/reference/java/util/function/Consumer stateCallback) ` Gets the registration state of the IMS service. Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE |
| ` void` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#getRegistrationTransportType(java.util.concurrent.Executor,%20java.util.function.Consumer)(https://developer.android.com/reference/java/util/concurrent/Executor executor, https://developer.android.com/reference/java/util/function/Consumer transportTypeCallback) `
Requires Permission: `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` or that the calling app has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`). |
| ` int` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#getVoWiFiModeSetting()() ` Returns the user's voice over WiFi Roaming mode setting associated with the device. |
| ` boolean` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#isAdvancedCallingSettingEnabled()() ` Query the user\\u2019s setting for \\u201cAdvanced Calling\\u201d or "Enhanced 4G LTE", which is used to enable MmTel IMS features, depending on the carrier configuration for the current subscription. |
| ` boolean` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#isCrossSimCallingEnabled()() ` This configuration is meaningful only on dual sim device. |
| ` boolean` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#isTtyOverVolteEnabled()() ` Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` |
| ` boolean` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#isVoWiFiRoamingSettingEnabled()() ` Returns the user's voice over WiFi roaming setting associated with the current subscription. |
| ` boolean` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#isVoWiFiSettingEnabled()() ` Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` |
| ` boolean` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#isVtSettingEnabled()() ` The user's setting for whether or not they have enabled the "Video Calling" setting. |
| ` void` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#registerImsRegistrationCallback(java.util.concurrent.Executor,%20android.telephony.ims.RegistrationManager.RegistrationCallback)(https://developer.android.com/reference/java/util/concurrent/Executor executor, https://developer.android.com/reference/android/telephony/ims/RegistrationManager.RegistrationCallback c) `
Requires Permission: `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` or that the calling app has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`). |
| ` void` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#registerImsStateCallback(java.util.concurrent.Executor,%20android.telephony.ims.ImsStateCallback)(https://developer.android.com/reference/java/util/concurrent/Executor executor, https://developer.android.com/reference/android/telephony/ims/ImsStateCallback callback) ` Register a new callback, which is used to notify the registrant of changes to the state of the underlying IMS service that is attached to telephony to implement IMS functionality. |
| ` void` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#registerMmTelCapabilityCallback(java.util.concurrent.Executor,%20android.telephony.ims.ImsMmTelManager.CapabilityCallback)(https://developer.android.com/reference/java/util/concurrent/Executor executor, https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager.CapabilityCallback c) ` Registers a `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager.CapabilityCallback` with the system, which will provide MmTel service availability updates for the subscription specified in `https://developer.android.com/reference/android/telephony/ims/ImsManager#getImsMmTelManager(int)`. |
| ` void` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#unregisterImsRegistrationCallback(android.telephony.ims.RegistrationManager.RegistrationCallback)(https://developer.android.com/reference/android/telephony/ims/RegistrationManager.RegistrationCallback c) `
Requires Permission: `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` or that the calling app has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`). |
| ` void` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#unregisterImsStateCallback(android.telephony.ims.ImsStateCallback)(https://developer.android.com/reference/android/telephony/ims/ImsStateCallback callback) ` Unregisters a previously registered callback. |
| ` void` | ` https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#unregisterMmTelCapabilityCallback(android.telephony.ims.ImsMmTelManager.CapabilityCallback)(https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager.CapabilityCallback c) ` Removes an existing MmTel `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager.CapabilityCallback`. |
| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/android/telephony/ims/RegistrationManager ` |---|---| | ` abstract void` | ` https://developer.android.com/reference/android/telephony/ims/RegistrationManager#getRegistrationState(java.util.concurrent.Executor,%20java.util.function.Consumer)(https://developer.android.com/reference/java/util/concurrent/Executor executor, https://developer.android.com/reference/java/util/function/Consumer stateCallback) ` Gets the registration state of the IMS service. | | ` abstract void` | ` https://developer.android.com/reference/android/telephony/ims/RegistrationManager#getRegistrationTransportType(java.util.concurrent.Executor,%20java.util.function.Consumer)(https://developer.android.com/reference/java/util/concurrent/Executor executor, https://developer.android.com/reference/java/util/function/Consumer transportTypeCallback) ` Gets the Transport Type associated with the current IMS registration. | | ` abstract void` | ` https://developer.android.com/reference/android/telephony/ims/RegistrationManager#registerImsRegistrationCallback(java.util.concurrent.Executor,%20android.telephony.ims.RegistrationManager.RegistrationCallback)(https://developer.android.com/reference/java/util/concurrent/Executor executor, https://developer.android.com/reference/android/telephony/ims/RegistrationManager.RegistrationCallback c) ` Registers a `https://developer.android.com/reference/android/telephony/ims/RegistrationManager.RegistrationCallback` with the system. | | ` abstract void` | ` https://developer.android.com/reference/android/telephony/ims/RegistrationManager#unregisterImsRegistrationCallback(android.telephony.ims.RegistrationManager.RegistrationCallback)(https://developer.android.com/reference/android/telephony/ims/RegistrationManager.RegistrationCallback c) ` Removes an existing `https://developer.android.com/reference/android/telephony/ims/RegistrationManager.RegistrationCallback`. | ||
## Constants
### WIFI_MODE_CELLULAR_PREFERRED
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int WIFI_MODE_CELLULAR_PREFERRED
```
Prefer registering for IMS over LTE if LTE signal quality is high enough.
Constant Value:
1
(0x00000001)
### WIFI_MODE_WIFI_ONLY
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int WIFI_MODE_WIFI_ONLY
```
Register for IMS over IWLAN if WiFi signal quality is high enough. Do not hand over to LTE
registration if signal quality degrades.
Constant Value:
0
(0x00000000)
### WIFI_MODE_WIFI_PREFERRED
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int WIFI_MODE_WIFI_PREFERRED
```
Prefer registering for IMS over IWLAN if possible if WiFi signal quality is high enough.
Constant Value:
2
(0x00000002)
## Public methods
### getRegistrationState
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void getRegistrationState (Executor executor,
Consumer stateCallback)
```
Gets the registration state of the IMS service.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE
| Parameters ||
|---|---|
| `executor` | `Executor`: This value cannot be `null`. Callback and listener events are dispatched through this `https://developer.android.com/reference/java/util/concurrent/Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `https://developer.android.com/reference/android/content/Context#getMainExecutor()`. Otherwise, provide an `https://developer.android.com/reference/java/util/concurrent/Executor` that dispatches to an appropriate thread.
|
| `stateCallback` | `Consumer`: This value cannot be `null`. Value is one of the following: - `https://developer.android.com/reference/android/telephony/ims/RegistrationManager#REGISTRATION_STATE_NOT_REGISTERED` - `https://developer.android.com/reference/android/telephony/ims/RegistrationManager#REGISTRATION_STATE_REGISTERING` - `https://developer.android.com/reference/android/telephony/ims/RegistrationManager#REGISTRATION_STATE_REGISTERED` |
### getRegistrationTransportType
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void getRegistrationTransportType (Executor executor,
Consumer transportTypeCallback)
```
Requires Permission: `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` or that the calling app has carrier privileges
(see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`).
Access by profile owners is deprecated and will be removed in a future release.
Gets the Transport Type associated with the current IMS registration.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Parameters ||
|---|---|
| `executor` | `Executor`: This value cannot be `null`. Callback and listener events are dispatched through this `https://developer.android.com/reference/java/util/concurrent/Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `https://developer.android.com/reference/android/content/Context#getMainExecutor()`. Otherwise, provide an `https://developer.android.com/reference/java/util/concurrent/Executor` that dispatches to an appropriate thread.
|
| `transportTypeCallback` | `Consumer`: This value cannot be `null`. Value is one of the following: - `https://developer.android.com/reference/android/telephony/AccessNetworkConstants#TRANSPORT_TYPE_WWAN` - `https://developer.android.com/reference/android/telephony/AccessNetworkConstants#TRANSPORT_TYPE_WLAN` |
### getVoWiFiModeSetting
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getVoWiFiModeSetting ()
```
Returns the user's voice over WiFi Roaming mode setting associated with the device.
This API requires one of the following:
- The caller holds the READ_PRECISE_PHONE_STATE permission.
- If the caller is the device or profile owner, the caller holds the `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` permission.
- The caller has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`) on any active subscription.
The profile owner is an app that owns a managed profile on the device; for more details
see [Work profiles](https://developer.android.com/work/managed-profiles).
Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Returns ||
|---|---|
| `int` | The Voice over WiFi Mode preference set by the user, which can be one of the following: - `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#WIFI_MODE_WIFI_ONLY` - `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#WIFI_MODE_CELLULAR_PREFERRED` - `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#WIFI_MODE_WIFI_PREFERRED` Value is one of the following: - `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#WIFI_MODE_WIFI_ONLY` - `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#WIFI_MODE_CELLULAR_PREFERRED` - `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#WIFI_MODE_WIFI_PREFERRED` |
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | If the device does not have `https://developer.android.com/reference/android/content/pm/PackageManager#FEATURE_TELEPHONY_IMS`. |
### isAdvancedCallingSettingEnabled
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isAdvancedCallingSettingEnabled ()
```
Query the user\\u2019s setting for \\u201cAdvanced Calling\\u201d or "Enhanced 4G LTE", which is used to
enable MmTel IMS features, depending on the carrier configuration for the current
subscription. If this setting is enabled, IMS voice and video telephony over IWLAN/LTE will
be enabled as long as the carrier has provisioned these services for the specified
subscription. Other IMS services (SMS/UT) are not affected by this user setting and depend on
carrier requirements.
Note: If the carrier configuration for advanced calling is not editable or hidden, this
method will always return the default value.
This API requires one of the following:
- The caller holds the READ_PRECISE_PHONE_STATE permission.
- If the caller is the device or profile owner, the caller holds the `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` permission.
- The caller has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`) on any active subscription.
The profile owner is an app that owns a managed profile on the device; for more details
see [Work profiles](https://developer.android.com/work/managed-profiles).
Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Returns ||
|---|---|
| `boolean` | true if the user's setting for advanced calling is enabled, false otherwise.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | If the device does not have `https://developer.android.com/reference/android/content/pm/PackageManager#FEATURE_TELEPHONY_IMS`. |
**See also:**
- `https://developer.android.com/reference/android/telephony/CarrierConfigManager#KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL`
- `https://developer.android.com/reference/android/telephony/CarrierConfigManager#KEY_EDITABLE_ENHANCED_4G_LTE_BOOL`
- `https://developer.android.com/reference/android/telephony/CarrierConfigManager#KEY_HIDE_ENHANCED_4G_LTE_BOOL`
- `https://developer.android.com/reference/android/telephony/CarrierConfigManager#KEY_ENHANCED_4G_LTE_ON_BY_DEFAULT_BOOL`
- `https://developer.android.com/reference/android/telephony/CarrierConfigManager#KEY_CARRIER_VOLTE_AVAILABLE_BOOL`
### isCrossSimCallingEnabled
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isCrossSimCallingEnabled ()
```
This configuration is meaningful only on dual sim device.
If enabled, this will result in the device setting up IMS of all other
active subscriptions over the INTERNET APN of the primary default data subscription
when any of those subscriptions are roaming or out of service and if wifi is not available
for VoWifi. This feature will be disabled if
`https://developer.android.com/reference/android/telephony/CarrierConfigManager#KEY_CARRIER_CROSS_SIM_IMS_AVAILABLE_BOOL` is set to false.
Following are the conditions in which system will try to register IMS over
cross sim
- Wifi is not available, one SIM is roaming and the default data SIM is in home network. Then roaming SIM IMS will be registered over INTERNET APN of the default data subscription
- Wifi is not available, one SIM is out of service and the default data SIM is in home network. Then out of service SIM IMS will be registered over INTERNET APN of the default data subscription
This API requires one of the following:
- The caller holds the READ_PRECISE_PHONE_STATE permission.
- If the caller is the device or profile owner, the caller holds the `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` permission.
- The caller has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`) on any active subscription.
The profile owner is an app that owns a managed profile on the device; for more details
see [Work profiles](https://developer.android.com/work/managed-profiles).
Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Returns ||
|---|---|
| `boolean` | true if the user's setting for Voice over Cross SIM is enabled and false if it is not
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/android/telephony/ims/ImsException` | if the IMS service associated with this subscription is not available or the IMS service is not available. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | If the device does not have `https://developer.android.com/reference/android/content/pm/PackageManager#FEATURE_TELEPHONY_IMS`. |
### isTtyOverVolteEnabled
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isTtyOverVolteEnabled ()
```
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Returns ||
|---|---|
| `boolean` | true if TTY over VoLTE is supported This API requires one of the following: - The caller holds the READ_PRECISE_PHONE_STATE permission. - If the caller is the device or profile owner, the caller holds the `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` permission. - The caller has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`) on any active subscription. The profile owner is an app that owns a managed profile on the device; for more details see [Work profiles](https://developer.android.com/work/managed-profiles). Access by profile owners is deprecated and will be removed in a future release. |
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | If the device does not have `https://developer.android.com/reference/android/content/pm/PackageManager#FEATURE_TELEPHONY_IMS`. |
**See also:**
- `https://developer.android.com/reference/android/telephony/CarrierConfigManager#KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL`
### isVoWiFiRoamingSettingEnabled
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isVoWiFiRoamingSettingEnabled ()
```
Returns the user's voice over WiFi roaming setting associated with the current subscription.
This API requires one of the following:
- The caller holds the READ_PRECISE_PHONE_STATE permission.
- If the caller is the device or profile owner, the caller holds the `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` permission.
- The caller has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`) on any active subscription.
The profile owner is an app that owns a managed profile on the device; for more details
see [Work profiles](https://developer.android.com/work/managed-profiles).
Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Returns ||
|---|---|
| `boolean` | true if the user's setting for Voice over WiFi while roaming is enabled, false if disabled.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | If the device does not have `https://developer.android.com/reference/android/content/pm/PackageManager#FEATURE_TELEPHONY_IMS`. |
### isVoWiFiSettingEnabled
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isVoWiFiSettingEnabled ()
```
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Returns ||
|---|---|
| `boolean` | true if the user's setting for Voice over WiFi is enabled and false if it is not. This API requires one of the following: - The caller holds the READ_PRECISE_PHONE_STATE permission. - If the caller is the device or profile owner, the caller holds the `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` permission. - The caller has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`) on any active subscription. The profile owner is an app that owns a managed profile on the device; for more details see [Work profiles](https://developer.android.com/work/managed-profiles). Access by profile owners is deprecated and will be removed in a future release. |
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | If the device does not have `https://developer.android.com/reference/android/content/pm/PackageManager#FEATURE_TELEPHONY_IMS`. |
### isVtSettingEnabled
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isVtSettingEnabled ()
```
The user's setting for whether or not they have enabled the "Video Calling" setting.
Note: If the carrier configuration for advanced calling is not editable or hidden, this
method will always return the default value.
This API requires one of the following:
- The caller holds the READ_PRECISE_PHONE_STATE permission.
- If the caller is the device or profile owner, the caller holds the `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` permission.
- The caller has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`) on any active subscription.
The profile owner is an app that owns a managed profile on the device; for more details
see [Work profiles](https://developer.android.com/work/managed-profiles).
Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Returns ||
|---|---|
| `boolean` | true if the user\\u2019s \\u201cVideo Calling\\u201d setting is currently enabled.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the subscription associated with this operation is not active (SIM is not inserted, ESIM inactive) or invalid. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | If the device does not have `https://developer.android.com/reference/android/content/pm/PackageManager#FEATURE_TELEPHONY_IMS`. |
### registerImsRegistrationCallback
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void registerImsRegistrationCallback (Executor executor,
RegistrationManager.RegistrationCallback c)
```
Requires Permission: `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` or that the calling app has carrier privileges
(see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`).
Registers a `https://developer.android.com/reference/android/telephony/ims/RegistrationManager.RegistrationCallback` with the system. Use.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Parameters ||
|---|---|
| `executor` | `Executor`: This value cannot be `null`. Callback and listener events are dispatched through this `https://developer.android.com/reference/java/util/concurrent/Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `https://developer.android.com/reference/android/content/Context#getMainExecutor()`. Otherwise, provide an `https://developer.android.com/reference/java/util/concurrent/Executor` that dispatches to an appropriate thread.
|
| `c` | `RegistrationManager.RegistrationCallback`: This value cannot be `null`.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/android/telephony/ims/ImsException` | |
### registerImsStateCallback
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void registerImsStateCallback (Executor executor,
ImsStateCallback callback)
```
Register a new callback, which is used to notify the registrant of changes to
the state of the underlying IMS service that is attached to telephony to
implement IMS functionality. If the manager is created for
the `https://developer.android.com/reference/android/telephony/SubscriptionManager#DEFAULT_SUBSCRIPTION_ID`,
this throws an `https://developer.android.com/reference/android/telephony/ims/ImsException`.
Requires Permission:
`https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
or that the calling app has carrier privileges
(see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`).
Requires `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` or android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE
| Parameters ||
|---|---|
| `executor` | `Executor`: the Executor that will be used to call the `https://developer.android.com/reference/android/telephony/ims/ImsStateCallback`. This value cannot be `null`.
|
| `callback` | `ImsStateCallback`: The callback instance being registered. This value cannot be `null`.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/android/telephony/ims/ImsException` | in the case that the callback can not be registered. See `https://developer.android.com/reference/android/telephony/ims/ImsException#getCode()` for more information on when this is called. |
### registerMmTelCapabilityCallback
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void registerMmTelCapabilityCallback (Executor executor,
ImsMmTelManager.CapabilityCallback c)
```
Registers a `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager.CapabilityCallback` with the system, which will provide MmTel service
availability updates for the subscription specified in
`https://developer.android.com/reference/android/telephony/ims/ImsManager#getImsMmTelManager(int)`.
Use `https://developer.android.com/reference/android/telephony/SubscriptionManager.OnSubscriptionsChangedListener` to listen to
subscription changed events and call
`https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#unregisterMmTelCapabilityCallback(android.telephony.ims.ImsMmTelManager.CapabilityCallback)` to clean up.
This API requires one of the following:
- The caller holds the READ_PRECISE_PHONE_STATE permission.
- If the caller is the device or profile owner, the caller holds the `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` permission.
- The caller has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`) on any active subscription.
The profile owner is an app that owns a managed profile on the device; for more details
see [Work profiles](https://developer.android.com/work/managed-profiles).
Access by profile owners is deprecated and will be removed in a future release.
When the callback is registered, it will initiate the callback c to be called with the
current capabilities.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Parameters ||
|---|---|
| `executor` | `Executor`: The executor the callback events should be run on. This value cannot be `null`. Callback and listener events are dispatched through this `https://developer.android.com/reference/java/util/concurrent/Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `https://developer.android.com/reference/android/content/Context#getMainExecutor()`. Otherwise, provide an `https://developer.android.com/reference/java/util/concurrent/Executor` that dispatches to an appropriate thread.
|
| `c` | `ImsMmTelManager.CapabilityCallback`: The MmTel `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager.CapabilityCallback` to be registered. This value cannot be `null`.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/android/telephony/ims/ImsException` | if the subscription associated with this callback is valid, but the `ImsService` associated with the subscription is not available. This can happen if the service crashed, for example. See `https://developer.android.com/reference/android/telephony/ims/ImsException#getCode()` for a more detailed reason. |
**See also:**
- `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#unregisterMmTelCapabilityCallback(android.telephony.ims.ImsMmTelManager.CapabilityCallback)`
### unregisterImsRegistrationCallback
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void unregisterImsRegistrationCallback (RegistrationManager.RegistrationCallback c)
```
Requires Permission: `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` or that the calling app has carrier privileges
(see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`).
Access by profile owners is deprecated and will be removed in a future release.
Removes an existing `https://developer.android.com/reference/android/telephony/ims/RegistrationManager.RegistrationCallback`.
When the subscription associated with this callback is removed (SIM removed, ESIM swap,
etc...), this callback will automatically be removed. If this method is called for an
inactive subscription, it will result in a no-op.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Parameters ||
|---|---|
| `c` | `RegistrationManager.RegistrationCallback`: This value cannot be `null`.
|
### unregisterImsStateCallback
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void unregisterImsStateCallback (ImsStateCallback callback)
```
Unregisters a previously registered callback.
| Parameters ||
|---|---|
| `callback` | `ImsStateCallback`: The callback instance to be unregistered. This value cannot be `null`.
|
### unregisterMmTelCapabilityCallback
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void unregisterMmTelCapabilityCallback (ImsMmTelManager.CapabilityCallback c)
```
Removes an existing MmTel `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager.CapabilityCallback`.
When the subscription associated with this callback is removed (SIM removed, ESIM swap,
etc...), this callback will automatically be removed. If this method is called for an
inactive subscription, it will result in a no-op.
This API requires one of the following:
- The caller holds the READ_PRECISE_PHONE_STATE permission.
- If the caller is the device or profile owner, the caller holds the `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE` permission.
- The caller has carrier privileges (see `https://developer.android.com/reference/android/telephony/TelephonyManager#hasCarrierPrivileges()`) on any active subscription.
The profile owner is an app that owns a managed profile on the device; for more details
see [Work profiles](https://developer.android.com/work/managed-profiles).
Access by profile owners is deprecated and will be removed in a future release.
Requires android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE or `https://developer.android.com/reference/android/Manifest.permission#READ_PRECISE_PHONE_STATE`
| Parameters ||
|---|---|
| `c` | `ImsMmTelManager.CapabilityCallback`: The MmTel `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager.CapabilityCallback` to be removed. This value cannot be `null`.
|
**See also:**
- `https://developer.android.com/reference/android/telephony/ims/ImsMmTelManager#registerMmTelCapabilityCallback(java.util.concurrent.Executor,%20android.telephony.ims.ImsMmTelManager.CapabilityCallback)`