Requesting help to get started using the API to control the configuration

[helarsen]

Question

I am streaming usb camera's to rtsp and want to dynamically control the name of the stream based on the camera serial number. This works well by patching the mediamtx.yml file with the proper path name and RunOnDemand string . MediaMTx automatically picks up the changes. Impressive work!
I learn that it is possible to query and control the configuration using the API interface described here. Unfortunately this documentation is very terse and I have not been able to figure out exactly how to use this. The get operations are fairly obvious, but less so the control operations.
My query is if someone can point me in the right direction to get started. I would prefer to use python. Are there a python library around to assist in this?
Thanks for any hints provided.

[aler9]

Hello, if want a ready-to-use client library for interacting with MediaMTX, you can generate one by using openapi-generator.

Download the MediaMTX API definitions here:
https://github.com/bluenviron/mediamtx/blob/main/apidocs/openapi.yaml

Then install openapi-generator:

sudo pip install openapi-generator-cli

then generate the library:

openapi-generator-cli generate -i openapi.yaml -g python

then take a look at the README.md that was just generated. It provides ready-to-use code:

import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:9997
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:9997"
)



# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.ConfigurationApi(api_client)

    try:
        # returns the global configuration.
        api_response = api_instance.config_global_get()
        print("The response of ConfigurationApi->config_global_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ConfigurationApi->config_global_get: %s\n" % e)

[helarsen]

Thank you aler9 - appreciate your kind help. Very useful!