Struct vtubestudio::data::NdiConfigRequest

pub struct NdiConfigRequest {
    pub set_new_config: bool,
    pub ndi_active: Option<bool>,
    pub use_ndi5: Option<bool>,
    pub use_custom_resolution: Option<bool>,
    pub custom_width_ndi: Option<i32>,
    pub custom_height_ndi: Option<i32>,
}

Get and set NDI settings.

Note that the boolean fields (ndi_optional, use_ndi5, etc) are optional in this library since they’re not strictly required by the API, but the API currently treats them the same as false if unspecified.

This request returns NdiConfigResponse.

Fields

set_new_config: bool

Set to false to only return existing config (other fields will be ignored).

ndi_active: Option<bool>

Whether NDI should be active.

use_ndi5: Option<bool>

Whether NDI 5 should be used.

use_custom_resolution: Option<bool>

Whether a custom resolution should be used.

Setting this to true means the NDI stream will no longer have the same resolution as the VTube Studio window, but instead use the custom resolution set via the UI or the custom_width fields of this request.

custom_width_ndi: Option<i32>

Custom NDI width if use_custom_resolution is specified.

Must be a multiple of 16 and be between 256 and 8192.

custom_height_ndi: Option<i32>

Custom NDI height if use_custom_resolution is specified.

Must be a multiple of 8 and be between 256 and 8192.

Trait Implementations

impl Clone for NdiConfigRequest

fn clone(&self) -> NdiConfigRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NdiConfigRequest

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

Formats the value using the given formatter.

impl Default for NdiConfigRequest

fn default() -> NdiConfigRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NdiConfigRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<NdiConfigRequest> for NdiConfigRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Request for NdiConfigRequest

const MESSAGE_TYPE: EnumString<RequestType> = _

RequestType::NdiConfigRequest

type Response = NdiConfigResponse

The expected Response type for this request.

impl Serialize for NdiConfigRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NdiConfigRequest