Stream Video React Native

https://getstream.io/video/docs/react-native
Admin
Stream Video React Native SDK is a comprehensive toolkit for implementing video calling, audio...
Tokens:195,646
Snippets:1,821
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Configure and use storage providers

Source: https://getstream.io/video/docs/react-native/transcribing/storage.md

Examples for updating call types and starting recordings or transcriptions with specific storage providers across different languages.

```js
// update the call type to use Stream S3 storage for recordings
await client.video.updateCallType({
  name: "my-call-type",
  external_storage: "stream-s3",
});

// specify my-storage storage when starting call transcribing
await call.startTranscription({
  transcription_external_storage: "my-storage",
});

// specify my-storage storage for composite recording
await call.startRecording(
  { recording_external_storage: "my-storage" },
  "composite",
);

// specify my-storage storage for individual recording
await call.startRecording(
  { recording_external_storage: "my-storage" },
  "individual",
);

// specify my-storage storage for raw recording
await call.startRecording({ recording_external_storage: "my-storage" }, "raw");
```

```py
# update the call type to use Stream S3 storage for recordings
client.video.update_call_type('my-call-type', external_storage="stream-s3")

# specify my-storage storage when starting call transcribing
call.start_transcription(transcription_external_storage="my-storage")

# specify my-storage storage for composite recording
call.start_recording("composite", recording_external_storage="my-storage")

# specify my-storage storage for individual recording
call.start_recording("individual", recording_external_storage="my-storage")

# specify my-storage storage for raw recording
call.start_recording("raw", recording_external_storage="my-storage")
```

```go
// update the call type to use Stream S3 storage for recordings
client.Video().UpdateCallType(ctx, "my-call-type", &getstream.UpdateCallTypeRequest{
  ExternalStorage: getstream.PtrTo("stream-s3"),
})

// specify my-storage storage when starting call transcribing
call.StartTranscription(ctx, &getstream.StartTranscriptionRequest{
	TranscriptionExternalStorage: getstream.PtrTo("my-storage"),
})

// specify my-storage storage for composite recording
call.StartRecording(ctx, "composite", &getstream.StartRecordingRequest{
  RecordingExternalStorage: getstream.PtrTo("my-storage"),
})

// specify my-storage storage for individual recording
call.StartRecording(ctx, "individual", &getstream.StartRecordingRequest{
  RecordingExternalStorage: getstream.PtrTo("my-storage"),
})

// specify my-storage storage for raw recording
call.StartRecording(ctx, "raw", &getstream.StartRecordingRequest{
  RecordingExternalStorage: getstream.PtrTo("my-storage"),
})
```

--------------------------------

### Install SDK and Dependencies

Source: https://getstream.io/video/docs/react-native/setup/installation/expo.md

Install the core SDK and required native modules for Expo projects.

```bash
npx expo install @stream-io/video-react-native-sdk \
  @stream-io/react-native-webrtc \
  @config-plugins/react-native-webrtc \
  react-native-svg \
  @react-native-community/netinfo \
  expo-build-properties
```

--------------------------------

### Backstage setup

Source: https://getstream.io/video/docs/react-native/guides/joining-and-creating-calls.md

Configure a call for backstage mode to allow host setup before going live.

```typescript
await call.getOrCreate({
  data: {
    starts_at: new Date(Date.now() + 500 * 1000), // 500 seconds from now
    settings_override: {
      backstage: {
        enabled: true,
        join_ahead_time_seconds: 300,
      },
    },
  },
});
```

--------------------------------

### Start Recording with Storage

Source: https://getstream.io/video/docs/react-native/transcribing/storage.md

Starts a recording for a call while specifying a custom external storage provider.

```APIDOC
## call.startRecording

### Description
Initiates a recording for the current call, optionally overriding the default storage provider.

### Parameters
- **recording_external_storage** (string) - Optional - The identifier of the storage provider to use for this recording.
- **type** (string) - Required - The type of recording (e.g., "composite", "individual", "raw").
```

--------------------------------

### Install CocoaPods

Source: https://getstream.io/video/docs/react-native/advanced/chat-with-video.md

Run the pod installation command for iOS dependencies.

```bash
npx pod-install
```

--------------------------------

### Run Setup Script

Source: https://getstream.io/video/docs/react-native/ui-cookbook/session-timers.md

Command to execute the configuration script.

```bash
 npx ts-node script.ts
```

--------------------------------

### Install Stream Node.js SDK

Source: https://getstream.io/video/docs/react-native/ui-cookbook/session-timers.md

Commands to install the required server-side SDK for managing roles and call types.

```bash
yarn add @stream-io/node-sdk
```

```bash
npm install @stream-io/node-sdk
```

--------------------------------

### Install SDK and Dependencies

Source: https://getstream.io/video/docs/react-native/setup/installation/react-native.md

Commands to install the core SDK and required peer dependencies for React Native projects.

```bash
yarn add @stream-io/video-react-native-sdk
```

```bash
yarn add @stream-io/react-native-webrtc \
   react-native-svg \
   @react-native-community/netinfo

npx pod-install
```

--------------------------------

### Install Dependencies

Source: https://getstream.io/video/docs/react-native/incoming-calls/ringing-setup/react-native.md

Install the required Firebase and Stream Video packages for React Native.

```bash
yarn add @react-native-firebase/app \
  @react-native-firebase/messaging \
  @stream-io/react-native-callingx

npx pod-install
```

--------------------------------

### Install Video Filters Library

Source: https://getstream.io/video/docs/react-native/advanced/video-filters/usage.md

Commands to install the required native module for video stream processing.

