rtc 0.9.0

Sans-I/O WebRTC implementation in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239

//! MediaStreamTrack Constraints
//!
//! This module defines constraints that can be applied to a [`MediaStreamTrack`](super::MediaStreamTrack)
//! to control its behavior and output characteristics.
//!
//! Constraints allow applications to specify required, ideal, or acceptable values
//! for track properties. The user agent attempts to satisfy these constraints based
//! on hardware capabilities and system conditions.
//!
//! # Specification
//!
//! See [MediaStreamTrack.applyConstraints()](https://www.w3.org/TR/mediacapture-streams/#dom-mediastreamtrack-applyconstraints).

/// Represents a range of numeric values with constraints.
///
/// Used to specify acceptable ranges and ideal/exact values for constrainable
/// properties like width, height, frame rate, etc.
///
/// # Specification
///
/// See [ConstrainULongRange](https://www.w3.org/TR/mediacapture-streams/#dom-constrainulongrange)
/// and related constraint range types.
#[derive(Default, Debug, Clone)]
pub(crate) struct ConstrainRange<T> {
    /// Maximum acceptable value.
    pub(crate) max: T,
    /// Minimum acceptable value.
    pub(crate) min: T,
    /// Exact required value. If set, only this value is acceptable.
    pub(crate) exact: T,
    /// Ideal target value. The user agent will try to get as close as possible.
    pub(crate) ideal: T,
}

/// Represents a constraint that can be either a single value or a range.
///
/// # Specification
///
/// See [Constrainable properties](https://www.w3.org/TR/mediacapture-streams/#constrainable-properties).
#[derive(Debug, Clone)]
pub(crate) enum Constrain<T> {
    /// A single value constraint.
    Value(T),
    /// A range-based constraint with min, max, exact, and ideal values.
    Range(ConstrainRange<T>),
}

/// A set of constraints for a media track.
///
/// `MediaTrackConstraintSet` defines constraints for various track properties.
/// These constraints guide the user agent in configuring the track to meet
/// application requirements.
///
/// # Specification
///
/// See [MediaTrackConstraintSet](https://www.w3.org/TR/mediacapture-streams/#dom-mediatrackconstraintset)
/// in the W3C Media Capture and Streams specification.
#[derive(Debug, Clone)]
pub struct MediaTrackConstraintSet {
    /// Video width constraint in pixels.
    ///
    /// # Specification
    ///
    /// See [width](https://www.w3.org/TR/mediacapture-streams/#def-constraint-width).
    width: Constrain<u32>,

    /// Video height constraint in pixels.
    ///
    /// # Specification
    ///
    /// See [height](https://www.w3.org/TR/mediacapture-streams/#def-constraint-height).
    height: Constrain<u32>,

    /// Aspect ratio constraint (width/height).
    ///
    /// # Specification
    ///
    /// See [aspectRatio](https://www.w3.org/TR/mediacapture-streams/#def-constraint-aspectRatio).
    aspect_ratio: Constrain<f64>,

    /// Frame rate constraint in frames per second.
    ///
    /// # Specification
    ///
    /// See [frameRate](https://www.w3.org/TR/mediacapture-streams/#def-constraint-frameRate).
    frame_rate: Constrain<f64>,

    /// Camera facing mode constraint.
    ///
    /// Values: "user" (front), "environment" (back), "left", "right".
    ///
    /// # Specification
    ///
    /// See [facingMode](https://www.w3.org/TR/mediacapture-streams/#def-constraint-facingMode).
    facing_mode: Constrain<String>,

    /// Resize mode constraint for video processing.
    ///
    /// Values: "none", "crop-and-scale".
    ///
    /// # Specification
    ///
    /// See [resizeMode](https://www.w3.org/TR/mediacapture-streams/#def-constraint-resizeMode).
    resize_mode: Constrain<String>,

    /// Audio sample rate constraint in Hz.
    ///
    /// # Specification
    ///
    /// See [sampleRate](https://www.w3.org/TR/mediacapture-streams/#def-constraint-sampleRate).
    sample_rate: Constrain<u32>,

    /// Audio sample size constraint in bits.
    ///
    /// # Specification
    ///
    /// See [sampleSize](https://www.w3.org/TR/mediacapture-streams/#def-constraint-sampleSize).
    sample_size: Constrain<u32>,

