# Cross-channel media stream relay (/en/realtime-media/rtc/build/join-and-manage-channels/cross-channel-media-relay/react-native)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

Some special use-cases require cross-channel media stream forwarding functionality. RTC SDK enables you to relay the media stream of a host, from a source channel, to multiple target channels simultaneously. This functionality allows you to realize the following interactions:

* The hosts publish and receive each other's audio and video streams while engaging in *cross-channel* real-time interaction.

* The audience receive all audio and video streams from hosts and watch multiple hosts interact at the same time.

Due to its real-time and interactive nature, this feature enriches live broadcasts and game-play, It is especially suitable for live scenes such as co-hosting PK and online choir. It provides the audience with a better viewing experience, while bringing more traffic and revenue to the hosts.

      
  
      
  
      
  
      
  
      
  
      
  
      
  
      
<CalloutContainer type="info">
  <CalloutDescription>
    Cross-channel media stream relay is included in Agora's policy of [10,000 free minutes](/en/api-reference/faq/account/billing_free) every month. For usage beyond the free quota, please refer to [Pricing](/en/realtime-media/rtc/reference/pricing).
  </CalloutDescription>
</CalloutContainer>

## Prerequisites

* Ensure that you have implemented the [SDK quickstart](/en/realtime-media/rtc/get-started-sdk) in your project.
* Contact [support@agora.io](mailto\:support@agora.io) to activate the cross-channel media stream relay feature.

## Implement cross-channel media stream relay

The following figure shows the workflow you implement to facilitate cross-channel media stream relay:

<Accordions>
  <Accordion title="Cross-channel media stream relay workflow">
    ![Cross-channel media stream relay workflow](https://assets-docs.agora.io/images/video-sdk/cross-channel-forwarding.svg)
  </Accordion>
</Accordions>

To implement cross-channel media stream relay in your app, take the following steps:

1. Start cross-channel media stream relay

   After joining a channel, call `startOrUpdateChannelMediaRelay` to configure the source and target channel information and start forwarding a media stream. Calling this method before joining a channel fails. In live broadcasting, only hosts can call this method.

   ```typescript
   const srcChannelId = "srcChannel";
   const destChannelId = "destChannel";
   const uid = 0;
   const token = "insert-your-token";

   // Start cross-channel media stream forwarding
   rtcEngine.startOrUpdateChannelMediaRelay({
     // Configure source channel information srcInfo
     srcInfo: {
       channelName: srcChannelId,
       uid: uid,
       token: token,
     },
     // Configure the target channel information destInfos
     destInfos: [
       {
         channelName: destChannelId,
         token: '', // A token to join the target channel
         uid: 0, // SDK randomly assigns a uid
       },
     ],
     // Number of target channels
     destCount: 1,
   });
   ```

   <CalloutContainer type="info">
     <CalloutDescription>
       Cross-channel media stream relay doesn't support String-type user IDs. Join the channel with an int-type `uid`.
     </CalloutDescription>
   </CalloutContainer>

2. Update media stream relay channels

   To forward the stream to multiple target channels or exit the current forwarding channel after starting channel media relay, call `startOrUpdateChannelMediaRelay` again to add or remove target channels for forwarding. Multiple hosts in a channel can forward media streams, and each host can forward to up to six target channels.

   <CalloutContainer type="info">
     <CalloutDescription>
       The updated configuration completely **replaces** the previous configuration.
     </CalloutDescription>
   </CalloutContainer>

3. Pause or resume media stream relay

   To pause forwarding the media stream to all target channels, call `pauseAllChannelMediaRelay`.

   ```typescript
   rtcEngine.pauseAllChannelMediaRelay();
   ```

   To resume forwarding the media stream to all target channels, call `resumeAllChannelMediaRelay`.

   ```typescript
   rtcEngine.resumeAllChannelMediaRelay();
   ```

4. Stop cross-channel media stream relay

   To stop forwarding the media stream, call `stopChannelMediaRelay`. When forwarding stops, the host exits all target channels.

   ```typescript
   rtcEngine.stopChannelMediaRelay();
   ```

   <CalloutContainer type="info">
     <CalloutDescription>
       If this method fails, call `leaveChannel` to leave the channel and stop cross-channel media stream relay.
     </CalloutDescription>
   </CalloutContainer>

5. Monitor cross-channel media stream status

   During cross-channel media stream relay, the SDK reports changes in the status of media stream relay through the `onChannelMediaRelayStateChanged` callback. Implement the relevant business logic based on the [status codes](#status-codes).

   ```typescript
   // Register event callback
   rtcEngine.registerEventHandler(
     onChannelMediaRelayStateChanged: (state: ChannelMediaRelayState, code: ChannelMediaRelayError) => {
       console.log(`Cross-channel media stream forwarding status：${state}，Error Code：${code}`);
     },
   );
   ```

## Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

### Status codes

The main media stream forwarding states and their corresponding status codes are as follows:

| Media stream forwarding status                                                                                                                                                                              | status code                             |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------- |
| The source channel starts transmitting data to the target channel.                                                                                                                                          | `RelayStateRunning`(2) and `RelayOk`(0) |
| Cross-channel media stream forwarding encounters an exception. You can troubleshoot based on the [error code](https://api-ref.agora.io/en/video-sdk/react-native/4.x/API/enum_channelmediarelayerror.html). | `RelayStateFailure`(3)                  |
| Media stream forwarding has stopped.                                                                                                                                                                        | `RelayStateIdle`(0) and `RelayOk`(0)    |

### Sample project

Agora provides an open-source [ChannelMediaRelay](https://github.com/AgoraIO-Extensions/react-native-agora/blob/main/example/src/examples/advanced/ChannelMediaRelay/ChannelMediaRelay.tsx) sample project for your reference. Download the project or view the source code for a more detailed example.

### API reference

* [`startOrUpdateChannelMediaRelay`](https://api-ref.agora.io/en/video-sdk/react-native/4.x/API/class_irtcengine.html#api_irtcengine_startorupdatechannelmediarelay)
* [`stopChannelMediaRelay`](https://api-ref.agora.io/en/video-sdk/react-native/4.x/API/class_irtcengine.html#api_irtcengine_stopchannelmediarelay)
* [`pauseAllChannelMediaRelay`](https://api-ref.agora.io/en/video-sdk/react-native/4.x/API/class_irtcengine.html#api_irtcengine_pauseallchannelmediarelay)
* [`resumeAllChannelMediaRelay`](https://api-ref.agora.io/en/video-sdk/react-native/4.x/API/class_irtcengine.html#api_irtcengine_resumeallchannelmediarelay)
* [`onChannelMediaRelayStateChanged`](https://api-ref.agora.io/en/video-sdk/react-native/4.x/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onchannelmediarelaystatechanged)
* [`ChannelMediaRelayConfiguration`](https://api-ref.agora.io/en/video-sdk/react-native/4.x/API/class_channelmediarelayconfiguration.html)
* [`ChannelMediaInfo`](https://api-ref.agora.io/en/video-sdk/react-native/4.x/API/class_channelmediainfo.html)

    
  
      
  