```bash
npx expo install @stream-io/video-filters-react-native
```

```bash
yarn add @stream-io/video-filters-react-native
npx pod-install
```

--------------------------------

### Install react-native-safe-area-context

Source: https://getstream.io/video/docs/react-native/ui-cookbook/safe-area-insets.md

Command to install the dependency required for calculating device-specific safe area insets.

```bash
npm install react-native-safe-area-context
```

--------------------------------

### Install sound player dependencies

Source: https://getstream.io/video/docs/react-native/incoming-calls/ringing.md

Commands to install the react-native-sound-player library for manual ringing sound management.

```bash
npm install react-native-sound-player
cd ios && bundle exec pod install  # For iOS only
```

--------------------------------

### Setup Android full-screen incoming call view

Source: https://getstream.io/video/docs/react-native/incoming-calls/ringing-setup/react-native.md

Configure the MainActivity to display full-screen notifications on locked phones by calling the setup method in onCreate.

```kotlin
override fun onCreate(savedInstanceState: Bundle?) {
    // ..the rest
    super.onCreate()
    // Add this
    StreamVideoReactNative.setupCallActivity(this)
}
```

```java
@Override
protected void onCreate(Bundle savedInstanceState) {
    // ..the rest
    super.onCreate();
    // Add this
    StreamVideoReactNative.setupCallActivity(this);
}
```

--------------------------------

### Install dependencies for incoming calls

Source: https://getstream.io/video/docs/react-native/incoming-calls/ringing-setup/expo.md

Installs the required Firebase and Stream calling packages for Android and iOS integration.

```bash
npx expo install \
  @react-native-firebase/app \
  @react-native-firebase/messaging \
  @stream-io/react-native-callingx
```

--------------------------------

### Install React Navigation dependencies

Source: https://getstream.io/video/docs/react-native/advanced/chat-with-video.md

Install the necessary native stack navigator packages for React Navigation.

```bash
yarn add @react-navigation/native @react-navigation/elements @react-navigation/native-stack react-native-screens react-native-safe-area-context
```

--------------------------------

### Install react-native-permissions

Source: https://getstream.io/video/docs/react-native/guides/native-permissions.md

Add the required library to your project dependencies.

```bash
yarn add react-native-permissions
```

--------------------------------

### Platform-Specific File Structure

Source: https://getstream.io/video/docs/react-native/incoming-calls/ringing-setup/expo.md

Example file naming convention for platform-specific Firebase initialization.

```shell
setFirebaseListeners.android.ts
setFirebaseListeners.ts
```

--------------------------------

### Install Noise Cancellation via Expo

Source: https://getstream.io/video/docs/react-native/guides/noise-cancellation.md

Use the Expo CLI to install the required noise cancellation package.

```bash
npx expo install @stream-io/noise-cancellation-react-native
```

--------------------------------

### POST /api/v2/video/call/{call_type}/{call_id}/recordings/raw/start

Source: https://getstream.io/video/docs/react-native/recording/audio-only.md

Starts the raw recording process for a specific call.

```APIDOC
## POST /api/v2/video/call/{call_type}/{call_id}/recordings/raw/start

### Description
Initiates the raw recording process for the specified call.

### Method
POST

### Endpoint
https://video.stream-io-api.com/api/v2/video/call/{call_type}/{call_id}/recordings/raw/start

### Parameters
#### Path Parameters
- **call_type** (string) - Required - The type of the call.
- **call_id** (string) - Required - The unique identifier of the call.
```

--------------------------------

### Watch a call via get or getOrCreate

Source: https://getstream.io/video/docs/react-native/guides/events.md

Use get or getOrCreate on a call object to start watching for events without necessarily joining the call.

```typescript
import { StreamVideoClient } from "@stream-io/video-react-native-sdk";

let client: StreamVideoClient;

client.call("default", "test-call").getOrCreate();
// or
client.call("default", "test-call").get();
```

--------------------------------

### Configure transcription language across different SDKs

Source: https://getstream.io/video/docs/react-native/transcribing/calls.md

Examples for setting transcription language via call type updates, call creation, call updates, and starting transcription.

```js
// 1. set the language for all calls of the default type to "fr"
await client.video.updateCallType("default", {
  settings: {
    transcription: {
      language: "fr",
    },
  },
});

// 2. create a call and set its language to "fr"
await call.getOrCreate({
  settings_override: {
    transcription: {
      language: "fr",
    },
  },
});

// 3. update an existing call and set its language to "fr"
await call.update({
  settings_override: {
    transcription: {
      language: "fr",
    },
  },
});

// 4. start transcription and set language to "fr"
await call.startTranscription({ language: "fr" });
```

```py
# 1. set the language for all calls of the default type to "fr"
client.video.update_call_type(call.call_type, settings=CallSettingsRequest(
    transcription=TranscriptionSettingsRequest(
        mode="auto-on",
        closed_caption_mode="auto-on",
        language="fr"
    ),
))

# 2. create a call and set its language to "fr"
call.get_or_create(
    data=CallRequest(
        created_by_id="user-id",
        settings_override=CallSettingsRequest(
            transcription=TranscriptionSettingsRequest(
                mode="auto-on",
                closed_caption_mode="auto-on",
                language="fr"
            ),
        ),
    )
)

# 3. update an existing call and set its
call.update(
    settings_override=CallSettingsRequest(
        transcription=TranscriptionSettingsRequest(
            mode="auto-on",
            closed_caption_mode="auto-on",
            language="it"
        ),
    )
)

# 4. start transcription and set language to "fr"
call.start_transcription(language="fr")
```

