> ## Documentation Index
> Fetch the complete documentation index at: https://cometchat-22654f5b-docs-agent-in-group-react-v6.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Direct Calling
> Direct Calling — CometChat documentation.
This section will guide you to start the call/conference directly with the session id of your choice. The session id is the most important parameter as all the users joining the same session id will be connected to the same call/conference.
## Implementation
The most important class that will be used in the implementation is the `CallSettings` class. This class allows you to set the various parameters for the call/conference. In order to set the various parameters of the `CallSettings` class, you need to use the `CallSettingsBuilder` class. Below are the various options available with the `CallSettings` class.
CallSettingsBuilder class takes the 2 mandatory parameters as a part of the constructor:
1. Context of the application
2. An object of the RelativeLayout. The calling UI will be loaded in this relative layout provided.
The other mandatory parameter is the sessionId for the call/conference. You can use the setSessionId() method of the `CallSettingsBuilder` to set the session Id of the call.
A basic example of how to start a direct call:
```java theme={null}
String sessionID = "SESSION_ID";
RelativeLayout callView;
Activity activity;
boolean audioOnly;
CallSettings callSettings = new CallSettings.CallSettingsBuilder(activity,callView)
.setSessionId(sessionId)
.setIsAudioOnly(audioOnly)
.build();
CometChat.startCall(callSettings, new CometChat.OngoingCallListener() {
@Override
public void onUserJoined(User user) {
Log.d(TAG, "onUserJoined: Name "+user.getName());
}
@Override
public void onUserLeft(User user) {
Log.d(TAG, "onUserLeft: "+user.getName());
}
@Override
public void onError(CometChatException e) {
Log.d(TAG, "onError: "+e.getMessage());
}
@Override
public void onCallEnded(Call call) {
Log.d(TAG, "onCallEnded: "+ call.toString());
}
@Override
public void onUserListUpdated(List list) {
Log.d(TAG, "onUserListUpdated: "+ list.toString());
}
@Override
public void onAudioModesUpdated(List list) {
Log.d(TAG, "onAudioModesUpdated: "+ list.toString());
}
});
```
The `setAudioOnlyCall()` method allows you to set if the call is supposed to be an audio call or an audio-video call. If set to true, the call will be an audio-only call else when set to false the call will be an audio-video call. The default will is false, so if not set, the call will be an audio-video call.
| Parameter | Description |
| ---------------- | ----------------------------------------------------------------------------------- |
| `activity` | The activity that you want to show the calling view in. |
| `sessionID` | The unique session ID available in the `Call` object |
| `RelativeLayout` | An object of the relativeLayout class in which CometChat can load the calling views |
The `OngoingCallListener` listener provides you with the below callback methods:
| Callback Method | Description |
| ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| `onUserJoined(User user)` | This method is called when any other user joins the call. The user details can be obtained from the `User` object provided. |
| `onUserLeft(User user)` | This method is called when a user leaves the call. The details of the user can be obtained from the provided `User` object. |
| `onError()` | This method is called when there is some error in establishing the call. |
| `onCallEnded()` | This method is called when the call is successfully ended. The call details can be obtained from the `Call` object provided. |
| `onUserListUpdated(List users)` | This method is triggered every time a participant joins or leaves the call providing the list of users active in the call |
| onAudioModesUpdated(List\ audioModes) | This callback is triggered if any new audio output source is available or becomes unavailable. |
## Settings
The `CallSettings` class is the most important class when it comes to the implementation of the Calling feature. This is the class that allows you to customize the overall calling experience. The properties for the call/conference can be set using the `CallSettingsBuilder` class. This will eventually give you and object of the `CallSettings` class which you can pass to the `startCall()` method to start the call.
The **mandatory** parameters that are required to be present for any call/conference to work are:
1. Context - context of the activity/application
2. RelativeLayout - A RelativeLayout object in which the calling UI is loaded.
3. sessionId - The unique session Id for the call/conference session.
The options available for customization of calls are:
| Setting | Description |
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `enableDefaultLayout(boolean b)` | If set to `true` enables the default layout for handling the call operations. If set to `false` it hides the button layout and just displays the Call View **Default value = true** |
| `showAudioModeButton(boolean b)` | If set to `true` it displays the AudioModeButton in Button Layout. if set to `false` it hides the AudioModeButton in Button Layout **Default value = true** |
| `showEndCallButton(boolean b)` | If set to `true` it displays the EndCallButton in Button Layout. if set to `false` it hides the EndCallButton in Button Layout **Default value = true** |
| `showPauseVideoButton(boolean b)` | If set to `true` it displays the PauseVideoButton in Button Layout. if set to `false` it hides the PauseVideoButton in Button Layout **Default value = true** |
| `showMuteAudioButton(boolean b)` | If set to `true` it displays the MuteAudioButton in Button Layout. if set to `false` it hides the MuteAudioButton in Button Layout **Default value = true** |
| `showSwitchCameraButton(boolean b)` | If set to `true` it displays the SwitchCameraButton in Button Layout. if set to `false` it hides the SwitchCameraButton in Button Layout **Default value = true** |
| `setAudioOnlyCall(boolean b)` | If set to true, the call will be strictly an audio call. If ser to false, the call will be an audio-video call. **Default value = false** |
| `setMode(String mode)` | CometChat provides 3 options for the calling UI. 1. CallSettings.MODE\_DEFAULT 2. CallSettings.MODE\_SPOTLIGHT 3. CallSettings.MODE\_SINGLE **Default value = CallSettings.MODE\_DEFAULT** |
| `startWithAudioMuted(boolean b)` | This ensures the call is started with the audio muted if set to true |
| `startWithVideoMuted(boolean b)` | This ensures the call is started with video paused if set to true |
| `setDefaultAudioMode(String audioMode)` | This method can be used if you wish to start the call with a specific audio mode. The available options are 1. CometChatConstants.AUDIO\_MODE\_SPEAKER = "SPEAKER" 2. CometChatConstants.AUDIO\_MODE\_EARPIECE = "EARPIECE" 3. CometChatConstants.AUDIO\_MODE\_BLUETOOTH = "BLUETOOTH" 4. CometChatConstants.AUDIO\_MODE\_HEADPHONES = "HEADPHONES" |
In case you wish to achieve a completely customized UI for the Calling experience, you can do so by embedding default android buttons to the screen as per your requirement and then use the below methods to achieve different functionalities for the embedded buttons.
For the use case where you wish to align your own custom buttons and not use the default layout provided CometChat you can embed the buttons in your layout and use the below methods to perform the corresponding operations:
### Switch Camera
You can call `switchCamera()` Method to toggle between camera sources.
```java theme={null}
CallManager callManager = CallManager.getInstance();
callManager.switchCamera();
```
### Mute Audio
You can call `muteAudio()` Method to mute your Audio Stream to the end-user.
```java theme={null}
CallManager callManager = CallManager.getInstance();
callManager.muteAudio(true);
```
if set to `true` the Audio Stream is muted and if set to`false` Audio Stream is transmitted.
### Pause Video
You can call `pauseVideo()` Method to pause Video Stream to the end-user.
```java theme={null}
CallManager callManager = CallManager.getInstance();
callManager.pauseVideo(true);
```
if set to `true` the Video Stream is muted and if set to `false` Video Stream is transmitted.
### Set Audio Mode
You can call `setAudioMode()` to set the output of the audio stream.
```java theme={null}
CallManager callManager = CallManager.getInstance();
String audioMode = CometChatConstants.AUDIO_MODE_EARPIECE;
callManager.setAudioMode(audioMode);
```
The audio mode string can have either one of the below 4 values:
* AUDIO\_MODE\_SPEAKER = "SPEAKER"
* AUDIO\_MODE\_EARPIECE = "EARPIECE"
* AUDIO\_MODE\_BLUETOOTH = "BLUETOOTH"
* AUDIO\_MODE\_HEADPHONES= "HEADPHONES"
### End Call
You can use the `CometChat.endCall()` method of the `CometChat` class to end the call.
```java theme={null}
CometChat.endCall("SESSION_ID_FOR_THE_CALL", new CometChat.CallbackListener() {
@Override
public void onSuccess(Call call) {
// handle end call success
}
@Override
public void onError(CometChatException e) {
// handled end call error
}
});
```
### Get the list of available audio modes
This method will return the list of available audio modes. Based on the list received, you can set the audio mode for the ongoing call using the `setAudioMode()` method
```java theme={null}
CallManager.getInstance().getAudioOutputModes(new CometChat.CallbackListener>() {
@Override
public void onSuccess(List audioModes) {
Log.d(TAG, "Availabe audio modes received");
}
@Override
public void onError(CometChatException e) {
Log.d(TAG, "Error while fetching audio modes " + e.getMessage());
}
});
```
The AudioMode class has the below properties:
1. mode - The mode can be either one of the below values:
* AUDIO\_MODE\_SPEAKER = "SPEAKER"
* AUDIO\_MODE\_EARPIECE = "EARPIECE"
* AUDIO\_MODE\_BLUETOOTH = "BLUETOOTH"
* AUDIO\_MODE\_HEADPHONES= "HEADPHONES"
2. isSelected - This is a boolean value that indicates if the audio mode is the active mode.
The `CometChat.getActiveCall()` method in case of Direct Calling will return null and all the details related to the call session will have to be saved and maintained at your end.
## Call Participant Count
In order to get the number of participants in any call, you can use the `getCallParticipantCount()` method. This method takes the session id for the call and returns the number or participants that are active in the call
```java theme={null}
String sessionId = "abc";
String callType = CallSettings.CALL_MODE_DIRECT;
CometChat.getCallParticipantCount(sessionId, callType, new CometChat.CallbackListener() {
@Override
public void onSuccess(Integer integer) {
// handle success
}
@Override
public void onError(CometChatException e) {
// handle error
}
});
```