{"id":4420,"date":"2019-06-14T12:25:31","date_gmt":"2019-06-14T10:25:31","guid":{"rendered":"https:\/\/demdlx704as001.ad.harman.com\/?page_id=4420"},"modified":"2020-02-26T15:37:37","modified_gmt":"2020-02-26T14:37:37","slug":"audio-object-developers-guide","status":"publish","type":"page","link":"https:\/\/audioworx.transfunnel.co\/old\/?page_id=4420","title":{"rendered":"Audio Object Developers Guide"},"content":{"rendered":"
<\/span> <\/span><\/a><\/span>
<\/div>
<\/div><\/div>
\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t<\/span>
  1. Purpose of this Document<\/a><\/span>
    <\/div>
    1. Terms and Abbreviations<\/a>
      <\/div><\/li>
    2. Requirements<\/a>
      <\/div><\/li><\/ol><\/li>
    3. Overview<\/a><\/span>
      <\/div>
      1. Audio Object Workflow<\/a>
        <\/div><\/li>
      2. Audio Object Class<\/a>
        <\/div><\/li><\/ol><\/li>
      3. Audio Object Configuration<\/a><\/span>
        <\/div>
        1. Design Time Configuration<\/a><\/span>
          <\/div>
          1. Object Description<\/a>
            <\/div><\/li>
          2. Mode Description<\/a>
            <\/div><\/li>
          3. GetObjectIO Description<\/a>
            <\/div><\/li>
          4. Metadata<\/a><\/span>
            <\/div>
            1. Static Metadata<\/a>
              <\/div><\/li>
            2. Dynamic Metadata<\/a>
              <\/div><\/li><\/ol><\/li><\/ol><\/li>
            3. Advanced Design Time Configuration<\/a><\/span>
              <\/div>
              1. Additional Object Configuration<\/a>
                <\/div><\/li>
              2. Adding Additional Variables to Audio Object<\/a>
                <\/div><\/li>
              3. Audio Object description file for tuning and control<\/a>
                <\/div><\/li>
              4. Audio Object Memory<\/a><\/span>
                <\/div>
                1. API<\/a>
                  <\/div><\/li>
                2. Memory Configuration on GTT <\/a>
                  <\/div><\/li>
                3. Memory allocation in framework<\/a>
                  <\/div><\/li>
                4. Audio Object Memory Declaration and Usage<\/a>
                  <\/div><\/li><\/ol><\/li><\/ol><\/li><\/ol><\/li>
                5. Basic Features and APIs<\/a><\/span>
                  <\/div>
                  1. Constructor<\/a>
                    <\/div><\/li>
                  2. GetSize<\/a>
                    <\/div><\/li>
                  3. Init<\/a>
                    <\/div><\/li>
                  4. Calc<\/a>
                    <\/div><\/li>
                  5. TuneXTP<\/a>
                    <\/div><\/li>
                  6. Control<\/a>
                    <\/div><\/li><\/ol><\/li>
                  7. Advanced Features and APIs<\/a><\/span>
                    <\/div>
                    1. Audio Object Additional Configuration<\/a>
                      <\/div><\/li>
                    2. Audio Object Sub Blocks<\/a>
                      <\/div><\/li>
                    3. Audio Object AO Switch Processing State<\/a><\/span>
                      <\/div>
                      1. Audio Object Processing states<\/a>
                        <\/div><\/li>
                      2. Audio Object Bypass<\/a>
                        <\/div><\/li>
                      3. Audio Object Mute<\/a>
                        <\/div><\/li>
                      4. Audio Object Stop<\/a>
                        <\/div><\/li>
                      5. Audio Object Ramp-Up<\/a>
                        <\/div><\/li>
                      6. Audio Object Ramp-Down<\/a>
                        <\/div><\/li>
                      7. Audio Object Ramp-DownUp<\/a>
                        <\/div><\/li><\/ol><\/li>
                      8. Debug and Monitoring<\/a><\/span>
                        <\/div>
                        1. Live streaming of state variable or state memory<\/a>
                          <\/div><\/li><\/ol><\/li>
                        2. Background Method<\/a>
                          <\/div><\/li><\/ol><\/li>
                        3. Audio object Examples<\/a><\/span>
                          <\/div>
                          1. Example 1 - AwxAudioObjExt.cpp<\/a>
                            <\/div><\/li>
                          2. Example 2 - AwxAudioObjExtToolbox.cpp<\/a>
                            <\/div><\/li>
                          3. Example 3 - AwxAudioObjExtMemRecs.cpp<\/a>
                            <\/div><\/li>
                          4. Example 4 - AwxAudioObjExt.h<\/a>
                            <\/div><\/li>
                          5. Example 5 - AwxAudioObjExtToolbox.h<\/a>
                            <\/div><\/li>
                          6. Example 6 - AwxAudioObjExtMemRecs.h<\/a>
                            <\/div><\/li><\/ol><\/li>
                          7. General Guidelines<\/a><\/span>
                            <\/div>
                            1. Hardware Abstraction<\/a>
                              <\/div><\/li>
                            2. Hardware Abstraction for Header files<\/a>
                              <\/div><\/li>
                            3. Memory Enums<\/a>
                              <\/div><\/li>
                            4. Overlays<\/a>
                              <\/div><\/li><\/ol><\/li>
                            5. Adding external audio object into AudioworX package<\/a><\/span>
                              <\/div>
                              1. Building External AO<\/a>
                                <\/div><\/li><\/ol><\/li><\/ol><\/div><\/div>

                                1.<\/span>Purpose of this Document<\/span> <\/span><\/span>
                                <\/div><\/h2>

                                This guide is intended to help developers in creating audio objects in the Extended Audio Framework (xAF). The framework act as a gateway between the audio object and the outside world.<\/p>\n

                                This guide covers the following topics:<\/p>\n