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 to true
if you need the receiver to receive the data immediately.
Whether to synchronize the data packet with the published audio packet.
true
: Synchronize the data packet with the audio packet.false
: Do not synchronize the data packet with the audio packet.When you set the data packet to synchronize with the audio, then if the data packet delay is within the audio delay range, the SDK triggers the StreamMessage
callback when the synchronized audio packet is played out. Do not set this parameter as true
if you need the receiver to receive the data packet immediately. Agora recommends that you set this parameter to true
only when you need to implement specific functions, for example lyric synchronization.
Generated using TypeDoc
The configurations for the data stream.
v3.3.1
syncWithAudio
ordered
false
false
StreamMessage
callback immediately after the receiver receives a data packet.true
false
- If the data packet delay is within the audio delay, the SDK triggers the
- If the data packet delay exceeds the audio delay, the SDK triggers the
.StreamMessage
callback when the synchronized audio packet is played outStreamMessage
callback as soon as the data packet is received. In this case, the data packet is not synchronized with the audio packet.false
true
true
true