{"id":9977,"date":"2022-06-21T09:10:36","date_gmt":"2022-06-21T09:10:36","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/documentation\/rdk_video_documentation\/components\/open-sourced_components\/device_settings\/"},"modified":"2025-03-25T05:18:35","modified_gmt":"2025-03-25T05:18:35","slug":"device_settings","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/","title":{"rendered":"Device Settings"},"content":{"rendered":"<div class=\"toc-macro client-side-toc-macro  conf-macro output-block\" data-headerelements=\"H1,H2,H3,H4,H5,H6,H7\" data-hasbody=\"false\" data-macro-name=\"toc\"><\/div>\n<h3 class=\"wp-sub-header\">Overview<\/h3>\n<p>RDK Device Settings library is a cross-platform library for controlling the following hardware configurations:<\/p>\n<ul>\n<li><span>Audio Output Ports (Volume, Mute, etc.)<\/span><\/li>\n<li><span>Video Ouptut Ports (Resolutions, Aspect Ratio, etc.)<\/span><\/li>\n<li><span>Front Panel Indicators<\/span><\/li>\n<li><span>Zoom Settings<\/span><\/li>\n<li><span>Display (Aspect Ratio, EDID data etc.)<\/span><\/li>\n<li><span>General Host configuration (Power managements, event management etc.)<\/span><\/li>\n<\/ul>\n<p>The library is split into three major components<\/p>\n<ul>\n<li><span>Application Level APIs. <\/span><\/li>\n<li><span>SoC level APIs. (SoC component)<\/span><\/li>\n<li><span>IARM support. <\/span><\/li>\n<\/ul>\n<h3 class=\"wp-sub-header\">Application Level API<\/h3>\n<p>This is the API that application should use to control hardware configurations in a platform independent way.&nbsp; It also hides single-app and multi-app difference of the implementation from the applications. This allows the application to switch among different SoC versions or between single or multi app mode freely.<\/p>\n<p>Example: API to get the current video resolution :<\/p>\n<p>const VideoResolution &amp; VideoOutputPort::getResolution() const<\/p>\n<h3 class=\"wp-sub-header\">SoC Level API<\/h3>\n<p>SoC Level APIs that that need to implement by SoC vendors. It provides primitive and hardware specific implementation&nbsp; for each controllable aspect of their device.&nbsp; This level API is considered single-app mode only, even though its SoC implementation may potentially support multiple-app mode.<\/p>\n<p>Example: API to get the current video resolution :<\/p>\n<p>dsError_t dsGetResolution ( int handle, dsVideoPortResolution_t *resolution )&nbsp;<\/p>\n<h3 class=\"wp-sub-header\">IARM Support<\/h3>\n<p>If multiple applications need to control the device settings simultaneously, this component turns the single-app mode SoC level API into multi-app mode.&nbsp; Even though some SoC vendors implement the SoC level API to be multi-app capable, we still use IARM support to achieve multiple-app mode. This allows the Application level API to remain truly platform neutral.<\/p>\n<h3 class=\"wp-sub-header\">Architectural Overview<\/h3>\n<p>The Device Settings (DS) registers its services with the service manager.&nbsp;The Application uses\/calls the DS Public API through service manager and&nbsp;DS Public API&rsquo;s intern calls the under lying SoC level API&rsquo;s to perform the required functionality.<\/p>\n<p><img decoding=\"async\" src=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/Block%20diagram.drawio.png\"><\/p>\n<h3 class=\"wp-sub-header\">Multi-App mode Support using IARM<\/h3>\n<p>Multi-app mode is used when multiple applications need to control the device settings simultaneously.&nbsp;Some SoC vendors implement the SoC level API to be multi-app capable, we still use IARM support to achieve multiple-app mode. This allows the Application level API to remain truly platform neutral.<\/p>\n<p><img decoding=\"async\" src=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/Multi-App%20mode%20Support%20using%20IARM%20diagram.drawio.png\"><\/p>\n<p>The below diagram depicts that how multi-app designed in RDK.<\/p>\n<p><span class=\"talk-image\"><span class=\"confluence-embedded-file-wrapper\"><\/p>\n<p><img decoding=\"async\" src=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/RDK-DeviceSettings-Overview.drawio.png\"><\/span><\/span><\/p>\n<h3 class=\"wp-sub-header\"><span class=\"talk-image\"><span class=\"confluence-embedded-file-wrapper\">Device Settings Programming Guide<br \/>\n<\/span><\/span><\/h3>\n<p><span class=\"talk-image\"><span class=\"confluence-embedded-file-wrapper\">First we need to initialize the IARMbus and device manager, perform the required task making use of the API&rsquo;s and and finally need to de-initialize the device manager and disconnect the IARMbus.<\/span><\/span><\/p>\n<p><span class=\"talk-image\"><span class=\"confluence-embedded-file-wrapper\">Simple use case to set the resolution&nbsp;<\/span><\/span><\/p>\n<p><span class=\"talk-image\"><span class=\"confluence-embedded-file-wrapper\"><span class=\"confluence-embedded-file-wrapper confluence-embedded-manual-size\"><img decoding=\"async\" src=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/image2017-10-13_9-43-27.png\"><\/span><br \/>\n<\/span><\/span><\/p>\n<p><span class=\"talk-image\"><span class=\"confluence-embedded-file-wrapper\"><br \/>\n<\/span><\/span><\/p>\n<h3 class=\"wp-sub-header\"><span class=\"talk-image\"><span class=\"confluence-embedded-file-wrapper\">API Documentation<\/span><\/span><\/h3>\n<p><span class=\"talk-image\"><span class=\"confluence-embedded-file-wrapper\">To know more about SoC\/Application level APIs details use in RDK, refer the link&nbsp;<a href=\"https:\/\/wiki.rdkcentral.com\/doxygen\/rdkv-opensourced\/d8\/d6e\/group__devicesettingsapi.html\" rel=\"nofollow\">Device Settings API Documentation<\/a><\/span><\/span><\/p>\n<p><span class=\"talk-image\"><span class=\"confluence-embedded-file-wrapper\"><br \/>\n<\/span><\/span><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Overview RDK Device Settings library is a cross-platform library for controlling the following hardware configurations: [&hellip;]<\/p>\n","protected":false},"author":28,"featured_media":0,"parent":9844,"menu_order":23,"comment_status":"open","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-9977","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.9 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Device Settings - RDK Documentation Portal | Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Device Settings - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"Overview RDK Device Settings library is a cross-platform library for controlling the following hardware configurations: [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-03-25T05:18:35+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/\",\"name\":\"Device Settings - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2022-06-21T09:10:36+00:00\",\"dateModified\":\"2025-03-25T05:18:35+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"RDK Video\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Components\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Device Settings\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/\",\"name\":\"RDK Documentation Portal | Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Device Settings - RDK Documentation Portal | Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/","og_locale":"en_US","og_type":"article","og_title":"Device Settings - RDK Documentation Portal | Documentation","og_description":"Overview RDK Device Settings library is a cross-platform library for controlling the following hardware configurations: [&hellip;]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2025-03-25T05:18:35+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/","name":"Device Settings - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2022-06-21T09:10:36+00:00","dateModified":"2025-03-25T05:18:35+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/device_settings\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"RDK Video","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/"},{"@type":"ListItem","position":4,"name":"Components","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/"},{"@type":"ListItem","position":5,"name":"Device Settings"}]},{"@type":"WebSite","@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website","url":"https:\/\/developer.rdkcentral.com\/documentation\/","name":"RDK Documentation Portal | Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9977","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/comments?post=9977"}],"version-history":[{"count":3,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9977\/revisions"}],"predecessor-version":[{"id":12202,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9977\/revisions\/12202"}],"up":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9844"}],"wp:attachment":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/media?parent=9977"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}