NAME

Mojo::OBS::Client - Mojolicious client for the OBS WebSocket remote plugin

SYNOPSIS

  use feature 'signatures';

  my $obs = Mojo::OBS::Client->new;
  $obs->login('ws://localhost:4444', 'secret')->then(sub {
      $obs->SetTextFreetype2Properties( source => 'Text.NextTalk',text => 'Hello World')
  })->then(sub {
      $obs->GetSourceSettings( sourceName => 'VLC.Vortrag', sourceType => 'vlc_source')
  });

ACCESSORS

->ioloop

Access the underlying Mojo::IOLoop

->ua

Access the Mojo::UserAgent object used to talk to OBS.

->tx

The websocket connection to OBS.

->protocol

The Net::Protocol::OBSRemote instance used to generate the OBS messages.

->debug

Switch on debug messages to STDERR. Also enabled if $ENV{PERL_MOJO_OBS_CLIENT_DEBUG} is set to a true value.

METHODS

METHODS

For the OBS methods, see Net::Protocl::OBSRemote.

->login $url, $password

    $obs->login('ws://localhost:4444', 'secret')
    ->then(sub( $res ){
        if( $res->{error} ) {
            warn $res->{error};
            return
        };
    })

Performs the login authentication with the OBS websocket

REPOSITORY

The public repository of this module is https://github.com/Corion/Mojo-OBS-Client.

SUPPORT

The public support forum of this module is https://perlmonks.org/.

BUG TRACKER

Please report bugs in this module via the Github bug queue at https://github.com/Corion/Mojo-OBS-Client/issues

AUTHOR

Max Maischein corion@cpan.org

COPYRIGHT (c)

Copyright 2021-2023 by Max Maischein corion@cpan.org.

LICENSE

This module is released under the same terms as Perl itself.

cpanm Mojo::OBS::Client

perl -MCPAN -e shell
install Mojo::OBS::Client