# 数据流 Datastream (/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream)

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

<a id="toc_datastream"></a>

<a id="api_irtcengine_createdatastream1"></a>

<a id="ariaid-title2"></a>

## createDataStream [1/2] [#createdatastream-12]

创建一个数据流。

<a id="api_irtcengine_createdatastream1__prototype"></a>

```cpp
virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0;
```

<a id="api_irtcengine_createdatastream1__detailed_desc"></a>

:::note
注： 每个用户在 [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine) 的生命周期内最多可以创建五个数据流。离开频道时，数据流会被销毁，如需继续使用需重新创建。
如果你需要一个更全面的低延迟、高并发、可扩展的实时消息和状态同步解决方案，建议使用实时消息。
:::

<a id="api_irtcengine_createdatastream1__timing"></a>

### 调用时机 [#调用时机]

你可以在加入频道前或后调用此方法。

<a id="api_irtcengine_createdatastream1__related"></a>

### 相关回调 [#相关回调]

成功调用该方法后，如果接收端在五秒内未收到数据，SDK 会触发 [onStreamMessageError](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并返回错误码。

<a id="api_irtcengine_createdatastream1__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="streamid"></a>
<Parameter name="streamId">

输出参数，创建的数据流 ID。

</Parameter>
<a id="reliable"></a>
<Parameter name="reliable">

是否保证接收端在五秒内收到数据流：

- true：接收端会在五秒内收到发送方的数据。如果未收到，SDK 会触发 [onStreamMessageError](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并返回错误码。
- false：不保证接收端在五秒内收到数据，延迟或丢失不会返回错误信息。

注意：请确保 `reliable` 和 `ordered` 同时为 true 或同时为 false。

</Parameter>
<a id="ordered"></a>
<Parameter name="ordered">

是否按发送顺序接收数据流：

- true：接收端按发送顺序接收数据。
- false：接收端不按发送顺序接收数据。

</Parameter>
</ParameterList>

<a id="api_irtcengine_createdatastream1__return_values"></a>

### 返回值 [#返回值]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类]

- [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_createdatastream2"></a>

<a id="ariaid-title3"></a>

## createDataStream [2/2] [#createdatastream-22]

创建一个数据流。

<a id="api_irtcengine_createdatastream2__prototype"></a>

```cpp
virtual int createDataStream(int* streamId, const DataStreamConfig& config) = 0;
```

<a id="api_irtcengine_createdatastream2__detailed_desc"></a>

[createDataStream [2/2]](#api_irtcengine_createdatastream2) 与 [createDataStream [1/2]](#api_irtcengine_createdatastream1) 相比，不保证数据传输的可靠性。如果数据包在发送后五秒内未被接收，SDK 会直接丢弃该数据包。该方法适用于对实时性要求高但可容忍部分数据丢失的场景。

:::note
注： 每个用户在 [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine) 的生命周期内最多可以创建五个数据流。离开频道时数据流会被销毁，如需使用需重新创建。如果你需要一个更全面的低延迟、高并发、可扩展的实时消息和状态同步解决方案，建议使用实时消息。
:::

<a id="api_irtcengine_createdatastream2__timing"></a>

### 调用时机 [#调用时机-1]

你可以在加入频道前或加入频道后调用该方法。

<a id="api_irtcengine_createdatastream2__parameters"></a>

### 参数 [#参数-1]

<ParameterList>
<a id="streamid-1"></a>
<Parameter name="streamId">

输出参数，创建的数据流 ID。

</Parameter>
<a id="config"></a>
<Parameter name="config">

数据流的配置。详见 [DataStreamConfig](/zh-CN/api-reference/rtc/cpp-all-platforms/class-datastreamconfig)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_createdatastream2__return_values"></a>

### 返回值 [#返回值-1]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-1]

- [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_createdatastreamex1"></a>

<a id="ariaid-title4"></a>

## createDataStreamEx [1/2] [#createdatastreamex-12]

创建一个数据流。

<a id="api_irtcengineex_createdatastreamex1__prototype"></a>

```cpp
virtual int createDataStreamEx(int* streamId, bool reliable, bool ordered, const RtcConnection& connection) = 0;
```

<a id="api_irtcengineex_createdatastreamex1__detailed_desc"></a>

:::note
注： 每个用户在 [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine) 的生命周期内最多可创建五个数据流。离开频道时数据流会被销毁，如需继续使用需重新创建。
:::

<a id="api_irtcengineex_createdatastreamex1__scenario"></a>

### 适用场景 [#适用场景]

该方法适用于多频道场景。

<a id="api_irtcengineex_createdatastreamex1__timing"></a>

### 调用时机 [#调用时机-2]

在调用 [joinChannelEx](/zh-CN/api-reference/rtc/cpp-all-platforms/channel#api_irtcengineex_joinchannelex) 后调用该方法。

<a id="api_irtcengineex_createdatastreamex1__related"></a>

### 相关回调 [#相关回调-1]

成功调用该方法后，如果设置 `reliable` 为 true，接收端在五秒内未收到数据，SDK 会触发 [onStreamMessageError](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并返回错误码。

<a id="api_irtcengineex_createdatastreamex1__parameters"></a>

### 参数 [#参数-2]

<ParameterList>
<a id="streamid-2"></a>
<Parameter name="streamId">

输出参数，创建的数据流 ID。

</Parameter>
<a id="reliable-1"></a>
<Parameter name="reliable">

是否保证接收端在五秒内收到数据流：

- true：接收端会在五秒内收到发送方的数据。如果未收到，SDK 会触发 [onStreamMessageError](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并返回错误码。
- false：不保证接收端在五秒内收到数据流，延迟或丢失不会返回错误信息。

注意：请确保 `reliable` 和 `ordered` 同时为 true 或同时为 false。

</Parameter>
<a id="ordered-1"></a>
<Parameter name="ordered">

是否按发送顺序接收数据流：

- true：接收端按发送顺序接收数据。
- false：接收端不按发送顺序接收数据。

</Parameter>
<a id="connection"></a>
<Parameter name="connection">

连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_createdatastreamex1__return_values"></a>

### 返回值 [#返回值-2]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-2]

- [IRtcEngineEx](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengineex_createdatastreamex2"></a>

<a id="ariaid-title5"></a>

## createDataStreamEx [2/2] [#createdatastreamex-22]

创建一个数据流。

<a id="api_irtcengineex_createdatastreamex2__prototype"></a>

```cpp
virtual int createDataStreamEx(int* streamId, const DataStreamConfig& config, const RtcConnection& connection) = 0;
```

<a id="api_irtcengineex_createdatastreamex2__detailed_desc"></a>

[createDataStreamEx [2/2]](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#api_irtcengineex_createdatastreamex2) 与 [createDataStreamEx [1/2]](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#api_irtcengineex_createdatastreamex1) 相比，不保证数据传输的可靠性。如果数据包在发送后五秒内未被接收，SDK 会直接丢弃该数据。建议在调用 [joinChannelEx](/zh-CN/api-reference/rtc/cpp-all-platforms/channel#api_irtcengineex_joinchannelex) 后调用此方法。

:::note
注： 每个用户在 [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine) 的生命周期中最多可以创建五个数据流。离开频道时，数据流会被销毁，如需再次使用需重新创建。如果你需要一个更全面的低延迟、高并发、可扩展的实时消息和状态同步解决方案，建议使用实时消息。
:::

<a id="api_irtcengineex_createdatastreamex2__scenario"></a>

### 适用场景 [#适用场景-1]

该方法适用于多频道场景。

<a id="api_irtcengineex_createdatastreamex2__timing"></a>

### 调用时机 [#调用时机-3]

在调用 [joinChannelEx](/zh-CN/api-reference/rtc/cpp-all-platforms/channel#api_irtcengineex_joinchannelex) 后调用。

<a id="api_irtcengineex_createdatastreamex2__parameters"></a>

### 参数 [#参数-3]

<ParameterList>
<a id="streamid-3"></a>
<Parameter name="streamId">

输出参数，创建的数据流 ID。

</Parameter>
<a id="config-1"></a>
<Parameter name="config">

数据流的配置。详见 [DataStreamConfig](/zh-CN/api-reference/rtc/cpp-all-platforms/class-datastreamconfig)。

</Parameter>
<a id="connection-1"></a>
<Parameter name="connection">

连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_createdatastreamex2__return_values"></a>

### 返回值 [#返回值-3]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-3]

- [IRtcEngineEx](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_sendstreammessage"></a>

<a id="ariaid-title6"></a>

## sendStreamMessage [#sendstreammessage]

发送数据流消息。

<a id="api_irtcengine_sendstreammessage__prototype"></a>

```cpp
virtual int sendStreamMessage(int streamId, const char* data, size_t length) = 0;
```

<a id="api_irtcengine_sendstreammessage__detailed_desc"></a>

调用 `createDataStream` 后，可以调用该方法向频道内的所有用户发送数据流消息。SDK 对该方法有限制：

- 每个客户端在频道中最多可同时拥有 5 个数据通道，所有数据通道共享的总包比特率上限为 30 KB/s；
- 每个数据通道每秒最多可发送 60 个数据包，每个数据包最大为 1 KB。

:::note
注：

- 如果你需要一个更全面的解决方案，以实现低延迟、高并发和可扩展的实时消息传递和状态同步，建议使用实时消息。
- 该方法需在调用 `createDataStream` 并加入频道后调用。
- 该方法仅适用于主播角色。
:::

<a id="api_irtcengine_sendstreammessage__related"></a>

### 相关回调 [#相关回调-2]

成功调用该方法后，SDK 会触发 [onStreamMessage](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) 回调，远端用户可通过该回调接收数据流消息。调用失败时，SDK 会触发远端的 [onStreamMessageError](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调。

<a id="api_irtcengine_sendstreammessage__parameters"></a>

### 参数 [#参数-4]

<ParameterList>
<a id="streamid-4"></a>
<Parameter name="streamId">

数据流 ID，通过调用 `createDataStream` 获取。

</Parameter>
<a id="data"></a>
<Parameter name="data">

要发送的消息内容。

</Parameter>
<a id="length"></a>
<Parameter name="length">

数据内容的长度。

</Parameter>
</ParameterList>

<a id="api_irtcengine_sendstreammessage__return_values"></a>

### 返回值 [#返回值-4]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-4]

- [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_sendstreammessageex"></a>

<a id="ariaid-title7"></a>

## sendStreamMessageEx [#sendstreammessageex]

发送数据流消息。

<a id="api_irtcengineex_sendstreammessageex__prototype"></a>

```cpp
virtual int sendStreamMessageEx(int streamId, const char* data, size_t length, const RtcConnection& connection) = 0;
```

<a id="api_irtcengineex_sendstreammessageex__detailed_desc"></a>

调用 `createDataStreamEx` 创建数据通道后，可以调用该方法向频道内的所有用户发送数据流消息。SDK 对该方法有限制：

- 每个客户端在频道中最多可同时拥有 5 个数据通道，所有数据通道共享的总包比特率上限为 30 KB/s；
- 每个数据通道每秒最多可发送 60 个数据包，每个数据包最大为 1 KB。

:::note
注：

- 如果你需要一个更全面的解决方案来实现低延迟、高并发和可扩展的实时消息传递和状态同步，建议使用实时消息。
- 请在调用 [joinChannelEx](/zh-CN/api-reference/rtc/cpp-all-platforms/channel#api_irtcengineex_joinchannelex) 后再调用该方法。
- 请确保在调用该方法前已通过 `createDataStreamEx` 创建数据通道。
:::

<a id="api_irtcengineex_sendstreammessageex__scenario"></a>

### 适用场景 [#适用场景-2]

该方法适用于多频道场景。

<a id="api_irtcengineex_sendstreammessageex__related"></a>

### 相关回调 [#相关回调-3]

成功调用该方法后，SDK 会触发远端客户端的 [onStreamMessage](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) 回调，远端用户可通过该回调获取数据流消息。调用失败时，SDK 会触发远端客户端的 [onStreamMessageError](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调。

<a id="api_irtcengineex_sendstreammessageex__parameters"></a>

### 参数 [#参数-5]

<ParameterList>
<a id="streamid-5"></a>
<Parameter name="streamId">

数据流 ID，通过调用 `createDataStreamEx` 获取。

</Parameter>
<a id="data-1"></a>
<Parameter name="data">

要发送的消息内容。

</Parameter>
<a id="length-1"></a>
<Parameter name="length">

数据长度。

</Parameter>
<a id="connection-2"></a>
<Parameter name="connection">

连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_sendstreammessageex__return_values"></a>

### 返回值 [#返回值-5]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-5]

- [IRtcEngineEx](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengineex)

<a id="callback_irtcengineeventhandler_onstreammessage"></a>

<a id="ariaid-title8"></a>

## onStreamMessage [#onstreammessage]

[onStreamMessage](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) 回调：远端用户发送数据流时触发。

<a id="callback_irtcengineeventhandler_onstreammessage__prototype"></a>

```cpp
virtual void onStreamMessage(uid_t uid, int streamId, const char* data, size_t length, uint64_t sentTs)
```

<a id="callback_irtcengineeventhandler_onstreammessage__detailed_desc"></a>

当本地用户收到远端用户通过调用 [sendStreamMessage](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#api_irtcengine_sendstreammessage) 发送的数据流时，SDK 会触发该回调。

:::note
注： 如果你需要一个更全面的解决方案，以实现低延迟、高并发和可扩展的实时消息传递与状态同步，建议使用实时消息。
:::

<a id="callback_irtcengineeventhandler_onstreammessage__parameters"></a>

### 参数 [#参数-6]

<ParameterList>
<a id="uid"></a>
<Parameter name="uid">

发送该数据流的远端用户 ID。

</Parameter>
<a id="streamid-6"></a>
<Parameter name="streamId">

接收到的数据流 ID。

</Parameter>
<a id="data-2"></a>
<Parameter name="data">

接收到的数据内容。

</Parameter>
<a id="length-2"></a>
<Parameter name="length">

接收到的数据长度（字节）。

</Parameter>
<a id="sentts"></a>
<Parameter name="sentTs">

发送该数据流的时间戳。

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-6]

- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengineeventhandler)

<a id="callback_irtcengineeventhandler_onstreammessageerror"></a>

<a id="ariaid-title9"></a>

## onStreamMessageError [#onstreammessageerror]

本地用户未收到远端用户发送的数据流消息时触发的回调。

<a id="callback_irtcengineeventhandler_onstreammessageerror__prototype"></a>

```cpp
virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached)
```

<a id="callback_irtcengineeventhandler_onstreammessageerror__detailed_desc"></a>

该回调在本地用户未能接收到远端用户通过调用 [sendStreamMessage](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/datastream#api_irtcengine_sendstreammessage) 发送的流消息时触发。

:::note
注： 如果你需要一个更全面的低延迟、高并发、可扩展的实时消息和状态同步解决方案，建议使用实时消息。
:::

<a id="callback_irtcengineeventhandler_onstreammessageerror__parameters"></a>

### 参数 [#参数-7]

<ParameterList>
<a id="uid-1"></a>
<Parameter name="uid">

发送消息的远端用户 ID。

</Parameter>
<a id="streamid-7"></a>
<Parameter name="streamId">

接收消息对应的数据流 ID。

</Parameter>
<a id="code"></a>
<Parameter name="code">

错误码。

</Parameter>
<a id="missed"></a>
<Parameter name="missed">

丢失的消息数量。

</Parameter>
<a id="cached"></a>
<Parameter name="cached">

数据流中断期间接收到的缓存消息数量。

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-7]

- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengineeventhandler)