Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions calls/android/actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
<Tabs>
<Tab title="Kotlin">
```kotlin
val callSession = CallSession.getInstance()

Check warning on line 17 in calls/android/actions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/actions.mdx#L17

Did you really mean 'callSession'?
```
</Tab>
<Tab title="Java">
```java
CallSession callSession = CallSession.getInstance();

Check warning on line 22 in calls/android/actions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/actions.mdx#L22

'callSession' is repeated!

Check warning on line 22 in calls/android/actions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/actions.mdx#L22

Did you really mean 'callSession'?
```
</Tab>
</Tabs>
Expand Down Expand Up @@ -47,9 +47,9 @@
</Tab>
</Tabs>

### Unmute Audio

Check warning on line 50 in calls/android/actions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/actions.mdx#L50

Did you really mean 'Unmute'?

Unmutes your local microphone, resuming audio transmission.

Check warning on line 52 in calls/android/actions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/actions.mdx#L52

Did you really mean 'Unmutes'?

<Tabs>
<Tab title="Kotlin">
Expand Down Expand Up @@ -185,6 +185,48 @@
</Tab>
</Tabs>

### Start Transcription

*Available since v5.0.4*

Begins server-side transcription of the call. This also enables the live closed captions overlay.

<Tabs>
<Tab title="Kotlin">
```kotlin
callSession.startTranscription()
```
</Tab>
<Tab title="Java">
```java
callSession.startTranscription();
```
</Tab>
</Tabs>

<Warning>
Transcription requires the feature to be enabled for your CometChat app.
</Warning>

### Stop Transcription

*Available since v5.0.4*

