Voice SDK v3.7.1 API Reference for Unity
|
Public Attributes |
|
bool | syncWithAudio |
bool | ordered |
The configurations for the data stream.
syncWithAudio |
ordered |
SDK behaviors |
---|---|---|
false | false | The SDK triggers the OnStreamMessageHandler or ChannelOnStreamMessageHandler 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
|
false | true |
If the delay of a data packet is within five seconds, the SDK corrects the order of the data packet. If the delay of a data packet exceeds five seconds, the SDK discards the data packet. |
true | true |
If the delay of a data packet is within the audio delay, the SDK corrects the order of the data packet. If the delay of a data packet exceeds the audio delay, the SDK discards this data packet. |
bool agora_gaming_rtc.DataStreamConfig.ordered |
Whether the SDK guarantees 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.
bool agora_gaming_rtc.DataStreamConfig.syncWithAudio |
Whether to synchronize the data packet with the published audio packet.
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
OnStreamMessageHandler
or
ChannelOnStreamMessageHandler
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.