```go
//set the language for all calls of the default type to "fr"
client.Video().UpdateCallType(ctx, "default", &getstream.UpdateCallTypeRequest{
    Settings: &getstream.CallSettingsRequest{
        Transcription: &getstream.TranscriptionSettingsRequest{
            Language: getstream.PtrTo("fr"),
        },
    },
})

// create a call and set its language to "fr"
call.GetOrCreate(ctx, &getstream.CallRequest{
    SettingsOverride: &getstream.CallSettingsRequest{
        Transcription: &getstream.TranscriptionSettingsRequest{
            Language: getstream.PtrTo("fr"),
        },
    },
})

// update an existing call and set its language to "fr"
call.Update(ctx, &getstream.UpdateCallRequest{
    SettingsOverride: &getstream.CallSettingsRequest{
        Transcription: &getstream.TranscriptionSettingsRequest{
            Language: getstream.PtrTo("fr"),
        },
    },
})

// start transcription and set language to "fr"
call.StartTranscription(ctx, &getstream.StartTranscriptionRequest{
    Language: getstream.PtrTo("fr"),
})
```

```bash
# TODO
```

--------------------------------

### Configure Individual Recording Settings

Source: https://getstream.io/video/docs/react-native/recording/individual-track.md

Examples for setting individual recording modes and output types using JavaScript, Python, and Go.

```js
// Per‑call override — include all output types
await call.update({
  settings_override: {
    individual_recording: {
      mode: "available",
      output_types: [
        "audio_only",
        "video_only",
        "audio_video",
        "screenshare_audio_only",
        "screenshare_video_only",
        "screenshare_audio_video",
      ],
    },
  },
});

// Default for a call type — only combined audio+video outputs
await client.video.updateCallType({
  name: "<call type name>",
  settings: {
    individual_recording: {
      mode: "auto-on",
      output_types: ["audio_video", "screenshare_audio_video"],
    },
  },
});
```

```py
from getstream.models import CallSettingsRequest, IndividualRecordingSettingsRequest

# Per‑call override — include all output types
call.update(
    settings_override=CallSettingsRequest(
        individual_recording=IndividualRecordingSettingsRequest(
            mode="available",
            output_types=[
                "audio_only",
                "video_only",
                "audio_video",
                "screenshare_audio_only",
                "screenshare_video_only",
                "screenshare_audio_video",
            ],
        )
    ),
)

# Default for a call type — only combined audio+video outputs
client.video.update_call_type(
    "default",
    settings=CallSettingsRequest(
        individual_recording=IndividualRecordingSettingsRequest(
            mode="auto-on",
            output_types=["audio_video", "screenshare_audio_video"],
        )
    ),
)
```

--------------------------------

### Configure App Entry Point

Source: https://getstream.io/video/docs/react-native/incoming-calls/ringing-setup/expo.md

Set the main entry point for the application in the package.json file.

```json
{
  ...
  "main": "index.js",
  ...
}
```

--------------------------------

### Configure individual recording settings in Go

Source: https://getstream.io/video/docs/react-native/recording/individual-track.md

Use these examples to override settings for a specific call or to set defaults for a call type.

```go
// Per‑call override — include all output types
call.Update(ctx, &getstream.UpdateCallRequest{
  SettingsOverride: &getstream.CallSettingsRequest{
    IndividualRecording: &getstream.IndividualRecordingSettingsRequest{
      Mode: "available",
      OutputTypes: []string{
        "audio_only",
        "video_only",
        "audio_video",
        "screenshare_audio_only",
        "screenshare_video_only",
        "screenshare_audio_video",
      },
    },
  },
})

// Default for a call type — only combined audio+video outputs
client.Video().UpdateCallType(ctx, "default", &getstream.UpdateCallTypeRequest{
  Settings: &getstream.CallSettingsRequest{
    IndividualRecording: &getstream.IndividualRecordingSettingsRequest{
      Mode:        "auto-on",
      OutputTypes: []string{"audio_video", "screenshare_audio_video"},
    },
  },
})
```

--------------------------------

### Install Expo Notifications Dependency

Source: https://getstream.io/video/docs/react-native/incoming-calls/non-ringing-notifications-setup/expo.md

Use the Expo CLI to install the required notifications package.

```bash
npx expo install expo-notifications
```

--------------------------------

### Basic Video Calling Application Setup

Source: https://getstream.io/video/docs/react-native/ui-cookbook/manual-video-quality-selection.md

Initializes the Stream Video client and joins a call, serving as the foundation for implementing custom UI controls.

```tsx
import React, { useEffect } from "react";
import { SafeAreaView, StyleSheet, Text } from "react-native";
import {
  Call,
  StreamCall,
  CallContent,
  CallingState,
  StreamVideoClient,
  StreamVideo,
} from "@stream-io/video-react-native-sdk";

const apiKey = "REPLACE_WITH_API_KEY";
const token = "REPLACE_WITH_TOKEN";
const userId = "REPLACE_WITH_USER_ID";
const callId = "REPLACE_WITH_CALL_ID";

const user = {
  id: userId,
  name: "John Malkovich",
  image: "https://robohash.org/John",
};

const client = new StreamVideoClient({ apiKey, user, token });

const RootContainer = (props: React.PropsWithChildren<{}>) => {
  return <SafeAreaView style={styles.container}>{props.children}</SafeAreaView>;
};

export const App = () => {
  const [call, setCall] = React.useState<Call>();

  useEffect(() => {
    const _call = client.call("default", callId);
    _call.join({ create: true }).then(() => setCall(_call));

    return () => {
      _call.leave().catch(() => console.error("Failed to leave the call"));
      setCall(undefined);
    };
  }, []);

  if (!call) {
    return (
      <RootContainer>
        <Text style={styles.text}>Joining call...</Text>
      </RootContainer>
    );
  }

  return (
    <StreamVideo client={client}>
      <StreamCall call={call}>
        <RootContainer>
          <CallContent />
        </RootContainer>
      </StreamCall>
    </StreamVideo>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: "center",
    backgroundColor: "white",
  },
  text: {
    color: "black",
    fontSize: 20,
    fontWeight: "bold",
    marginBottom: 20,
    textAlign: "center",
  },
});

export default App;
```

