DataStreamConfig class
The configurations for the data stream. The following table shows the SDK behaviors under different parameter settings:
- Annotations
-
- @JsonSerializable(explicitToJson: true)
Constructors
- DataStreamConfig(bool syncWithAudio, bool ordered)
- Constructs the 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. 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.
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. 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, 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
trueonly when you need to implement specific functions, for example lyric synchronization.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