Struct obws::client::Client

pub struct Client { /* private fields */ }

The client is the main entry point to access the obs-websocket API. It allows to call various functions to remote control an OBS instance as well as to listen to events caused by the user by interacting with OBS.

Implementations

impl Client

pub async fn connect(
    host: impl AsRef<str>,
    port: u16,
    password: Option<impl AsRef<str>>
) -> Result<Self>

Connect to a obs-websocket instance on the given host and port.

pub async fn connect_with_config<H, P>(
    config: ConnectConfig<H, P>
) -> Result<Self> where
    H: AsRef<str>,
    P: AsRef<str>, 

Connect to a obs-websocket instance with the given configuration.

pub fn disconnect(&mut self) -> impl Future

Disconnect from obs-websocket and shut down all machinery.

This is called automatically when dropping the client but doesn’t wait for all background tasks to complete. Therefore, it is recommended to call this manually once the client is no longer needed.

pub async fn reidentify(
    &self,
    event_subscriptions: EventSubscription
) -> Result<()>

Adjust settings of the currently active connection by re-identifying against obs-websocket.

This currently allows to change the events to listen for, without the need of a full disconnect and new connection.

pub fn events(&self) -> Result<impl Stream<Item = Event>>

Get a stream of events. Each call to this function creates a new listener, therefore it’s recommended to keep the stream around and iterate over it.

Note: To be able to iterate over the stream you have to pin it with futures_util::pin_mut for example.

Errors

Getting a new stream of events fails with Error::Disconnected if the client is disconnected from obs-websocket. That can happen either by manually disconnecting, stopping obs-websocket or closing OBS.

pub fn config(&self) -> Config<'_>

Access API functions related to OBS configuration.

pub fn filters(&self) -> Filters<'_>

Access API functions related to filters.

pub fn general(&self) -> General<'_>

Access general API functions.

pub fn hotkeys(&self) -> Hotkeys<'_>

Access API functions related to hotkeys.

pub fn inputs(&self) -> Inputs<'_>

Access API functions related to inputs.

pub fn media_inputs(&self) -> MediaInputs<'_>

Access API functions related to media inputs.

pub fn outputs(&self) -> Outputs<'_>

Access API functions related to outputs.

pub fn profiles(&self) -> Profiles<'_>

Access API functions related to profiles.

pub fn recording(&self) -> Recording<'_>

Access API functions related to recording.

pub fn replay_buffer(&self) -> ReplayBuffer<'_>

Access API functions related to the replay buffer.

pub fn scene_collections(&self) -> SceneCollections<'_>

Access API functions related to scene collections.

pub fn scene_items(&self) -> SceneItems<'_>

Access API functions related to scene items.

pub fn scenes(&self) -> Scenes<'_>

Access API functions related to scenes.

pub fn sources(&self) -> Sources<'_>

Access API functions related to sources.

pub fn streaming(&self) -> Streaming<'_>

Access API functions related to streaming.

pub fn transitions(&self) -> Transitions<'_>

Access API functions related to transitions.

pub fn ui(&self) -> Ui<'_>

Access API functions related to the user interface.

pub fn virtual_cam(&self) -> VirtualCam<'_>

Access API functions related to the virtual camera.

Trait Implementations

impl Drop for Client

fn drop(&mut self)

Executes the destructor for this type.