--------------------------------

### Install CallKit dependencies

Source: https://getstream.io/video/docs/react-native/guides/keeping-call-alive.md

Install the required package for iOS CallKit integration and update CocoaPods.

```bash
yarn add @stream-io/react-native-callingx

npx pod-install
```

--------------------------------

### Start Transcription with Storage

Source: https://getstream.io/video/docs/react-native/transcribing/storage.md

Starts a transcription for a call while specifying a custom external storage provider.

```APIDOC
## call.startTranscription

### Description
Initiates transcription for the current call, optionally overriding the default storage provider.

### Parameters
- **transcription_external_storage** (string) - Optional - The identifier of the storage provider to use for this transcription.
```

--------------------------------

### Initialize SDK push notification methods

Source: https://getstream.io/video/docs/react-native/incoming-calls/ringing-setup/react-native.md

Call push configuration and listener setup methods at the application entry point to ensure they are ready when the app is opened from a push notification.

```js
import { AppRegistry } from "react-native";
import { setPushConfig } from "src/utils/setPushConfig";
import { setFirebaseListeners } from "src/utils/setFirebaseListeners";
import App from "./App";

setPushConfig(); // Set push config
setFirebaseListeners(); // Set the firebase listeners

AppRegistry.registerComponent("app", () => App);
```

--------------------------------

### POST /api/v2/video/call/${CALL_TYPE}/${CALL_ID}/recordings/individual/start

Source: https://getstream.io/video/docs/react-native/recording/storage.md

Starts an individual recording with a specified external storage provider.

```APIDOC
## POST /api/v2/video/call/${CALL_TYPE}/${CALL_ID}/recordings/individual/start

### Description
Starts an individual recording for the specified call and assigns it to an external storage provider.

### Method
POST

### Endpoint
https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}/recordings/individual/start?api_key=${API_KEY}

### Parameters
#### Path Parameters
- **CALL_TYPE** (string) - Required - The call type identifier.
- **CALL_ID** (string) - Required - The unique identifier of the call.

#### Request Body
- **recording_external_storage** (string) - Required - The name of the external storage provider.
```

--------------------------------

### Logical Operator Examples

Source: https://getstream.io/video/docs/react-native/guides/querying-call-members.md

Examples of combining multiple filter expressions using logical operators.

```json
{ "$and": [ { "key": { "$in": [ 1, 2, 4 ] } }, { "some_other_key": 10 } ] }
```

```json
{ "$or": [ { "key": { "$in": [ 1, 2, 4 ] } }, { "key2": 10 } ] }
```

--------------------------------

### Native Build and Run Commands

Source: https://getstream.io/video/docs/react-native/incoming-calls/ringing-setup/expo.md

Commands for generating native directories and running the application on physical devices for testing.

```bash
npx expo prebuild --clean
```

```bash
npx expo run:ios --no-bundler --device --configuration Release
```

```bash
npx expo run:android --no-bundler --device --variant release
```

--------------------------------

### Install Stream CLI dependencies

Source: https://getstream.io/video/docs/react-native/recording/raw.md

Install required dependencies for the Stream CLI on macOS and Ubuntu/Debian systems.

```bash
brew install ffmpeg gstreamer gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly
```

```bash
sudo apt install ffmpeg gstreamer1.0-tools gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly
```

--------------------------------

### POST /api/v2/video/call/${CALL_TYPE}/${CALL_ID}/recordings/raw/start

Source: https://getstream.io/video/docs/react-native/recording/storage.md

Starts a raw recording with a specified external storage provider.

```APIDOC
## POST /api/v2/video/call/${CALL_TYPE}/${CALL_ID}/recordings/raw/start

### Description
Starts a raw recording for the specified call and assigns it to an external storage provider.

### Method
POST

### Endpoint
https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}/recordings/raw/start?api_key=${API_KEY}

### Parameters
#### Path Parameters
- **CALL_TYPE** (string) - Required - The call type identifier.
- **CALL_ID** (string) - Required - The unique identifier of the call.

#### Request Body
- **recording_external_storage** (string) - Required - The name of the external storage provider.
```

--------------------------------

### Create Android Raw Resources Directory

Source: https://getstream.io/video/docs/react-native/incoming-calls/android-custom-ringtone.md

Command to create the directory where Android expects custom audio files.

```bash
mkdir -p android/app/src/main/res/raw
```

--------------------------------

### Create a Call with Backstage Settings

Source: https://getstream.io/video/docs/react-native/streaming/backstage.md

Configure backstage mode and join-ahead time during initial call creation.

```js
startsAt = new Date(Date.now() + 30 * 60 * 1000);
client.video.call("livestream", "test-outgoing-call").getOrCreate({
  data: {
    starts_at: startsAt,
    created_by_id: "john",
    settings_override: {
      backstage: {
        enabled: true,
        join_ahead_time_seconds: 300,
      },
    },
  },
});
```

