more docs

This commit is contained in:
Hiroshi Horie
2021-12-03 11:47:47 +07:00
parent 77dc98601a
commit 36173eb3c6
2 changed files with 11 additions and 5 deletions
+7 -3
View File
@@ -1,4 +1,5 @@
import 'track/options.dart';
import 'track/track.dart';
/// Options when joining a room.
/// {@category Room}
@@ -21,6 +22,7 @@ class ConnectOptions {
final bool optimizeVideo;
/// Set this to false in case you would like to stop the track yourself.
/// If you set this to false, make sure you call [Track.stop].
/// defaults to true.
final bool stopLocalTrackOnUnpublish;
@@ -37,7 +39,9 @@ class VideoPublishOptions {
///
final VideoEncoding? videoEncoding;
///
/// Whether to enable simulcast or not.
/// https://blog.livekit.io/an-introduction-to-webrtc-simulcast-6c5f1f6402eb
/// defaults to true.
final bool simulcast;
const VideoPublishOptions({
@@ -51,9 +55,9 @@ class VideoPublishOptions {
}
class AudioPublishOptions {
/// DTX (Discontinuous Transmission)
/// Whether to enable DTX (Discontinuous Transmission) or not.
/// https://en.wikipedia.org/wiki/Discontinuous_transmission
/// defaults to true
/// defaults to true.
final bool dtx;
const AudioPublishOptions({
+4 -2
View File
@@ -88,7 +88,8 @@ abstract class Track extends DisposableChangeNotifier
return cid;
}
// returns true if started, false if already started
/// Start this [Track] if not started.
/// Returns true if started, false if already started
@mustCallSuper
Future<bool> start() async {
if (_active) {
@@ -102,7 +103,8 @@ abstract class Track extends DisposableChangeNotifier
return true;
}
// returns true if stopped, false if already stopped
/// Stop this [Track] if not stopped.
/// Returns true if stopped, false if already stopped
@mustCallSuper
Future<bool> stop() async {
if (!_active) {