Struct MediaStreamTrack 

pub struct MediaStreamTrack { /* private fields */ }

Representation of a MediaStreamTrack received from a getUserMedia() or a getDisplayMedia() request.

Implementations

impl MediaStreamTrack

pub const fn new( inner: DartHandle, source_kind: Option<MediaSourceKind>, ) -> Self

Creates a new MediaStreamTrack.

pub fn handle(&self) -> Dart_Handle

Returns the underlying Dart_Handle of this MediaStreamTrack.

pub fn id(&self) -> String

Returns ID of this MediaStreamTrack.

pub fn device_id(&self) -> Option<String>

Returns device ID of this MediaStreamTrack.

pub fn kind(&self) -> MediaKind

Returns kind of this MediaStreamTrack.

pub fn facing_mode(&self) -> Option<FacingMode>

Returns facing mode of this MediaStreamTrack.

pub fn height(&self) -> Option<u32>

Returns height of this MediaStreamTrack.

pub fn width(&self) -> Option<u32>

Returns width of this MediaStreamTrack.

pub fn enabled(&self) -> bool

Returns enabled field of this MediaStreamTrack.

pub fn set_enabled(&self, enabled: bool)

Sets enabled field of this MediaStreamTrack.

pub async fn ready_state(&self) -> MediaStreamTrackState

Returns readiness state of this MediaStreamTrack.

pub fn stop(&self) -> impl Future<Output = ()> + 'static + use<>

Stops this MediaStreamTrack.

pub fn guess_is_from_display(&self) -> bool

Detects whether this video MediaStreamTrack is captured from display, searching for specific fields in its settings.

Only works in Chrome browser at the moment.

pub async fn fork(&self) -> Self

Forks this MediaStreamTrack, by creating a new MediaStreamTrack from this MediaStreamTrack using a clone() method.

NOTE: It won’t clone MediaStreamTrack’s event handlers.

Naming

The name of this method intentionally diverges from the spec one to not interfere with Clone trait.

pub fn on_ended<F>(&self, f: Option<F>)

where F: 'static + FnOnce(),

Sets onended event handler of this MediaStreamTrack.

pub fn is_on_audio_level_available(&self) -> bool

Indicates whether an OnAudioLevelChangedCallback is supported for this MediaStreamTrack.

pub fn on_audio_level_changed<F>(&self, f: F) -> Result<(), Error>

where F: 'static + FnMut(i32),

Sets the provided OnAudioLevelChangedCallback for this MediaStreamTrack.

It’s called for live MediaStreamTracks when their audio level changes.

Errors

Never errors.

pub fn is_audio_processing_available(&self) -> bool

Indicates whether this MediaStreamTrack supports audio processing functions:

• MediaStreamTrack::is_noise_suppression_enabled()
• MediaStreamTrack::set_noise_suppression_enabled()
• MediaStreamTrack::get_noise_suppression_level()
• MediaStreamTrack::set_noise_suppression_level()
• MediaStreamTrack::is_echo_cancellation_enabled()
• MediaStreamTrack::set_echo_cancellation_enabled()
• MediaStreamTrack::is_auto_gain_control_enabled()
• MediaStreamTrack::set_auto_gain_control_enabled()
• MediaStreamTrack::is_high_pass_filter_enabled()
• MediaStreamTrack::set_high_pass_filter_enabled()

pub async fn set_noise_suppression_enabled( &self, enabled: bool, ) -> Result<(), Error>

Toggles noise suppression for this MediaStreamTrack.

Errors

With a platform::Error if platform call errors.

pub async fn set_noise_suppression_level( &self, level: NoiseSuppressionLevel, ) -> Result<(), Error>

Configures a NoiseSuppressionLevel for this MediaStreamTrack.

NOTE: Only supported on desktop platforms.

Errors

With a platform::Error if platform call errors.

pub async fn set_echo_cancellation_enabled( &self, enabled: bool, ) -> Result<(), Error>

Toggles acoustic echo cancellation for this MediaStreamTrack.

Errors

With a platform::Error if platform call errors.

pub async fn set_auto_gain_control_enabled( &self, enabled: bool, ) -> Result<(), Error>

Toggles auto gain control for this MediaStreamTrack.

Errors

With a platform::Error if platform call errors.

pub async fn set_high_pass_filter_enabled( &self, enabled: bool, ) -> Result<(), Error>

Toggles high-pass filter for this MediaStreamTrack.

NOTE: Only supported on desktop platforms.

Errors

With a platform::Error if platform call errors.

pub async fn is_noise_suppression_enabled(&self) -> Result<bool, Error>

Indicates whether noise suppression is enabled for this MediaStreamTrack.

Errors

With a platform::Error if platform call errors.

pub async fn get_noise_suppression_level( &self, ) -> Result<NoiseSuppressionLevel, Error>

Returns the current configured NoiseSuppressionLevel of this MediaStreamTrack.

NOTE: Only supported on desktop platforms.

Errors

With a platform::Error if platform call errors.

pub async fn is_auto_gain_control_enabled(&self) -> Result<bool, Error>

Indicates whether auto gain control is enabled for this MediaStreamTrack.

Errors

With a platform::Error if platform call errors.

pub async fn is_echo_cancellation_enabled(&self) -> Result<bool, Error>

Indicates whether echo cancellation is enabled for this MediaStreamTrack.

Errors

With a platform::Error if platform call errors.

pub async fn is_high_pass_filter_enabled(&self) -> Result<bool, Error>

Indicates whether high-pass filter is enabled for this MediaStreamTrack.

NOTE: Only supported on desktop platforms.

Errors

With a platform::Error if platform call errors.

Trait Implementations

impl AsRef<MediaStreamTrack> for Track

fn as_ref(&self) -> &MediaStreamTrack

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for MediaStreamTrack

fn clone(&self) -> MediaStreamTrack

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MediaStreamTrack

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for MediaStreamTrack

fn drop(&mut self)

Executes the destructor for this type.