```py
# create a call with backstage enabled, starts_at set
# and join_ahead_of_time_seconds set to 5 minutes
from datetime import datetime, timedelta, timezone
starts_at = datetime.now(timezone.utc) + timedelta(minutes=30)

call = client.video.call("livestream", uuid.uuid4())
response = call.get_or_create(
    data=CallRequest(
        starts_at=starts_at,
        created_by_id=user_id,
        settings_override=CallSettingsRequest(
            backstage=BackstageSettingsRequest(
                enabled=True,
                join_ahead_time_seconds=300,
            ),
        ),
    )
)
```

```go
// create a call with backstage enabled, starts_at set
// and join_ahead_of_time_seconds set to 5 minutes
starts_at := time.Now().Add(30 * time.Minute)

call := client.Video().Call("livestream", uuid.New().String())
response, err := call.GetOrCreate(ctx, &getstream.GetOrCreateCallRequest{
  Data: &getstream.CallRequest{
    StartsAt:    &getstream.Timestamp{Time: starts_at},
    CreatedByID: getstream.PtrTo("john"),
    SettingsOverride: &getstream.CallSettingsRequest{
      Backstage: &getstream.BackstageSettingsRequest{
        Enabled:              getstream.PtrTo(true),
        JoinAheadTimeSeconds: getstream.PtrTo(300),
      },
    },
  },
})
```

```bash
# create a call with backstage mode and join ahead time settings
curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}?api_key=${API_KEY}" \
  -H "Authorization: ${TOKEN}" \
  -H "Content-Type: application/json" \
  -H "stream-auth-type: jwt" \
  -d '{
    "data": {
      "starts_at": "2022-01-01T00:00:00Z",
      "created_by_id": "john",
      "settings_override": {
        "backstage": {
            "enabled": true,
            "join_ahead_time_seconds": 300
          }
         },
      }
    }'
```

--------------------------------

### process-all

Source: https://getstream.io/video/docs/react-native/recording/raw.md

Execute audio extraction, video extraction, and muxing in a single command.

```APIDOC
## process-all

### Description
Execute audio extraction, video extraction, and muxing in a single command.

### Command
`stream-cli video raw-recording process-all --input-file <file> --output <dir> [options]`

### Options
- `--input-file` (string) - Required - Path to the recording.tar.gz file.
- `--output` (string) - Required - Output directory.
- `--user-id` (string) - Optional - Process tracks for specific user only.
```

--------------------------------

### POST /api/v2/video/call/${CALL_TYPE}/${CALL_ID}/recordings/composite/start

Source: https://getstream.io/video/docs/react-native/recording/storage.md

Starts a composite recording with a specified external storage provider.

```APIDOC
## POST /api/v2/video/call/${CALL_TYPE}/${CALL_ID}/recordings/composite/start

### Description
Starts a composite recording for the specified call and assigns it to an external storage provider.

### Method
POST

### Endpoint
https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}/recordings/composite/start?api_key=${API_KEY}

### Parameters
#### Path Parameters
- **CALL_TYPE** (string) - Required - The call type identifier.
- **CALL_ID** (string) - Required - The unique identifier of the call.

#### Request Body
- **recording_external_storage** (string) - Required - The name of the external storage provider.
```

--------------------------------

### POST /api/v2/video/call/{CALL_TYPE}/{CALL_ID}/recordings/{type}/start

Source: https://getstream.io/video/docs/react-native/transcribing/storage.md

Starts a recording (composite, individual, or raw) with a specified external storage provider.

```APIDOC
## POST /api/v2/video/call/{CALL_TYPE}/{CALL_ID}/recordings/{type}/start

### Description
Starts a recording session for a call, allowing the specification of an external storage provider for the recording files.

### Method
POST

### Endpoint
https://video.stream-io-api.com/api/v2/video/call/{CALL_TYPE}/{CALL_ID}/recordings/{type}/start?api_key={API_KEY}

### Parameters
#### Path Parameters
- **CALL_TYPE** (string) - Required - The identifier of the call type.
- **CALL_ID** (string) - Required - The unique identifier of the call.
- **type** (string) - Required - The recording type (composite, individual, or raw).

#### Query Parameters
- **api_key** (string) - Required - The API key for authentication.

#### Request Body
- **recording_external_storage** (string) - Required - The name of the external storage provider.
```

--------------------------------

### Install Push Notification Dependencies

Source: https://getstream.io/video/docs/react-native/incoming-calls/non-ringing-notifications-setup/react-native.md

Install the necessary Firebase messaging packages for React Native and update iOS pods.

```bash
yarn add @react-native-firebase/app \
  @react-native-firebase/messaging

npx pod-install
```

--------------------------------

### Filter Operators Examples

Source: https://getstream.io/video/docs/react-native/guides/querying-call-members.md

Examples of individual filter operators used to match specific criteria in call member queries.

```json
{ "key": { "$eq": "value" } }
```

```json
{ "key": "value" }
```

```json
{ "key": { "$q": "value" } }
```

```json
{ "key": { "$gt": 4 } }
```

```json
{ "key": { "$gte": 4 } }
```

```json
{ "key": { "$lt": 4 } }
```

```json
{ "key": { "$lte": 4 } }
```

```json
{ "key": { "$in": [ 1, 2, 4 ] } }
```

```json
{ "key": { "$exists": true } }
```

```json
{ "key": { "$autocomplete": "value" } }
```

--------------------------------

### Configure S3 Compatible Storage (Minio)

Source: https://getstream.io/video/docs/react-native/transcribing/storage.md

Examples for configuring S3-compatible storage by specifying a custom endpoint URL.

