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

//! MediaStreamTrack Settings
//!
//! This module defines the actual settings currently in effect for a
//! [`MediaStreamTrack`](super::MediaStreamTrack).
//!
//! Settings represent the current configuration values of a track, which may
//! differ from requested constraints based on hardware limitations and system
//! conditions.
//!
//! # Specification
//!
//! See [MediaStreamTrack.getSettings()](https://www.w3.org/TR/mediacapture-streams/#dom-mediastreamtrack-getsettings).

/// Represents the actual settings of a media track.
///
/// `MediaTrackSettings` contains the current values of all constrainable properties
/// of a track. These values reflect what the track is actually producing, which may
/// differ from what was requested via constraints.
///
/// # Specification
///
/// See [MediaTrackSettings](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings)
/// in the W3C Media Capture and Streams specification.
///
/// # Examples
///
/// ```
/// use rtc::media_stream::MediaStreamTrack;
///
/// # fn example(track: MediaStreamTrack) {
/// let settings = track.get_settings();
/// // Inspect actual track settings
/// # }
/// ```
#[derive(Default, Debug, Clone)]
pub struct MediaTrackSettings {
    /// Actual video width in pixels.
    ///
    /// # Specification
    ///
    /// See [width](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-width).
    width: u32,

    /// Actual video height in pixels.
    ///
    /// # Specification
    ///
    /// See [height](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-height).
    height: u32,

    /// Actual aspect ratio (width/height).
    ///
    /// # Specification
    ///
    /// See [aspectRatio](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-aspectratio).
    aspect_ratio: f64,

    /// Actual frame rate in frames per second.
    ///
    /// # Specification
    ///
    /// See [frameRate](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-framerate).
    frame_rate: f64,

    /// Actual camera facing mode.
    ///
    /// Values: "user", "environment", "left", "right".
    ///
    /// # Specification
    ///
    /// See [facingMode](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-facingmode).
    facing_mode: String,

    /// Actual resize mode.
    ///
    /// Values: "none", "crop-and-scale".
    ///
    /// # Specification
    ///
    /// See [resizeMode](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-resizemode).
    resize_mode: String,

    /// Actual audio sample rate in Hz.
    ///
    /// # Specification
    ///
    /// See [sampleRate](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-samplerate).
    sample_rate: u32,

    /// Actual audio sample size in bits.
    ///
    /// # Specification
    ///
    /// See [sampleSize](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-samplesize).
    sample_size: u32,

    /// Whether echo cancellation is currently enabled.
    ///
    /// # Specification
    ///
    /// See [echoCancellation](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-echocancellation).
    echo_cancellation: bool,

    /// Whether automatic gain control is currently enabled.
    ///
    /// # Specification
    ///
    /// See [autoGainControl](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-autogaincontrol).
    auto_gain_control: bool,

    /// Whether noise suppression is currently enabled.
    ///
    /// # Specification
    ///
    /// See [noiseSuppression](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-noisesuppression).
    noise_suppression: bool,

    /// Actual latency in seconds.
    ///
    /// Represents the delay between capture and availability for processing.
    ///
    /// # Specification
    ///
    /// See [latency](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-latency).
    latency: f64,

    /// Actual audio channel count.
    ///
    /// # Specification
    ///
    /// See [channelCount](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-channelcount).
    channel_count: u32,

    /// Device identifier.
    ///
    /// # Specification
    ///
    /// See [deviceId](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-deviceid).
    device_id: String,

    /// Group identifier.
    ///
    /// # Specification
    ///
    /// See [groupId](https://www.w3.org/TR/mediacapture-streams/#dom-mediatracksettings-groupid).
    group_id: String,

    /// Whether background blur is currently enabled.
    background_blur: bool,
}