Package io.agora.rtc2

Class DataStreamConfig

java.lang.Object

io.agora.rtc2.DataStreamConfig

public class DataStreamConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
boolean	ordered	Whether the SDK guarantees that the receiver receives the data in the sent order.
boolean	syncWithAudio	Whether to synchronize the data packet with the published audio packet.

Constructor Summary

Constructors

Constructor	Description
DataStreamConfig()

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

syncWithAudio

public boolean syncWithAudio

Whether to synchronize the data packet with the published audio packet. - `true`: Synchronize the data packet with the audio packet. This setting is suitable for special scenarios such as lyrics synchronization. - `false`: Do not synchronize the data packet with the audio packet. This setting is suitable for scenarios where data packets need to arrive at the receiving end immediately. When you set the data packet to synchronize with the audio, then if the data packet delay is within the audio delay, the SDK triggers the `onStreamMessage` callback when the synchronized audio packet is played out.

ordered

public boolean ordered

Whether the SDK guarantees that the receiver receives the data in the sent order. - `true`: Guarantee that the receiver receives the data in the sent order. - `false`: Do not guarantee that the receiver receives the data in the sent order. Do not set this parameter as `true` if you need the receiver to receive the data packet immediately.

Constructor Details

DataStreamConfig

public DataStreamConfig()