```js
await client.createExternalStorage({
  name: "my-s3",
  storage_type: "s3",
  bucket: "my-bucket",
  path: "directory_name/",
  aws_s3: {
    s3_api_key: "us-east-1",
    s3_region: "my-access-key",
    s3_secret: "my-secret",
    s3_custom_endpoint_url: "https://s3.us-east-1.amazonaws.com",
  },
});
```

```py
from getstream.models import S3Request

client.create_external_storage(
  bucket="my-bucket",
  name="stream-s3",
  storage_type="s3",
  path="directory_name/",
  aws_s3=S3Request(
      s3_region="us-east-1",
      s3_api_key="my-access-key",
      s3_secret="my-secret",
      s3_custom_endpoint_url="https://s3.us-east-1.amazonaws.com"
  ),
)
```

```go
client.CreateExternalStorage(ctx, &getstream.CreateExternalStorageRequest{
	Name:        "my-s3",
	StorageType: "s3",
	Bucket:      "my-bucket",
	Path:        getstream.PtrTo("directory_name/"),
	AWSS3: &getstream.S3Request{
		S3Region: "us-east-1",
		S3APIKey: getstream.PtrTo("my-access"),
		S3Secret: getstream.PtrTo("my-secret"),
		S3CustomEndpointUrl: getstream.PtrTo("https://s3.us-east-1.amazonaws.com"),
	},
},
)
```

```bash
curl -X POST https://video.stream-io-api.com/video/external_storage?api_key=${API_KEY} \
    -H "Authorization: ${TOKEN}" \
    -H "stream-auth-type: jwt" \
    -H 'Content-Type: application/json' \
-d '{
  "name": "my-s3",
  "storage_type": "s3",
  "bucket": "my-bucket",
  "path": "my-folder",
  "aws_s3": {
    "s3_api_key": "...",
    "s3_region": "...",
    "s3_secret": "...",
    "s3_custom_endpoint_url": "https://s3.us-east-1.amazonaws.com"
  }
}'
```

--------------------------------

### Install Noise Cancellation via React Native CLI

Source: https://getstream.io/video/docs/react-native/guides/noise-cancellation.md

Install the package and update CocoaPods for React Native CLI projects.

```bash
yarn add @stream-io/noise-cancellation-react-native
npx pod-install
```

--------------------------------

### Configure onCreate for Media Projection

Source: https://getstream.io/video/docs/react-native/guides/screensharing/react-native.md

Enable the media projection service within the onCreate method of your MainActivity.

```kotlin
override fun onCreate(savedInstanceState: Bundle?) {
    val options: WebRTCModuleOptions = WebRTCModuleOptions.getInstance()
    options.enableMediaProjectionService = true
    // ..the rest
}
```

```java
 @Override
protected void onCreate(Bundle savedInstanceState) {
    WebRTCModuleOptions options = WebRTCModuleOptions.getInstance();
    options.enableMediaProjectionService = true;
    // ..the rest
}
```

--------------------------------

### Anonymous User JWT Payload Example

Source: https://getstream.io/video/docs/react-native/guides/client-auth.md

Example structure for a JWT token payload required for anonymous users, including the mandatory call_cids field.

```json
{
  "iss": "@stream-io/dashboard",
  "iat": 1726406693,
  "exp": 1726493093,
  "user_id": "!anon",
  "role": "viewer",
  "call_cids": ["livestream:123"]
}
```

--------------------------------

### Initialize StreamVideoClient for Guest Users

Source: https://getstream.io/video/docs/react-native/guides/client-auth.md

Configure a client instance for a guest user by setting the user type to 'guest' and omitting token parameters.

```ts
import { StreamVideoClient, User } from "@stream-io/video-react-native-sdk";

const user: User = { id: "jack-guest", type: "guest" };
const apiKey = "my-stream-api-key";
const client = StreamVideoClient.getOrCreateInstance({
  apiKey,
  user,
});
```

--------------------------------

### startClosedCaptions

Source: https://getstream.io/video/docs/react-native/transcribing/calls.md

Starts live closed captions for the call.

```APIDOC
## startClosedCaptions

### Description
Initiates live closed captions for the call participants.

### Parameters
- **language** (string) - Optional - The language code for the closed captions.
```

--------------------------------

### Configure and Assign External Storage

Source: https://getstream.io/video/docs/react-native/transcribing/storage.md

Create an external storage configuration, verify it, and update your call type to use the new storage provider.

```js
// 1. create a new storage with all the required parameters
await client.createExternalStorage({
  bucket: "my-bucket",
  name: "my-s3",
  storage_type: "s3",
  path: "directory_name/",
  aws_s3: {
    s3_region: "us-east-1",
    s3_api_key: "my-access-key",
    s3_secret: "my-secret",
  },
});

// 2. (Optional) Check storage configuration for correctness
// In case of any errors, this will throw a ResponseError.
await client.checkExternalStorage({
  name: "my-s3",
});

// 3. update the call type to use the new storage
await client.video.updateCallType({
  name: "my-call-type",
  external_storage: "my-s3",
});
```

```py
# 1. create a new storage with all the required parameters
from getstream.models.s_3_request import S3Request

client.create_external_storage(
    name='my-s3',
    storage_type='s3',
    bucket='my-bucket',
    path='directory_name/',
    aws_s3=S3Request(
        s3_region='us-east-1',
        s3_api_key='my-access-key',
        s3_secret='my-secret',
    ),
)

# 2. (Optional) Check storage configuration for correctness
# In case of any errors, this will throw a StreamAPIException.
response = client.check_external_storage(name='my-s3')

# 3. update the call type to use the new storage
client.video.update_call_type(name='allhands', external_storage='my-s3')
```