Stops the current transcription and clears any captions currently on screen. The transcript is saved and can be retrieved with [`TranscriptRequest`](/calls/android/transcription#retrieving-transcripts).

<Tabs>
<Tab title="Kotlin">
```kotlin
callSession.stopTranscription()
```
</Tab>
<Tab title="Java">
```java
callSession.stopTranscription();
```
</Tab>
</Tabs>

### Mute Participant

Mutes a specific participant's audio. This is a moderator action.
Expand Down Expand Up @@ -340,12 +382,12 @@
<Tabs>
<Tab title="Kotlin">
```kotlin
val isActive = callSession.isSessionActive()

Check warning on line 385 in calls/android/actions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/actions.mdx#L385

Did you really mean 'isActive'?
```
</Tab>
<Tab title="Java">
```java
boolean isActive = callSession.isSessionActive();

Check warning on line 390 in calls/android/actions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/actions.mdx#L390

Did you really mean 'isActive'?
```
</Tab>
</Tabs>
Expand Down
4 changes: 4 additions & 0 deletions calls/android/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ sequenceDiagram
Record call sessions for later playback
</Card>

<Card title="Transcription" icon="closed-captioning" href="/calls/android/transcription">
Transcribe calls, show live closed captions, and retrieve transcripts
</Card>

<Card title="Call Logs" icon="clock-rotate-left" href="/calls/android/call-logs">
Retrieve call history and details
</Card>
Expand Down
100 changes: 100 additions & 0 deletions calls/android/session-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<Tabs>
<Tab title="Kotlin">
```kotlin
val sessionSettings = CometChatCalls.SessionSettingsBuilder()

Check warning on line 19 in calls/android/session-settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/session-settings.mdx#L19

Did you really mean 'sessionSettings'?
.setTitle("Team Meeting")
.setDisplayName("John Doe")
.setType(SessionType.VIDEO)
Expand All @@ -28,7 +28,7 @@
</Tab>
<Tab title="Java">
```java
SessionSettings sessionSettings = new CometChatCalls.SessionSettingsBuilder()

Check warning on line 31 in calls/android/session-settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/session-settings.mdx#L31

'sessionSettings' is repeated!

Check warning on line 31 in calls/android/session-settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/session-settings.mdx#L31

Did you really mean 'sessionSettings'?
.setTitle("Team Meeting")
.setDisplayName("John Doe")
.setType(SessionType.VIDEO)
Expand Down Expand Up @@ -176,7 +176,7 @@

**Method:** `startAudioMuted(boolean)`

Determines whether the microphone is muted when joining the session. Set to `true` to join with audio muted, requiring users to manually unmute. Useful for large meetings to prevent background noise.

Check warning on line 179 in calls/android/session-settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/session-settings.mdx#L179

Did you really mean 'unmute'?

<Tabs>
<Tab title="Kotlin">
Expand Down Expand Up @@ -326,6 +326,56 @@
|-----------|------|---------|
| `enabled` | boolean | false |

### Auto Start Transcription

*Available since v5.0.4*

**Method:** `enableAutoStartTranscription(boolean)`

Automatically starts transcribing the session as soon as it begins. See [Transcription](/calls/android/transcription) for details.

<Tabs>
<Tab title="Kotlin">
```kotlin
.enableAutoStartTranscription(true)
```
</Tab>
<Tab title="Java">
```java
.enableAutoStartTranscription(true)
```
</Tab>
</Tabs>

| Parameter | Type | Default |
|-----------|------|---------|
| `enabled` | boolean | false |

### Caption Language

*Available since v5.0.4*

**Method:** `setCaptionLanguage(String)`

Sets the language used for transcription and closed captions. See [Transcription](/calls/android/transcription) for the full list of supported codes.

<Tabs>
<Tab title="Kotlin">
```kotlin
.setCaptionLanguage("en-US")
```
</Tab>
<Tab title="Java">
```java
.setCaptionLanguage("en-US")
```
</Tab>
</Tabs>

| Parameter | Type | Default |
|-----------|------|---------|
| `captionLanguage` | String | "en-US" |

### Hide Control Panel

**Method:** `hideControlPanel(boolean)`
Expand Down Expand Up @@ -510,6 +560,56 @@
|-----------|------|---------|
| `hide` | boolean | true |

### Hide Transcription Button

*Available since v5.0.4*

**Method:** `hideTranscriptionButton(boolean)`

Hides the transcription start/stop item from the control panel's **More** menu. Set to `false` to show it, allowing users to manually control session transcription.

<Tabs>
<Tab title="Kotlin">
```kotlin
.hideTranscriptionButton(false)
```
</Tab>
<Tab title="Java">
```java
.hideTranscriptionButton(false)
```
</Tab>
</Tabs>

| Parameter | Type | Default |
|-----------|------|---------|
| `hide` | boolean | true |

### Hide Closed Caption Button

*Available since v5.0.4*

**Method:** `hideClosedCaptionButton(boolean)`

Hides the closed-caption (Show/Hide Captions) item from the control panel's **More** menu. Set to `false` to show it, allowing users to toggle the live captions overlay. Even when set to `false`, the item only appears while transcription is running.

<Tabs>
<Tab title="Kotlin">
```kotlin
.hideClosedCaptionButton(false)
```
</Tab>
<Tab title="Java">
```java
.hideClosedCaptionButton(false)
```
</Tab>
</Tabs>

| Parameter | Type | Default |
|-----------|------|---------|
| `hide` | boolean | true |

### Hide Screen Sharing Button

**Method:** `hideScreenSharingButton(boolean)`
Expand Down
4 changes: 2 additions & 2 deletions calls/android/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<Tabs>
<Tab title="Groovy">
```groovy
allprojects {

Check warning on line 32 in calls/android/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/setup.mdx#L32

Did you really mean 'allprojects'?
repositories {
maven {
url "https://dl.cloudsmith.io/public/cometchat/cometchat/maven/"
Expand All @@ -40,7 +40,7 @@
</Tab>
<Tab title="Kotlin DSL">
```kotlin
allprojects {

Check warning on line 43 in calls/android/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/setup.mdx#L43

Did you really mean 'allprojects'?
repositories {
maven {
url = uri("https://dl.cloudsmith.io/public/cometchat/cometchat/maven/")
Expand All @@ -59,14 +59,14 @@
<Tab title="Groovy">
```groovy
dependencies {
implementation "com.cometchat:calls-sdk-android:5.0.0"
implementation "com.cometchat:calls-sdk-android:5.0.4"
}
```
</Tab>
<Tab title="Kotlin DSL">
```kotlin
dependencies {
implementation("com.cometchat:calls-sdk-android:5.0.0")
implementation("com.cometchat:calls-sdk-android:5.0.4")
}
```
</Tab>
Expand Down Expand Up @@ -134,8 +134,8 @@
import com.cometchat.calls.core.CometChatCalls
import com.cometchat.calls.core.CallAppSettings

val appId = "APP_ID" // Replace with your App ID

Check warning on line 137 in calls/android/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/setup.mdx#L137

Did you really mean 'appId'?
val region = "REGION" // Replace with your Region ("us" or "eu")

Check warning on line 138 in calls/android/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

calls/android/setup.mdx#L138

Did you really mean 'eu'?

val callAppSettings = CallAppSettings.CallAppSettingBuilder(appId, region).build()

Expand Down
Loading