Add example scripts

Signed-off-by: Christopher Arndt <chris@chrisarndt.de>

Author: SpotlightKid

examples/jack-transport-query.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+
+from ctypes import pointer
+import jacklib
+from jacklib.helpers import get_jack_status_error_string
+
+
+status = jacklib.jack_status_t()
+client = jacklib.client_open("transport-query", jacklib.JackNoStartServer, status)
+
+if status:
+    err = get_jack_status_error_string(status)
+    sys.exit("Error connecting to JACK server: %s" % err)
+
+position = jacklib.jack_position_t()
+transport_state = jacklib.transport_query(client, pointer(position))
+
+for name, type_ in sorted(position._fields_):
+    value = getattr(position, name)
+    if name == 'padding':
+        value = list(value)
+    print("{}: {}".format(name, value), file=sys.stderr)
+
+if transport_state == jacklib.JackTransportStopped:
+    print("JACK transport stopped, starting it now.")
+    jacklib.transport_start(client)
+elif transport_state == jacklib.JackTransportRolling:
+    print("JACK transport rolling, stopping it now.")
+    jacklib.transport_stop(client)
+elif transport_state == jacklib.JackTransportStarting:
+    print("JACK transport starting, nothing to do.")
+else:
+    print("Unknown JACK transport state.")
+
+jacklib.client_close(client)

examples/list_all_client_properties.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+
+import jacklib
+from jacklib.helpers import get_jack_status_error_string
+
+
+if sys.argv[1:]:
+    clientname = sys.argv[1]
+else:
+    sys.exit("Usage: %s <client name>" % sys.argv[0])
+
+status = jacklib.jack_status_t()
+client = jacklib.client_open("list-all-client-properties", jacklib.JackNoStartServer, status)
+
+if status:
+    err = get_jack_status_error_string(status)
+    sys.exit("Error connecting to JACK server: %s" % err)
+
+properties = jacklib.get_client_properties(client, clientname)
+
+for prop in properties:
+    print("{p.key}: {p.value} (type: {p.type})".format(p=prop))
+
+jacklib.client_close(client)

examples/list_all_port_properties.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+
+import jacklib
+from jacklib.helpers import get_jack_status_error_string
+
+
+if sys.argv[1:]:
+    portname = sys.argv[1]
+else:
+    sys.exit("Usage: %s <port name>" % sys.argv[0])
+
+status = jacklib.jack_status_t()
+client = jacklib.client_open("list-all-port-properties", jacklib.JackNoStartServer, status)
+
+if status:
+    err = get_jack_status_error_string(status)
+    sys.exit("Error connecting to JACK server: %s" % err)
+
+properties = jacklib.get_port_properties(client, portname)
+
+for prop in properties:
+    print("{p.key}: {p.value} (type: {p.type})".format(p=prop))
+
+jacklib.client_close(client)

examples/list_all_properties.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+
+import jacklib
+from jacklib.helpers import get_jack_status_error_string
+
+
+status = jacklib.jack_status_t()
+client = jacklib.client_open("list-all-properties", jacklib.JackNoStartServer, status)
+
+if status:
+    err = get_jack_status_error_string(status)
+    sys.exit("Error connecting to JACK server: %s" % err)
+
+properties = jacklib.get_all_properties()
+
+for subject, props in properties.items():
+    print("Subject %s:" % subject)
+
+    for prop in props:
+        print("* {p.key}: {p.value} (type: {p.type})".format(p=prop))
+
+    print('')
+
+jacklib.client_close(client)

examples/list_port_info.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+
+import jacklib
+from jacklib.helpers import c_char_p_p_to_list, get_jack_status_error_string
+
+
+status = jacklib.jack_status_t()
+client = jacklib.client_open("list-port-info", jacklib.JackNoStartServer, status)
+
+if status:
+    err = get_jack_status_error_string(status)
+    sys.exit("Error connecting to JACK server: %s" % err)
+
+for portname in c_char_p_p_to_list(jacklib.get_ports(client)):
+    port = jacklib.port_by_name(client, portname)
+    uuid = jacklib.port_uuid(port)
+
+    print("Port name: %s\nUUID: %s" % (portname, uuid))
+    num_aliases, *aliases = jacklib.port_get_aliases(port)
+    if num_aliases:
+        print("Aliases: %s" % ", ".join(aliases[:num_aliases]))
+
+    pretty_name = jacklib.get_port_pretty_name(client, portname)
+    if pretty_name:
+        print("Pretty-name: {}".format(pretty_name))
+
+    props = jacklib.get_port_properties(client, portname)
+    if props:
+        print("Properties:")
+        for prop in props:
+            print(" * {}: {} (type: {})".format(prop.key, prop.value, prop.type))
+
+    print('')
+
+jacklib.client_close(client)

examples/print_port_pretty_name.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+
+import jacklib
+from jacklib.helpers import get_jack_status_error_string
+
+
+if sys.argv[1:]:
+    portname = sys.argv[1]
+else:
+    sys.exit("Usage: %s <port name>" % sys.argv[0])
+
+status = jacklib.jack_status_t()
+client = jacklib.client_open("print-port-pretty-name", jacklib.JackNoStartServer, status)
+
+if status:
+    err = get_jack_status_error_string(status)
+    sys.exit("Error connecting to JACK server: %s" % err)
+
+pretty_name = jacklib.get_port_pretty_name(client, portname)
+print("Pretty name for '%s': %r" % (portname, pretty_name or '<not set>'))
+
+jacklib.client_close(client)

examples/set_port_pretty_name.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+
+import jacklib
+from jacklib.helpers import get_jack_status_error_string
+
+
+if len(sys.argv) == 3:
+    portname = sys.argv[1]
+    pretty_name = sys.argv[2]
+else:
+    sys.exit("Usage: %s <port name> <pretty-name>" % sys.argv[0])
+
+status = jacklib.jack_status_t()
+client = jacklib.client_open("set-port-pretty-name", jacklib.JackNoStartServer, status)
+
+if status:
+    err = get_jack_status_error_string(status)
+    sys.exit("Error connecting to JACK server: %s" % err)
+
+res = jacklib.set_port_pretty_name(client, portname, pretty_name)
+if res != -1:
+    print("Pretty name for port '%s' is now '%s'." % (portname, pretty_name))
+
+
+jacklib.client_close(client)