{"id":10575,"date":"2020-08-24T21:43:24","date_gmt":"2020-08-24T19:43:24","guid":{"rendered":"https:\/\/demdlx704as001.ad.harman.com\/?p=10575"},"modified":"2024-05-08T14:19:28","modified_gmt":"2024-05-08T12:19:28","slug":"mode-description","status":"publish","type":"post","link":"https:\/\/audioworx.transfunnel.co\/old\/?p=10575","title":{"rendered":"Audio Object Mode Description"},"content":{"rendered":"<p>Once the object&#8217;s overall description is provided, a mode description has to be provided for every &#8220;Mode&#8221; supported by the object. This number is specified in the section above.<\/p>\n<p class=\"text\"><img decoding=\"async\" class=\"wp-image-4652 size-full\" src=\"https:\/\/audioworx.transfunnel.co\/old\/wp-content\/uploads\/2019\/06\/053.jpg\" alt=\"Mode Description\" width=\"188\" height=\"151\" \/><\/p>\n<p class=\"text\">The table below provides a description of the variables required to describe each mode:<\/p>\n<table class=\"mtr-table mtr-tr-td\" border=\"1\">\n<tbody>\n<tr>\n<td class=\"table-head mtr-td-tag\" data-mtr-content=\"Member\">\n<div class=\"mtr-cell-content\"><strong>Member<\/strong><\/div>\n<\/td>\n<td class=\"table-head mtr-td-tag\" data-mtr-content=\"Description\">\n<div class=\"mtr-cell-content\"><strong>Description<\/strong><\/div>\n<\/td>\n<\/tr>\n<tr>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Member\">\n<div class=\"mtr-cell-content\">Label<\/div>\n<\/td>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Description\">\n<div class=\"mtr-cell-content\">The label of the mode described in the subsequent fields.<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Member\">\n<div class=\"mtr-cell-content\">Description<\/div>\n<\/td>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Description\">\n<div class=\"mtr-cell-content\">Description of what this mode does.<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Member\">\n<div class=\"mtr-cell-content\">NumElementsMin<\/div>\n<\/td>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Description\">\n<div class=\"mtr-cell-content\">The minimum number of elements permitted.<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Member\">\n<div class=\"mtr-cell-content\">NumElementsMax<\/div>\n<\/td>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Description\">\n<div class=\"mtr-cell-content\">The maximum number of elements permitted.<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Member\">\n<div class=\"mtr-cell-content\">NumElementsLabel<\/div>\n<\/td>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Description\">\n<div class=\"mtr-cell-content\">The label for the number of elements. For example, the number of elements in the Parameter Biquad block represents the number of Biquad filters within the Biquad block. This field is populated with \u2019Number of Biquads\u2018 for the Biquad block.<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Member\">\n<div class=\"mtr-cell-content\">Mask<\/div>\n<\/td>\n<td class=\"mtr-td-tag\" data-mtr-content=\"Description\">\n<div class=\"mtr-cell-content\">\n<p>Four bits are used to indicate to GTT if it is possible to configure the audio channels and the number of elements (one for configurable):<\/p>\n<ul>\n<li>CFG_NCHANNEL \u2013 the number of input channels is equal to the output or not? (Xxxx)<\/li>\n<li>CFG_NINPUT \u2013 numAudioIn is variable? (xXxx)<\/li>\n<li>CFG_NOUTPUT \u2013 numAudioOut is variable? (xxXx)<\/li>\n<li>CFG_ELEMENT \u2013 numElements (LSB) is variable? (xxxX)<\/li>\n<li>CFG_NONE \u2013 no configuration<\/li>\n<\/ul>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>The basic configuration information is written to the\u00a0<span class=\"emph\">m_Descriptions<\/span>\u00a0variable in the audio object header file. The\u00a0<span class=\"emph\">tObjectDescription<\/span> structure displays all the variables necessary for configuration that are not dependent on the mode of the object.<\/p>\n<p>For a mode dependent description, the\u00a0<em><strong>tModeDescription<\/strong><\/em> needs to be provided. The example below describes and object that has 2 modes.<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-medium wp-image-4655\" src=\"https:\/\/audioworx.transfunnel.co\/old\/wp-content\/uploads\/2019\/06\/056.jpg\" alt=\"\" width=\"555\" height=\"90\" \/><\/p>\n<p>Once the mode description(s) is set, developers need to override the virtual <strong><em>getModeDescription<\/em><\/strong>\u00a0method inherited from the base class <em><strong>CAudioObject.<\/strong><\/em><\/p>\n<p><img fetchpriority=\"high\" decoding=\"async\" class=\"alignnone size-medium wp-image-4657\" src=\"https:\/\/audioworx.transfunnel.co\/old\/wp-content\/uploads\/2019\/06\/058.jpg\" alt=\"\" width=\"762\" height=\"70\" \/><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Once the object&#8217;s overall description is provided, a mode description has to be provided for every &#8220;Mode&#8221; supported by the object. This number is specified in the section above. The table below provides a description of the variables required to describe each mode: Member Description Label The label of the mode described in the subsequent [&hellip;]<\/p>\n","protected":false},"author":30,"featured_media":0,"comment_status":"open","ping_status":"open","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":"off","ocean_gallery_id":[]},"categories":[1],"tags":[],"coauthors":[181],"_links":{"self":[{"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=\/wp\/v2\/posts\/10575"}],"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\/30"}],"replies":[{"embeddable":true,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=10575"}],"version-history":[{"count":8,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=\/wp\/v2\/posts\/10575\/revisions"}],"predecessor-version":[{"id":27955,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=\/wp\/v2\/posts\/10575\/revisions\/27955"}],"wp:attachment":[{"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=10575"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=10575"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=10575"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/audioworx.transfunnel.co\/old\/index.php?rest_route=%2Fwp%2Fv2%2Fcoauthors&post=10575"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}