Usage

Installation

To use PyYtLounge, first install it using pip:

(.venv) $ pip install pyytlounge

Initialization

Create an instance of the pyytlounge.YtLoungeApi class, which takes a device name and optionally a logger:

async with YtLoungeApi('Test client') as api:
    ...

As you can see async with …: is used. The class is an asynchronous context manager as on close it needs to clean up the aiohttp session. Alternatively, you can call .close() manually:

api = YtLoungeApi('test client')
...
await api.close()

When we have an instance of the class, we need to pair() with a screen. Currently this can be done through a pairing code (this can be found in the app’s settings) or through the DIAL protocol. Using a pairing code it would look something like this:

pairing_code = input("Enter pairing code: ") # or from another source
paired_and_linked = await api.pair(pairing_code)

If this succeeds the api is now in a linked state. This means we have the two requirements to connect to a screen: the screen identifier and the lounge id token. The screen identifier should remain the same, but the lounge id token can change. If needed, you can refresh the lounge id token using pyytlounge.YtLoungeApi.refresh_auth():

linked = await api.refresh_auth()

From a linked state, the api is ready to connect():

connected = await api.connect()

If a connection is attempted to an unsupported client such as YouTube TV Kids, pyytlounge.exceptions.UnsupportedExceptions will be raised.

If this succeeds, commands can now be submitted, such as seek_to():

# seek to 10 seconds
seek_success = await api.seek_to(time=10)

You can also subscribe() to the screen’s status:

class YtListener(EventListener):
    async def now_playing_changed(self, event: NowPlayingEvent) -> None:
        """Called when active video changes"""
        print(
            f"New state: {event.state} = id: {event.video_id} pos: {event.current_time} duration: {event.duration}"
        )

listener = YtListener()

async with YtLoungeApi('Test client', listener) as api:
    # this will block until the subscription ends
    subscribed = await api.subscribe()