Struct HttpVmixClient 

pub struct HttpVmixClient { /* private fields */ }

Implementations

impl HttpVmixClient

pub fn new(addr: SocketAddr, request_timeout: Duration) -> Self

pub fn new_with_host_port( host: &str, port: u16, request_timeout: Duration, ) -> Self

pub async fn execute_function( &self, function: &str, params: &HashMap<String, String>, ) -> Result<()>

pub async fn get_xml_state(&self) -> Result<Vmix>

pub async fn get_tally_data(&self) -> Result<HashMap<InputNumber, TallyData>>

pub async fn is_connected(&self) -> bool

pub async fn get_active_input(&self) -> Result<InputNumber>

pub async fn get_preview_input(&self) -> Result<InputNumber>

pub fn get_base_url(&self) -> String

impl HttpVmixClient

pub async fn cut(&self) -> Result<()>

pub async fn fade(&self, duration_ms: Option<u32>) -> Result<()>

pub async fn preview_input(&self, input: InputNumber) -> Result<()>

pub async fn active_input(&self, input: InputNumber) -> Result<()>

pub async fn set_text( &self, input: InputNumber, selected_name: &str, value: &str, ) -> Result<()>

pub async fn start_recording(&self) -> Result<()>

pub async fn stop_recording(&self) -> Result<()>

pub async fn start_streaming(&self) -> Result<()>

pub async fn stop_streaming(&self) -> Result<()>

Trait Implementations

impl Clone for HttpVmixClient

fn clone(&self) -> HttpVmixClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpVmixClient

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

Formats the value using the given formatter.

impl VmixApiClient for HttpVmixClient

fn execute_function<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, function: &'life1 str, params: &'life2 HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute a vMix function with optional parameters

fn get_xml_state<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vmix>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the complete vMix XML state

fn get_tally_data<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HashMap<InputNumber, TallyData>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get tally data for all inputs

fn is_connected<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check if the client is connected and the vMix instance is responsive

fn get_active_input<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<InputNumber>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the currently active (program) input number

fn get_preview_input<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<InputNumber>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the currently previewed input number

impl Send for HttpVmixClient

impl Sync for HttpVmixClient