    /// Echo cancellation constraint.
    ///
    /// # Specification
    ///
    /// See [echoCancellation](https://www.w3.org/TR/mediacapture-streams/#def-constraint-echoCancellation).
    echo_cancellation: Constrain<bool>,

    /// Automatic gain control constraint.
    ///
    /// # Specification
    ///
    /// See [autoGainControl](https://www.w3.org/TR/mediacapture-streams/#def-constraint-autoGainControl).
    auto_gain_control: Constrain<bool>,

    /// Noise suppression constraint.
    ///
    /// # Specification
    ///
    /// See [noiseSuppression](https://www.w3.org/TR/mediacapture-streams/#def-constraint-noiseSuppression).
    noise_suppression: Constrain<bool>,

    /// Latency constraint in seconds.
    ///
    /// # Specification
    ///
    /// See [latency](https://www.w3.org/TR/mediacapture-streams/#def-constraint-latency).
    latency: Constrain<f64>,

    /// Audio channel count constraint.
    ///
    /// # Specification
    ///
    /// See [channelCount](https://www.w3.org/TR/mediacapture-streams/#def-constraint-channelCount).
    channel_count: Constrain<u32>,

    /// Device identifier constraint.
    ///
    /// # Specification
    ///
    /// See [deviceId](https://www.w3.org/TR/mediacapture-streams/#def-constraint-deviceId).
    device_id: Constrain<String>,

    /// Group identifier constraint.
    ///
    /// # Specification
    ///
    /// See [groupId](https://www.w3.org/TR/mediacapture-streams/#def-constraint-groupId).
    group_id: Constrain<String>,

    /// Background blur constraint.
    background_blur: Constrain<bool>,
}

impl Default for MediaTrackConstraintSet {
    fn default() -> Self {
        Self {
            width: Constrain::Value(0),
            height: Constrain::Value(0),
            aspect_ratio: Constrain::Value(0.0),
            frame_rate: Constrain::Value(0.0),
            facing_mode: Constrain::Value("".to_string()),
            resize_mode: Constrain::Value("".to_string()),
            sample_rate: Constrain::Value(0),
            sample_size: Constrain::Value(0),
            echo_cancellation: Constrain::Value(false),
            auto_gain_control: Constrain::Value(false),
            noise_suppression: Constrain::Value(false),
            latency: Constrain::Value(0.0),
            channel_count: Constrain::Value(0),
            device_id: Constrain::Value("".to_string()),
            group_id: Constrain::Value("".to_string()),
            background_blur: Constrain::Value(false),
        }
    }
}

/// Constraints to apply to a media track.
///
/// `MediaTrackConstraints` consists of a basic constraint set and an optional
/// list of advanced constraint sets. The user agent will try to satisfy the
/// basic constraints and as many advanced constraints as possible.
///
/// # Specification
///
/// See [MediaTrackConstraints](https://www.w3.org/TR/mediacapture-streams/#dom-mediatrackconstraints)
/// in the W3C Media Capture and Streams specification.
///
/// # Examples
///
/// ```
/// use rtc::media_stream::MediaTrackConstraints;
/// use rtc::media_stream::MediaStreamTrack;
///
/// # fn example(mut track: MediaStreamTrack) {
/// // Create constraints
/// let constraints = MediaTrackConstraints::default();
///
/// // Apply to track
/// track.apply_constraints(Some(constraints));
/// # }
/// ```
#[derive(Default, Debug, Clone)]
pub struct MediaTrackConstraints {
    /// Basic constraint set that should be satisfied if possible.
    ///
    /// # Specification
    ///
    /// See [MediaTrackConstraints](https://www.w3.org/TR/mediacapture-streams/#dom-mediatrackconstraints).
    basic: MediaTrackConstraintSet,

    /// Advanced constraint sets applied in order.
    ///
    /// The user agent will try to satisfy as many of these as possible,
    /// in the order they are specified.
    ///
    /// # Specification
    ///
    /// See [advanced](https://www.w3.org/TR/mediacapture-streams/#dfn-advanced).
    advanced: Vec<MediaTrackConstraintSet>,
}