{"id":16850,"date":"2022-05-27T10:49:56","date_gmt":"2022-05-27T08:49:56","guid":{"rendered":"https:\/\/demdlx704as001.ad.harman.com\/?post_type=documentor-sections&#038;p=16850"},"modified":"2024-05-13T12:48:30","modified_gmt":"2024-05-13T10:48:30","slug":"audio-object-example-templatetoolbox-h","status":"publish","type":"post","link":"https:\/\/audioworx.transfunnel.co\/old\/?p=16850","title":{"rendered":"Example 5 &#8211; AwxAudioObjExtToolbox.h"},"content":{"rendered":"<pre>\/\/ ============================================================\r\n\/\/ (C) 2017 Harman International Industries, Incorporated.\r\n\/\/ Confidential &amp; Proprietary. All Rights Reserved.\r\n\/\/ ============================================================\r\n\r\n\/**\r\n*   \\file      AwxAudioObjExtToolbox.h\r\n*   \\brief     AwxAudioObj Audio Object Toolbox - Header file\r\n*   \\details   Project    Extendable Audio Framework\r\n*   \\copyright Harman\/Becker Automotive Systems GmbH\r\n*   \r\n       2017\r\n*   \r\n       All rights reserved\r\n*   \\author    xAF Team\r\n*   \\date      March 28, 2023\r\n*\/\r\n\r\n#ifndef AWXAUDIOOBJEXT_TOOLBOX_H\r\n#define AWXAUDIOOBJEXT_TOOLBOX_H\r\n\r\n\/*!\r\n*   xaf mandataory includes\r\n*\/\r\n#include \"AwxAudioObjExtMemRecs.h\"\r\n#include \"AudioObjectToolbox.h\"\r\n#include \"XafDefs.h\"\r\n\r\n\/** here you can add all required include files required for    \r\n    the core functionality of your objects\r\n**\/\r\n\r\nclass CAwxAudioObjExtToolbox : public CAudioObjectToolbox, public CAwxAudioObjExtMemRecs\r\n{\r\npublic:\r\n    \/**\r\n    *    Default ctor \/ dtor to initialite member variables of the audio object\r\n    *\/\r\n    CAwxAudioObjExtToolbox();\r\n    virtual ~CAwxAudioObjExtToolbox();\r\n\r\n\t\/**\r\n    *    Returns the object description\r\n    *    \\return pointer to structure describing object configuration.\r\n    *\/\r\n    const tObjectDescription*   getObjectDescription() OVERRIDE;\r\n   \r\n\t\/**\r\n     *    Writes object template information to the buffer returns number of bytes written\r\n     *    \\param  info   audio object tuning info.\r\n     *    \\param  buffer buffer for XML output.\r\n     *    \\param  maxLen maximal length of the buffer.\r\n     *    \\return size of generated xml file.\r\n     *\/\r\n\txUInt32 getXmlObjectTemplate(tTuningInfo* info, xInt8* buffer, xUInt32 maxLen) OVERRIDE;\r\n    \r\n\t\/**\r\n     *    \\brief  Returns the overall object description used in the object\r\n     *            within the device description file\r\n     *    \\param  info pointer to TuningInfo structure\r\n     *    \\param  buffer pointer to buffer used for file creation.\r\n     *    \\param  maxlen max allowed size of generated file.\r\n     *    \\return size of generated device.ddf file.\r\n     *\/\r\n\txUInt32 getXmlFileInfo (tTuningInfo* info, xInt8* buffer, xUInt32 maxLen) OVERRIDE;\r\n    \r\n\t\/**\r\n    *    Returns the mode description of object\r\n    *    \\param  mode    index of the selected mode\r\n    *    \\return pointer to the object mode description\r\n    *\/\r\n\tconst tModeDescription* getModeDescription  (xUInt32 mode) OVERRIDE;\r\n    \r\n\t\/**\r\n    *    This function sets the object configuration based on user settings indicated in GTT\r\n    *    \\param  configOut   the configuration of the object sent back to the tool\r\n    *    \\return error code\r\n    *\/\r\n\txAF_Error getObjectIo(ioObjectConfigOutput* configOut) OVERRIDE;\r\n\r\n\t\/**\r\n     *    Returns the additional variable description\r\n     *    \\param  index   index of the additional parameter\r\n     *    \\return instance of additional variable description\r\n     *\/\r\n\tconst additionalSfdVarDescription* getAdditionalSfdVarsDescription(xUInt32  index) OVERRIDE;\r\n    \r\n\t\/**\r\n      *    \\brief  Creates metadata entries for the specific audio object\r\n      *            this function must be overridden by each object supporting\r\n      *            the metadata feature. Otherwise default data will be created.\r\n      *\/\r\n\tvoid createStaticMetadata () OVERRIDE;\r\n\r\n\t\/**\r\n     *    \\brief  Creates mode and configuration dependent metadata entries for the specific audio object\r\n     *            this function must be overridden by each object supporting\r\n     *            the metadata feature.\r\n     *    \\param  configIn  the configuration of audio in, out and num elements passed in by the design tool\r\n     *    \\param  configOut the configuration of the object sent back to the tool\r\n     *\/\r\n    void createDynamicMetadata(ioObjectConfigInput&amp; configIn, ioObjectConfigOutput&amp; configOut) OVERRIDE;\r\nprotected:    \r\n};\r\n#endif \/\/AWXAUDIOOBJEXT_TOOLBOX_H\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>\/\/ ============================================================ \/\/ (C) 2017 Harman International Industries, Incorporated. \/\/ Confidential &amp; Proprietary. All Rights Reserved. \/\/ ============================================================ \/** * \\file AwxAudioObjExtToolbox.h * \\brief AwxAudioObj Audio Object Toolbox &#8211; Header file * \\details Project Extendable Audio Framework * \\copyright Harman\/Becker Automotive Systems GmbH * 2017 * All rights reserved * \\author xAF Team * \\date [&hellip;]<\/p>\n","protected":false},"author":75,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"ocean_post_layout":"","ocean_both_sidebars_style":"","ocean_both_sidebars_content_width":0,"ocean_both_sidebars_sidebars_width":0,"ocean_sidebar":"0","ocean_second_sidebar":"0","ocean_disable_margins":"enable","ocean_add_body_class":"","ocean_shortcode_before_top_bar":"","ocean_shortcode_after_top_bar":"","ocean_shortcode_before_header":"","ocean_shortcode_after_header":"","ocean_has_shortcode":"","ocean_shortcode_after_title":"","ocean_shortcode_before_footer_widgets":"","ocean_shortcode_after_footer_widgets":"","ocean_shortcode_before_footer_bottom":"","ocean_shortcode_after_footer_bottom":"","ocean_display_top_bar":"default","ocean_display_header":"default","ocean_header_style":"","ocean_center_header_left_menu":"0","ocean_custom_header_template":"0","ocean_custom_logo":0,"ocean_custom_retina_logo":0,"ocean_custom_logo_max_width":0,"ocean_custom_logo_tablet_max_width":0,"ocean_custom_logo_mobile_max_width":0,"ocean_custom_logo_max_height":0,"ocean_custom_logo_tablet_max_height":0,"ocean_custom_logo_mobile_max_height":0,"ocean_header_custom_menu":"0","ocean_menu_typo_font_family":"0","ocean_menu_typo_font_subset":"","ocean_menu_typo_font_size":0,"ocean_menu_typo_font_size_tablet":0,"ocean_menu_typo_font_size_mobile":0,"ocean_menu_typo_font_size_unit":"px","ocean_menu_typo_font_weight":"","ocean_menu_typo_font_weight_tablet":"","ocean_menu_typo_font_weight_mobile":"","ocean_menu_typo_transform":"","ocean_menu_typo_transform_tablet":"","ocean_menu_typo_transform_mobile":"","ocean_menu_typo_line_height":0,"ocean_menu_typo_line_height_tablet":0,"ocean_menu_typo_line_height_mobile":0,"ocean_menu_typo_line_height_unit":"","ocean_menu_typo_spacing":0,"ocean_menu_typo_spacing_tablet":0,"ocean_menu_typo_spacing_mobile":0,"ocean_menu_typo_spacing_unit":"","ocean_menu_link_color":"","ocean_menu_link_color_hover":"","ocean_menu_link_color_active":"","ocean_menu_link_background":"","ocean_menu_link_hover_background":"","ocean_menu_link_active_background":"","ocean_menu_social_links_bg":"","ocean_menu_social_hover_links_bg":"","ocean_menu_social_links_color":"","ocean_menu_social_hover_links_color":"","ocean_disable_title":"default","ocean_disable_heading":"default","ocean_post_title":"","ocean_post_subheading":"","ocean_post_title_style":"","ocean_post_title_background_color":"","ocean_post_title_background":0,"ocean_post_title_bg_image_position":"","ocean_post_title_bg_image_attachment":"","ocean_post_title_bg_image_repeat":"","ocean_post_title_bg_image_size":"","ocean_post_title_height":0,"ocean_post_title_bg_overlay":0.5,"ocean_post_title_bg_overlay_color":"","ocean_disable_breadcrumbs":"default","ocean_breadcrumbs_color":"","ocean_breadcrumbs_separator_color":"","ocean_breadcrumbs_links_color":"","ocean_breadcrumbs_links_hover_color":"","ocean_display_footer_widgets":"default","ocean_display_footer_bottom":"default","ocean_custom_footer_template":"0","footnotes":"","ocean_post_oembed":"","ocean_post_self_hosted_media":"","ocean_post_video_embed":"","ocean_link_format":"","ocean_link_format_target":"self","ocean_quote_format":"","ocean_quote_format_link":"post","ocean_gallery_link_images":"on","ocean_gallery_id":[]},"categories":[353],"tags":[],"coauthors":[275],"_links":{"self":[{"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=\/wp\/v2\/posts\/16850"}],"collection":[{"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=\/wp\/v2\/users\/75"}],"replies":[{"embeddable":true,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=16850"}],"version-history":[{"count":4,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=\/wp\/v2\/posts\/16850\/revisions"}],"predecessor-version":[{"id":28069,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=\/wp\/v2\/posts\/16850\/revisions\/28069"}],"wp:attachment":[{"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=16850"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=16850"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=16850"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=%2Fwp%2Fv2%2Fcoauthors&post=16850"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}