diff options
author | Loïc Collignon [ IoT.bzh ] <loic.collignon@iot.bzh> | 2018-10-01 13:54:38 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@automotivelinux.org> | 2018-10-01 13:54:38 +0000 |
commit | 3e30a30b9f59415ed305688b8d1ba38998ad4fbb (patch) | |
tree | 110ee0a10ac67da76b0c84c1c3350803190fe6f4 /docs/high-level-api/kickstart.md | |
parent | 665d2d7ec8dd1465538c83df95e29c23de2cffcb (diff) | |
parent | 75e26b091f6aae38c9edb069c173bcb04ae3ffd1 (diff) |
Merge "Updated documentation"
Diffstat (limited to 'docs/high-level-api/kickstart.md')
-rw-r--r-- | docs/high-level-api/kickstart.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/high-level-api/kickstart.md b/docs/high-level-api/kickstart.md new file mode 100644 index 0000000..15e1874 --- /dev/null +++ b/docs/high-level-api/kickstart.md @@ -0,0 +1,22 @@ +# Kickstart + +As an application developer, when you play audio, you have to use a device URI. +Instead of using the default one, guessing one by listing them or even +hardcoding it, you should call **ahl-4a/[role]** with **open** as action. + +The role to open should be defined in a configuration file or hardcoded. If you +hardcode it, please consider to at least define it at one known place so that it +can be easily changed. + +As opening a role may fail, you should test if it returns a success and a device +URI. Both of them should be tested because it's perfectly fine to have a role +without a device URI from 4a point of view (no device is bound to the role thus +no audio can be played in this case). + +Once you have finished to play audio, you should call **ahl-4a/[role]** with +**close** as action. This is important to allow other applications to use the +role when you are not using it. + +You may also want to handle events of the window manager to know if you +application is displayed or not, and open/close accordingly the role you are +using. |