Struct nokhwa::js_camera::JSCameraConstraints

pub struct JSCameraConstraints { /* private fields */ }

Available on crate feature input-jscam only.

Constraints to create a JSCamera

If you want more options, see JSCameraConstraintsBuilder

JS-WASM

This is exported as CameraConstraints.

Implementations

impl JSCameraConstraints

pub fn media_constraints(&self) -> MediaStreamConstraints

Gets the internal MediaStreamConstraints

JS-WASM

This is exported as get_MediaStreamConstraints.

pub fn min_resolution(&self) -> Option<Resolution>

Gets the minimum Resolution.

JS-WASM

This is exported as get_MinResolution.

pub fn set_min_resolution(&mut self, min_resolution: Resolution)

Gets the minimum Resolution.

JS-WASM

This is exported as set_MinResolution.

pub fn resolution(&self) -> Resolution

Gets the internal Resolution

JS-WASM

This is exported as get_Resolution.

pub fn set_resolution(&mut self, preferred_resolution: Resolution)

Sets the internal Resolution Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_Resolution.

pub fn max_resolution(&self) -> Option<Resolution>

Gets the maximum Resolution.

JS-WASM

This is exported as get_MaxResolution.

pub fn set_max_resolution(&mut self, max_resolution: Resolution)

Gets the maximum Resolution.

JS-WASM

This is exported as set_MaxResolution.

pub fn resolution_exact(&self) -> bool

Gets the internal resolution exact.

JS-WASM

This is exported as get_ResolutionExact.

pub fn set_resolution_exact(&mut self, resolution_exact: bool)

Sets the internal resolution exact. Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_ResolutionExact.

pub fn min_aspect_ratio(&self) -> Option<f64>

Gets the minimum aspect ratio of the JSCameraConstraints.

JS-WASM

This is exported as get_MinAspectRatio.

pub fn set_min_aspect_ratio(&mut self, min_aspect_ratio: f64)

Sets the minimum aspect ratio of the JSCameraConstraints.

JS-WASM

This is exported as set_MinAspectRatio.

pub fn aspect_ratio(&self) -> f64

Gets the internal aspect ratio.

JS-WASM

This is exported as get_AspectRatio.

pub fn set_aspect_ratio(&mut self, aspect_ratio: f64)

Sets the internal aspect ratio. Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_AspectRatio.

pub fn max_aspect_ratio(&self) -> Option<f64>

Gets the maximum aspect ratio.

JS-WASM

This is exported as get_MaxAspectRatio.

pub fn set_max_aspect_ratio(&mut self, max_aspect_ratio: f64)

Sets the maximum internal aspect ratio. Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_MaxAspectRatio.

pub fn aspect_ratio_exact(&self) -> bool

Gets the internal aspect ratio exact.

JS-WASM

This is exported as get_AspectRatioExact.

pub fn set_aspect_ratio_exact(&mut self, aspect_ratio_exact: bool)

Sets the internal aspect ratio exact. Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_AspectRatioExact.

pub fn facing_mode(&self) -> JSCameraFacingMode

Gets the internal JSCameraFacingMode.

JS-WASM

This is exported as get_FacingMode.

pub fn set_facing_mode(&mut self, facing_mode: JSCameraFacingMode)

Sets the internal JSCameraFacingMode Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_FacingMode.

pub fn facing_mode_exact(&self) -> bool

Gets the internal facing mode exact.

JS-WASM

This is exported as get_FacingModeExact.

pub fn set_facing_mode_exact(&mut self, facing_mode_exact: bool)

Sets the internal facing mode exact Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_FacingModeExact.

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

Gets the minimum internal frame rate.

JS-WASM

This is exported as get_MinFrameRate.

pub fn set_min_frame_rate(&mut self, min_frame_rate: u32)

Sets the minimum internal frame rate Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_MinFrameRate.

pub fn frame_rate(&self) -> u32

Gets the internal frame rate.

JS-WASM

This is exported as get_FrameRate.

pub fn set_frame_rate(&mut self, frame_rate: u32)

Sets the internal frame rate Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_FrameRate.

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

Gets the maximum internal frame rate.

JS-WASM

This is exported as get_MaxFrameRate.

pub fn set_max_frame_rate(&mut self, max_frame_rate: u32)

Sets the maximum internal frame rate Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_MaxFrameRate.

pub fn frame_rate_exact(&self) -> bool

Gets the internal frame rate exact.

JS-WASM

This is exported as get_FrameRateExact.

pub fn set_frame_rate_exact(&mut self, frame_rate_exact: bool)

Sets the internal frame rate exact. Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_FrameRateExact.

pub fn resize_mode(&self) -> JSCameraResizeMode

Gets the internal JSCameraResizeMode.

JS-WASM

This is exported as get_ResizeMode.

pub fn set_resize_mode(&mut self, resize_mode: JSCameraResizeMode)

Sets the internal JSCameraResizeMode Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_ResizeMode.

pub fn resize_mode_exact(&self) -> bool

Gets the internal resize mode exact.

JS-WASM

This is exported as get_ResizeModeExact.

pub fn set_resize_mode_exact(&mut self, resize_mode_exact: bool)

Sets the internal resize mode exact. Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_ResizeModeExact.

pub fn device_id(&self) -> String

Gets the internal device id.

JS-WASM

This is exported as get_DeviceId.

pub fn set_device_id(&mut self, device_id: String)

Sets the internal device ID. Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_DeviceId.

pub fn device_id_exact(&self) -> bool

Gets the internal device id exact.

JS-WASM

This is exported as get_DeviceIdExact.

pub fn set_device_id_exact(&mut self, device_id_exact: bool)

Sets the internal device ID exact. Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_DeviceIdExact.

pub fn group_id(&self) -> String

Gets the internal group id.

JS-WASM

This is exported as get_GroupId.

pub fn set_group_id(&mut self, group_id: String)

Sets the internal group ID. Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_GroupId.

pub fn group_id_exact(&self) -> bool

Gets the internal group id exact.

JS-WASM

This is exported as get_GroupIdExact.

pub fn set_group_id_exact(&mut self, group_id_exact: bool)

Sets the internal group ID exact. Note that this doesn’t affect the internal MediaStreamConstraints until you call apply_constraints()

JS-WASM

This is exported as set_GroupIdExact.

impl JSCameraConstraints

pub fn apply_constraints(&mut self)

Applies any modified constraints.

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue = JsValue{ idx: JSIDX_NULL, _marker: marker::PhantomData,}

pub const UNDEFINED: JsValue = JsValue{ idx: JSIDX_UNDEFINED, _marker: marker::PhantomData,}

pub const TRUE: JsValue = JsValue{ idx: JSIDX_TRUE, _marker: marker::PhantomData,}

pub const FALSE: JsValue = JsValue{ idx: JSIDX_FALSE, _marker: marker::PhantomData,}

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

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

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl Clone for JSCameraConstraints

fn clone(&self) -> JSCameraConstraints

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JSCameraConstraints

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

Formats the value using the given formatter.

impl Deref for JSCameraConstraints

type Target = MediaStreamConstraints

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.