```go
// 1. create a new storage with all the required parameters

client.CreateExternalStorage(ctx, &getstream.CreateExternalStorageRequest{
	Name:        "my-s3",
	StorageType: "s3",
	Bucket:      "my-bucket",
	Path:        getstream.PtrTo("directory_name/"),
	AwsS3: &getstream.S3Request{
		S3Region: "us-east-1",
		S3APIKey: getstream.PtrTo("my-access"),
		S3Secret: getstream.PtrTo("my-secret"),
	},
})

// 2. (Optional) Check storage configuration for correctness
// In case of any errors, this will throw a StreamAPIException.
response, err := client.CheckExternalStorage(ctx, "my-s3", &getstream.CheckExternalStorageRequest{})

// 3. update the call type to use the new storage
client.Video().UpdateCallType(ctx, "allhands", &getstream.UpdateCallTypeRequest{
  ExternalStorage: getstream.PtrTo("my-s3"),
})
```

```bash
# 1. create a new storage with all the required parameters
curl -X POST https://video.stream-io-api.com/video/external_storage?api_key=${API_KEY} \
    -H "Authorization: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -H "stream-auth-type: jwt" \
    -d '{
      "name": "my-storage",
      "storage_type": "s3",
      "bucket": "my-bucket",
      "path": "my-folder",
      "aws_s3": {
        "s3_region": "us-east-1",
        "s3_api_key": "my-api-key",
        "s3_secret": "my-secret"
      }
    }'

    # 2. (Optional) Check storage configuration for correctness
curl -X GET https://video.stream-io-api.com/video/external_storage/check?api_key=${API_KEY} \
    -H "Authorization: ${TOKEN}" \
    -H "stream-auth-type: jwt"

# 3. update the call type to use the new storage
curl -X PUT https://video.stream-io-api.com/api/v2/video/calltypes/${CALL_TYPE}?api_key=${API_KEY} \
    -H "Authorization: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -H "stream-auth-type: jwt" \
    -d '{
        "external_storage": "my-storage"
    }'
```

--------------------------------

### GET /video/permissions

Source: https://getstream.io/video/docs/react-native/call-types/permissions.md

Retrieves a list of all available permissions.

```APIDOC
## GET /video/permissions

### Description
Lists all actions that the Stream API supports as permissions.

### Method
GET

### Endpoint
https://video.stream-io-api.com/api/v2/video/permissions
```

--------------------------------

### GET /video/calltypes

Source: https://getstream.io/video/docs/react-native/call-types/permissions.md

Retrieves a list of all call types.

```APIDOC
## GET /video/calltypes

### Description
Lists all available call types.

### Method
GET

### Endpoint
https://video.stream-io-api.com/api/v2/video/calltypes
```

--------------------------------

### GET /api/v2/video/calltypes

Source: https://getstream.io/video/docs/react-native/call-types/manage.md

List all available call types.

```APIDOC
## GET /api/v2/video/calltypes

### Description
Retrieves a list of all configured call types.

### Method
GET

### Endpoint
https://video.stream-io-api.com/api/v2/video/calltypes?api_key=${API_KEY}

### Response
#### Success Response (200)
- **call_types** (array) - List of call type objects
```

--------------------------------

### Configure Call Recording Settings

Source: https://getstream.io/video/docs/react-native/recording/composite.md

Examples for updating recording modes and quality settings across different programming languages.

```js
// Disable on call level
call.update({
  settings_override: {
    recording: {
      mode: "disabled",
    },
  },
});

// Disable on call type level
client.video.updateCallType({
  name: "<call type name>",
  settings: {
    recording: {
      mode: "disabled",
    },
  },
});

// Automatically record calls
client.video.updateCallType({
  name: "<call type name>",
  settings: {
    recording: {
      mode: "auto-on",
      quality: "720p",
    },
  },
});

// Enable
call.update({
  settings_override: {
    recording: {
      mode: "available",
    },
  },
});

// Other settings
call.update({
  settings_override: {
    recording: {
      mode: "available",
      audio_only: false,
      quality: "1080p",
    },
  },
});
```

```py
from getstream.models import RecordSettingsRequest

# Disable on call level
call.update(
    settings_override=CallSettingsRequest(
        recording=RecordSettingsRequest(
            mode='disabled',
        ),
    ),
)

# Disable on call type level
call_type_name = 'default'
client.video.update_call_type(call_type_name,
    settings=CallSettingsRequest(
        recording=RecordSettingsRequest(
            mode='disabled',
        ),
    ),
)

# Automatically record calls
client.video.update_call_type(call_type_name,
    settings=CallSettingsRequest(
        recording=RecordSettingsRequest(
            mode="auto-on",
            quality="720p",
        ),
    ),
)

# Enable recording feature for a specific call
call.update(
    settings_override=CallSettingsRequest(
        recording=RecordSettingsRequest(
            mode="available",
        ),
    ),
)

# Other settings
call.update(
    settings_override=CallSettingsRequest(
        recording=RecordSettingsRequest(
            mode="available",
            quality="1080p",
        ),
    ),
)
```

