DataStreamConfig class
The configurations for the data stream.
The following table shows the relationship between the syncWithAudio parameter and the ordered parameter:
| syncWithAudio | ordered | SDK behaviors |
|---|---|---|
false |
false |
The SDK triggers the 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 streamMessage callback when the synchronized audio packet is played out. If the data packet delay exceeds the audio delay, the SDK triggers the streamMessage callback as soon as the data packet is received. In this case, the data packet is not synchronized with the audio packet. |
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. |
- Annotations
-
- @JsonSerializable(explicitToJson: true)
Constructors
- DataStreamConfig(bool syncWithAudio, bool ordered)
- Constructs a DataStreamConfig
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- ordered ↔ bool
-
Whether the SDK guarantees that the receiver receives the data in the sent order.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- syncWithAudio ↔ bool
-
Whether to synchronize the data packet with the published audio packet.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited