RobSpectre/mvf1

mvf1
***************
A Python package, command line interface and MCP server to control video players for
MultiViewer_, the best way to watch Formula 1.
.. image:: https://dl.circleci.com/status-badge/img/gh/RobSpectre/mvf1/tree/main.svg?style=svg
:target: https://dl.circleci.com/status-badge/redirect/gh/RobSpectre/mvf1/tree/main
.. image:: https://codecov.io/gh/RobSpectre/mvf1/branch/main/graph/badge.svg?token=L5N96KXN2V
:target: https://codecov.io/gh/RobSpectre/mvf1
.. image:: https://readthedocs.org/projects/mvf1/badge/?version=latest
:target: https://mvf1.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Table of Contents
=================
.. contents::
:local:
:depth: 1
:backlinks: none
Features
===============
* Command line interface for controlling MultiViewer_. Useful for
integrations with control interfaces like StreamDeck_
* Pythonic interface for controlling MultiViewer_. No GraphQL needed!
* MCP server for controlling MultiViewer_ - perfect for controlling the
broadcast for with AI agents.
* Type hints_
* Full documentation_
* Test coverage_
* black_ Praise the Dark Lord
Installation
===============
The latest version can be installed via pip_.
.. code-block:: bash
$ pip install mvf1
Quickstart
================
Command Line
----------------
.. code-block:: bash
$ mvf1-cli --help
Model Context Protocol (MCP) Server
------------------------------------
.. code-block:: bash
$ mvf1-cli mcp
To use in an AI agent, use your framework's affordance for a stdio MCP
server.
Here is an example with PydanticAI.
.. code-block:: python
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStdio
server = MCPServerStdio(
'mvf1-cli',
args=[
'mcp'
]
)
agent = Agent('openai:gpt-4o', mcp_servers=[server])
Library
----------------
Displaying all players
.. code-block:: python
>>> from mvf1 import MultiViewerForF1
>>> remote = MultiViewerForF1()
>>> remote.players
[6: INTERNATIONAL, 7: PER]
Pause all players
.. code-block:: python
>>> from mvf1 import MultiViewerForF1
>>> remote = MultiViewerForF1()
>>> for player in remote.players:
>>> player.mute()
{'data': {'playerSetMuted': True}}
{'data': {'playerSetMuted': True}}
Retrieve specific player
.. code-block:: python
>>> from mvf1 import MultiViewerForF1
>>> remote = MultiViewerForF1()
>>> player = remote.player(6)
>>> player.state
{'ts': 1677168293.21, 'paused': False, 'muted': True, 'volume': 100, 'live': False, 'currentTime': 10.002025, 'interpolatedCurrentTime': 363.656025}
Switch stream of player to data channel
.. code-block:: python
>>> from mvf1 import MultiViewerForF1
>>> remote = MultiViewerForF1()
>>> player = remote.player(6)
>>> player.switch_stream('DATA')
{'data': {'playerCreate': '12'}}
Synchronize all players to specific player
.. code-block:: python
>>> from mvf1 import MultiViewerForF1
>>> remote = MultiViewerForF1()
>>> player = remote.player(6)
>>> player.sync()
{'data': {'playerSync': True}}
Synchornize all players to player streaming broadcast commentary
.. code-block:: python
>>> from mvf1 import MultiViewerForF1
>>> remote = MultiViewerForF1()