```go
// Disable on call level
call.Update(ctx, &getstream.UpdateCallRequest{
  SettingsOverride: &getstream.CallSettingsRequest{
    Recording: &getstream.RecordSettingsRequest{
      Mode: "disabled",
    },
  },
})

// Disable on call type level
call_type_name := "default"
client.Video().UpdateCallType(ctx, call_type_name, &getstream.UpdateCallTypeRequest{
  Settings: &getstream.CallSettingsRequest{
	  Recording: &getstream.RecordSettingsRequest{
      Mode: "disabled",
    },
  },
})

// Automatically record calls
client.Video().UpdateCallType(ctx, call_type_name, &getstream.UpdateCallTypeRequest{
  Settings: &getstream.CallSettingsRequest{
	  Recording: &getstream.RecordSettingsRequest{
      Mode:    "auto-on",
      Quality: getstream.PtrTo("720p"),
    },
  },
})

// Enable recording feature for a specific call
call.Update(ctx, &getstream.UpdateCallRequest{
  SettingsOverride: &getstream.CallSettingsRequest{
	  Recording: &getstream.RecordSettingsRequest{
      Mode: "available",
    },
  },
})

// Other settings
call.Update(ctx, &getstream.UpdateCallRequest{
  SettingsOverride: &getstream.CallSettingsRequest{
    Recording: &getstream.RecordSettingsRequest{
      Mode:    "available",
      Quality: getstream.PtrTo("1080p"),
    },
  },
})
```

--------------------------------

### Create a local Expo module

Source: https://getstream.io/video/docs/react-native/advanced/video-filters/custom-expo.md

Command to initialize a new local Expo module within the project directory.

```bash
npx create-expo-module@latest --local
```

--------------------------------

### Copy Sound File to Android Resources

Source: https://getstream.io/video/docs/react-native/incoming-calls/android-custom-ringtone.md

Example command to copy a sound file into the Android raw resources folder.

```bash
cp path/to/your/ringtone.mp3 android/app/src/main/res/raw/ringtone.mp3
```

--------------------------------

### call.startTranscription

Source: https://getstream.io/video/docs/react-native/transcribing/calls.md

Starts the transcription process for an active call with a specified language.

```APIDOC
## call.startTranscription

### Description
Initiates the transcription or closed-captioning process for an active call.

### Parameters
- **language** (string) - Optional - The language code to use for the transcription process.
```

--------------------------------

### GET /api/v2/users/block

Source: https://getstream.io/video/docs/react-native/moderation/overview.md

Retrieves a list of users blocked by a specific user.

```APIDOC
## GET /api/v2/users/block

### Description
Retrieves the list of users currently blocked by the specified user.

### Method
GET

### Endpoint
https://video.stream-io-api.com/api/v2/users/block

### Query Parameters
- **user_id** (string) - Required - The ID of the user whose blocked list is being retrieved.
```

--------------------------------

### GET /video/calltypes/{name}

Source: https://getstream.io/video/docs/react-native/call-types/permissions.md

Retrieves details for a specific call type.

```APIDOC
## GET /video/calltypes/{name}

### Description
Retrieves the configuration for a specific call type.

### Method
GET

### Endpoint
https://video.stream-io-api.com/api/v2/video/calltypes/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the call type (e.g., 'livestream')
```

--------------------------------

### Connect an AI Agent to a Stream Call

Source: https://getstream.io/video/docs/react-native/ai-integration/openai-realtime.md

Examples for initializing the Stream SDK and connecting an OpenAI Realtime agent to a call.

```javascript
// Initialize the SDK with API credentials
const { StreamClient } = require("@stream-io/node-sdk");

const streamClient = new StreamClient("your-api-key", "your-api-secret");

// Create a call object
const call = streamClient.video.call("default", "call-id");

// Connect the OpenAI agent to the call
const openAiApiKey = "your-openai-api-key";

const realtimeClient = await streamClient.video.connectOpenAi({
  call,
  openAiApiKey,
  agentUserId: "lucy",
  model: "gpt-4o-realtime-preview",
});

// Update the session with instructions for the AI agent
realtimeClient.updateSession({
  instructions:
    "You are a helpful assistant that can answer questions and help with tasks.",
});
```

```python
# Make sure you have the Stream package with OpenAI integration installed:
# uv add "getstream[webrtc]" getstream-plugins-openai --prerelease=allow

from getstream import Stream
from getstream.plugins.openai.sts import OpenAIRealtime

# Initialize the SDK with API credentials
client = Stream(
    api_key="your-api-key",
    api_secret="your-api-secret"
)

# Create a bot user
bot_user_id = "1234"
client.upsert_users(bot_user_id, "OpenAI Realtime Speech to Speech Bot")

# Create a call object
call = client.video.call("default", "call-id")
call.get_or_create(data={"created_by_id": bot_user_id})


# Initialize the OpenAI Realtime plugin
sts_bot = OpenAIRealtime(
    api_key="your-openai-api-key",
    model="openai_realtime_model_to_use",
    instructions="You are a friendly assistant; reply verbally in a short sentence.",
)

# Use an async context manager to handle the connection
async with await sts_bot.connect(call, agent_user_id=bot_user_id) as connection:
    # Listen for events here (see below)
```

```go
// OpenAI agent connection for Go SDK coming soon, reach out to support if you want to know more
```

```java
// OpenAI agent connection for Java SDK coming soon, reach out to support if you want to know more
```

--------------------------------

### GET /api/v2/video/calltypes/{name}

Source: https://getstream.io/video/docs/react-native/call-types/manage.md

Retrieve details for a specific call type.

```APIDOC
## GET /api/v2/video/calltypes/{name}

### Description
Retrieves the configuration and settings for a specific call type by name.

### Method
GET

### Endpoint
https://video.stream-io-api.com/api/v2/video/calltypes/${CALL_TYPE_NAME}?api_key=${API_KEY}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the call type to retrieve.
```
Tokens:
Raw