X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fosc58-querying-ardour.html;h=c94ec1009810981b6beec4a83cc4d69253bc033f;hb=935badcb9b12a81f840d447a01999755c4ff9916;hp=a101bebed7588e6c00606f3d674ed1d678a21150;hpb=0d4be5fdfb660d75853e46019e4a5acf3816363b;p=ardour-manual diff --git a/include/osc58-querying-ardour.html b/include/osc58-querying-ardour.html index a101beb..c94ec10 100644 --- a/include/osc58-querying-ardour.html +++ b/include/osc58-querying-ardour.html @@ -5,25 +5,29 @@ information. These set of commands are for smarter control surfaces That have the logic to figure out what to do with the information. These are not of value for mapped controllers like touchOSC and - friends. The controller will need to send these queries to ardour + friends. The controller will need to send these queries to Ardour as often as it needs this information. It may well make sense to use regular feedback for things that need to be updated often such as position or metering. Here are the commands used to query Ardour: (added in Ardour 5.5)

-
-
/strip/list
-
Ask for a list of strips
-
/strip/sends ssid
-
Asks for a list of sends on the strip ssid
-
/strip/receives ssid
-
Asks for a list of tracks that have sends to the strip ssid points to
-
/strip/plugin/list ssid
-
Asks for a list of plug-ins for strip ssid.
-
/plugin/descriptor ssid piid
-
Asks for a list of descriptors for plug-in piid on strip ssid
-
+ + + + + + + + + + + + + + + +
/strip/listAsk for a list of strips
/strip/sends ssidAsks for a list of sends on the strip ssid
/strip/receives ssidAsks for a list of tracks that have sends to the strip ssid points to
/strip/plugin/list ssidAsks for a list of plug-ins for strip ssid.
/strip/plugin/descriptor ssid piidAsks for a list of descriptors for plug-in piid on strip ssid
/set_surfaceAsk for the current surface setting. Reply is in the same form as setting the surface would be.
/surface/listPrint a list of known surfaces and Link Sets to the log window.

A list of strips

@@ -32,14 +36,22 @@ current session has. Ardour replies with a message for each strip with the following information: After all the strip messages have been sent, one final message is sent with: @@ -47,11 +59,24 @@
  • The text end_route_list
  • The session frame rate
  • The last frame number of the session
    • +
  • Monitor section present

    • +

    + The /set_surface should be set before this is called. That way + The right set of strips will be sent in return (though the default is good + for most uses) and feedback will start correctly. +

    +

    + If the surface is using /strip/list, the surface needs to know + if the strips have changed. This would be true if a strip gets moved, created or + deleted. When this happens Ardour sends /strip/list to the surfaces + that have previously requested a /strip/list. This lets the + surface know that its list of strips is no longer valid. +

    A bus will not have a record enable and so a bus message will have one less parameter than a track. It is the controllers - responsability to deal with this. + responsibility to deal with this.

    A list of sends

    @@ -66,7 +91,7 @@
  • The send's target bus ssid
  • The send's target bus name
  • The send id for this strip
    • -
  • The send gain as a fader possition
    • +
  • The send gain as a fader position
  • The Send's enable state
    • @@ -81,13 +106,13 @@

    /strip/receives ssid will return a list of tracks that have sends to the bus at the ssid. The reply will - contain the following information for each track conntected to this + contain the following information for each track connected to this bus:

    @@ -109,17 +134,17 @@

    A list of a plug-in's parameters

    - /plugin/descriptor ssid piid will + /strip/plugin/descriptor ssid piid will return the plug-in parameters for ppid plug-in on the ssid strip. The - reply will contain the following information: + reply will be sent as a number of messages, one for each parameter. + Each message will contain the following information:

    +

    + After all the parameters have been sent this way, one final message" + /strip/plugin/descriptor_end is sent with these parameters: +

    +

    The flag bitset above has been defined as (from lsb):

    + Bits 3 and 4 are not used, they were max unbound and min unbound in + previous versions and always zero.

    While this seems complex, it is really not that bad. Minimum, - maximum and value will in most cases give you all you need. + maximum and value will in most cases give you all you need. For simpler + access to plug-ins, the /select/plugin/ set of commands will handle most + needs. +

    +

    Obtaining a list of surfaces Ardour knows about

    +

    + Ardour can work with more than one OSC control surface at a time. + Sometimes it is useful to know the information stored about all + surfaces. Sending /surface/list from any surface or selecting: + Print surface information to Log window from + the Debug dropdown in the OSC setup dialog, + will list all the information Ardour uses to calculate the feedback + it sends. The Log window can be opened from the menu with + Window > Log. + This would be useful information to include with any OSC + related Bug report. The output is printed in this format: +

    +

    +Surface Output