Struct MediaStreamSettings 

pub struct MediaStreamSettings { /* private fields */ }

MediaStreamConstraints wrapper.

Implementations

impl MediaStreamSettings

pub fn new() -> Self

Creates new MediaStreamSettings with none constraints configured.

pub fn audio(&mut self, constraints: AudioTrackConstraints)

Specifies the nature and settings of the audio platform::MediaStreamTrack.

pub fn device_video(&mut self, constraints: DeviceVideoTrackConstraints)

Set constraints that will be used to obtain local video sourced from media device.

pub fn display_video(&mut self, constraints: DisplayVideoTrackConstraints)

Set constraints that will be used to capture local video from user display.

pub async fn unconstrain_if_satisfies_video<T>(&mut self, track: T) -> bool

where T: AsRef<MediaStreamTrack>,

Indicates whether the provided platform::MediaStreamTrack satisfies some of the VideoTrackConstraints from this MediaStreamSettings.

Unconstrains VideoTrackConstraints which this platform::MediaStreamTrack satisfies.

pub fn calculate_kinds_diff(&self, another: &Self) -> LocalStreamUpdateCriteria

Returns LocalStreamUpdateCriteria with MediaKind and MediaSourceKind which are different in the provided MediaStreamSettings.

pub const fn get_audio(&self) -> &AudioTrackConstraints

Returns only audio constraints.

pub const fn get_display_video(&self) -> Option<&DisplayVideoTrackConstraints>

Returns reference to DisplayVideoTrackConstraints from this MediaStreamSettings.

Returns None if DisplayVideoTrackConstraints is unconstrained.

pub const fn get_device_video(&self) -> Option<&DeviceVideoTrackConstraints>

Returns reference to DeviceVideoTrackConstraints from this MediaStreamSettings.

Returns None if DeviceVideoTrackConstraints is unconstrained.

pub fn set_track_media_state( &mut self, state: MediaState, kind: MediaKind, source_kind: Option<MediaSourceKind>, )

Changes MediaState of audio or video type in this MediaStreamSettings.

If some type of the MediaStreamSettings is disabled, then this kind of media won’t be published.

pub fn set_media_exchange_state_by_kinds( &mut self, state: Stable, kinds: LocalStreamUpdateCriteria, )

Enables/disables provided LocalStreamUpdateCriteria based on provided media_exchange_state.

pub const fn set_audio_publish(&mut self, enabled: bool)

Sets the underlying enabled field of these AudioMediaTracksSettings to the given value.

pub const fn set_video_publish( &mut self, enabled: bool, source_kind: Option<MediaSourceKind>, )

Sets the underlying VideoTrackConstraints basing on the provided MediaSourceKind to the given value.

pub const fn is_audio_enabled(&self) -> bool

Indicates whether audio is enabled in this MediaStreamSettings.

pub const fn is_device_video_enabled(&self) -> bool

Returns true if DeviceVideoTrackConstraints are currently constrained and enabled.

pub const fn is_display_video_enabled(&self) -> bool

Returns true if DisplayVideoTrackConstraints are currently constrained and enabled.

pub const fn enabled(&self, kind: &MediaType) -> bool

Indicates whether the given MediaType is enabled and constrained in this MediaStreamSettings.

pub const fn muted(&self, kind: &MediaType) -> bool

Indicates whether the given MediaType is muted in this MediaStreamSettings.

pub const fn is_track_enabled_and_constrained( &self, kind: MediaKind, source: Option<MediaSourceKind>, ) -> bool

Indicates whether the given MediaKind and MediaSourceKind are enabled and constrained in this MediaStreamSettings.

pub const fn is_track_enabled( &self, kind: MediaKind, source: Option<MediaSourceKind>, ) -> bool

Indicates whether the given MediaKind and MediaSourceKind are enabled in this MediaStreamSettings.

Trait Implementations

impl Clone for MediaStreamSettings

fn clone(&self) -> MediaStreamSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MediaStreamSettings

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

Formats the value using the given formatter.

impl Default for MediaStreamSettings

fn default() -> MediaStreamSettings

Returns the “default value” for a type.

impl From<&SimpleTracksRequest> for MediaStreamSettings

fn from(request: &SimpleTracksRequest) -> Self

Converts to this type from the input type.

impl From<ApiMediaStreamSettings> for MediaStreamSettings

fn from(value: ApiMediaStreamSettings) -> Self

Converts to this type from the input type.

impl From<MediaStreamSettings> for Option<MultiSourceTracksConstraints>

fn from(constraints: MediaStreamSettings) -> Self

Converts to this type from the input type.

impl PartialEq for MediaStreamSettings

fn eq(&self, other: &MediaStreamSettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MediaStreamSettings

impl StructuralPartialEq for MediaStreamSettings