Public Attributes | |
boolean | syncWithAudio = false |
boolean | ordered = false |
The configurations for the data stream.
syncWithAudio | ordered | SDK behaviors |
---|---|---|
false | false | The SDK triggers the onStreamMessage callback immediately after the receiver receives a data packet. |
true | false |
|
false | true |
|
true | true |
|
boolean io.agora.rtc.models.DataStreamConfig.syncWithAudio = false |
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 onStreamMessage
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.
boolean io.agora.rtc.models.DataStreamConfig.ordered = false |
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.