dolejska-daniel / amcp-pylib Goto Github PK

View Code? Open in Web Editor NEW

10.0 2.0 0.0 100 KB

Python client library for CasparCG's AMCP (Advanced Media Control Protocol).

Home Page: https://pypi.org/project/amcp-pylib/

License: MIT License

Python 99.82% Makefile 0.18%

python3 casparcg casparcg-client casparcg-connection library amcp python caspar

amcp-pylib's Introduction

Python AMCP Client Library

v0.2.2

Introduction

Welcome to the AMCP client library repository for Python! The goal of this library is to provide simple and understandable interface for communication with CasparCG server.

Installation

pip install amcp_pylib

Usage examples

Below you can see various usage examples.

Connecting to server

from amcp_pylib.core import Client

client = Client()
client.connect("caspar-server.local", 6969)  # defaults to 127.0.0.1, 5250

Built-in support for asyncio module:

import asyncio
from amcp_pylib.core import ClientAsync

client = ClientAsync()
asyncio.new_event_loop().run_until_complete(client.connect("caspar-server.local", 6969))

Sending commands

from amcp_pylib.core import Client
from amcp_pylib.module.query import VERSION, BYE

client = Client()
client.connect()

response = client.send(VERSION(component="server"))
print(response)

response = client.send(BYE())
print(response)

<SuccessResponse(data=['2.0.7.e9fc25a Stable'],    code=201, code_description='VERSION')>
<InfoResponse(   data=['SERVER SENT NO RESPONSE'], code=0,   code_description='EMPTY')>

All supported protocol commands are listed and documented on CasparCG's wiki pages. Some commands may not be supported yet (in that case, please create issue (or pull ;) request).

amcp-pylib's People

Contributors

Stargazers

Watchers

amcp-pylib's Issues

asyncio problem

Hello.
First of all, thank you for your work on your library.
Great to be able to use this tool.
However, I have a problem with your library.
When I use:

from amcp_pylib.core import Client

client = Client()
client.connect('192.168.0.10', 5250)

Everything is OK
but
When I use:

import asyncio
from amcp_pylib.core import ClientAsync

client = ClientAsync()
asyncio.new_event_loop().run_until_complete(client.connect('192.168.0.10', 5250))

i get an error message:

venv/lib/python3.11/site-packages/amcp_pylib/core/connection_async.py:21: RuntimeWarning: coroutine 'ConnectionAsync.connect' was never awaited
  self.connect(address_info[0], address_info[4])
RuntimeWarning: Enable tracemalloc to get the object allocation traceback

I also tried using it as follows however I was getting the same error.

import asyncio
from amcp_pylib.core import ClientAsync

async def connect():
    client = ClientAsync()
    await client.connect('192.168.0.10', 5250)

async def main():
    task = connect()
    try:
        await asyncio.wait_for(task, timeout= 4.0)
    except asyncio.TimeoutError:
        print('Gave up waiting, task canceled')
    except Exception as e:
        print(f'Task failed with: {e}')

asyncio.run(main())

v0.2.1 CG ADD no space between layer and ADD keyword

When calling CG_ADD, it is misformatting the command:

CG 1-20ADD 20 "template/template" 1 "{}"

which should be

CG 1-20 ADD 20 "template/template" 1 "{}"

normalization_extra_whitespace causes whitespace loss in data

I am passing data that is in Markdown format, and the normalization_extra_whitespace function is removing double spaces at the end of lines.

Is there a way of igoring the data part of the command when normalizing the whitespace in the command?

Example of use with CG_ADD

I don't know what I miss but I'm unable to use the CG_ADD command.

I've tried:

response = client.send(CG_ADD("CG 1 ADD 0 COUNTDOWN 1"))

And I'm getting:

RuntimeError: Command functions do not accept any positional arguments.

Thanks for your help!

dolejska-daniel / amcp-pylib Goto Github PK

amcp-pylib's Introduction

Python AMCP Client Library

Introduction

Installation

Usage examples

Connecting to server

Sending commands

amcp-pylib's People

Contributors

Stargazers

Watchers

amcp-pylib's Issues

asyncio problem

v0.2.1 CG ADD no space between layer and ADD keyword

normalization_extra_whitespace causes whitespace loss in data

Example of use with CG_ADD

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent