{"id":4814,"date":"2021-12-08T19:37:35","date_gmt":"2021-12-08T11:37:35","guid":{"rendered":"https:\/\/www.enablex.io\/developer\/?page_id=4814"},"modified":"2025-02-23T13:11:23","modified_gmt":"2025-02-23T05:11:23","slug":"configure-view","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video-api\/client-api\/cordova-toolkit\/configure-view\/","title":{"rendered":"Configure View: Cordova\/Ionic SDK &#8211; Video API"},"content":{"rendered":"\n<h4>Table of Contents<\/h4>\n\n\n\n<ul><li><a href=\"#hide-local-view\">Hide &amp; Unhide Local View<\/a><\/li><li><a href=\"#hide-remote-view\">Hide &amp; Unhide Remote View<\/a><\/li><li><a href=\"#hide-screenshare\">Hide &amp; Unhide Screenshare View<\/a><\/li><li><a href=\"#hide-canvas\">Hide &amp; Unhide Canvas View<\/a><\/li><li><a href=\"#resize-local-view\">Resize Local View<\/a><\/li><li><a href=\"#resize-remote-view\">Resize Remote View<\/a><\/li><li><a href=\"#get-video-quality\">Receive Desired Video Quality<\/a><\/li><li><a href=\"https:\/\/www.enablex.io\/developer\/wp-admin\/post.php?post=2490&amp;action=edit#adjust-layout\">Adjust Player Layout<\/a><\/li><\/ul>\n\n\n\n<a name=\"hide-local-view\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Hide &amp; Unhide Local View<\/h2>\n\n\n\n<p>Use <code>window.EnxRtc.hideSelfView()<\/code> method to hide and unhide local stream view in the running conference.<\/p>\n\n\n\n<p><strong>Method:<\/strong> <code>hideSelfView( hide, successCallback, errorCallback )<\/code><\/p>\n\n\n\n<p><strong>Parameters:<\/strong><\/p>\n\n\n\n<ul><li><code>@param {boolean} hide<\/code> &#8211; <em>true<\/em> to hide and <em>false<\/em> to unhide<\/li><li><code>@param {CallableFunction} successCallback<\/code><\/li><li><code>@param {CallableFunction} errorCallback<\/code><\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/ To hide local view\nwindow.EnxRtc.hideSelfView(true,function (data) {\nconsole.log('Excelsior succuss! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});\n\n\/\/ To unhide local view\nwindow.EnxRtc.hideSelfView(false,function (data) {\nconsole.log('Excelsior succuss! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});<\/pre>\n\n\n\n<a name=\"hide-remote-view\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Hide &amp; Unhide Remote View<\/h2>\n\n\n\n<p>Use <code>window.EnxRtc.hideRemoteView() <\/code>method to hide and unhide remote stream view in the running conference.<\/p>\n\n\n\n<p><strong>Method:<\/strong> <code>hideRemoteView( hide, successCallback, errorCallback )<\/code><\/p>\n\n\n\n<p><strong>Parameters:<\/strong><\/p>\n\n\n\n<ul><li><code>@param {boolean} hide<\/code> &#8211; <em>true<\/em> to hide and <em>false<\/em> to unhide<\/li><li><code>@param {CallableFunction} successCallback<\/code><\/li><li><code>@param {CallableFunction} errorCallback<\/code><\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/ To hide Remote view\nwindow.EnxRtc.hideRemoteView(true,function (data) {\nconsole.log('Excelsior succuss! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});\n\n\/\/ To unhide Remote view\nwindow.EnxRtc.hideRemoteView(false,function (data) {\nconsole.log('Excelsior succuss! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});<\/pre>\n\n\n\n<a name=\"hide-screenshare\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Hide &amp; Unhide Screenshare View<\/h2>\n\n\n\n<p>Use <code>window.EnxRtc.hideScreenShareView()<\/code> method to hide and unhide screen share view in the running conference.<\/p>\n\n\n\n<p><strong>Methods:<\/strong> <code>hideScreenShareView( hide, successCallback, errorCallback )<\/code><\/p>\n\n\n\n<p><strong>Parameters:<\/strong><\/p>\n\n\n\n<ul><li><code>@param {boolean} hide <\/code>&#8211; <em>true<\/em> to hide and <em>false<\/em> to unhide<\/li><li><code>@param {CallableFunction} successCallback<\/code><\/li><li><code>@param {CallableFunction} errorCallback<\/code><\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/ To hide screen share view\nwindow.EnxRtc.hideScreenShareView(true,function (data) {\nconsole.log('Excelsior succuss! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});\n\n\/\/ To unhide screen share view\nwindow.EnxRtc.hideScreenShareView(false,function (data) {\nconsole.log('Excelsior succuss! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});<\/pre>\n\n\n\n<a name=\"hide-canvas\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Hide &amp; Unhide Canvas View<\/h2>\n\n\n\n<p>Use <code>window.EnxRtc.hideCanvasScreen()<\/code> method to hide and unhide canvas view in the running conference.<\/p>\n\n\n\n<p><strong>Method:<\/strong> <code>hideCanvasScreen( hide, successCallback, errorCallback )<\/code><\/p>\n\n\n\n<p><strong>Parameters:<\/strong><\/p>\n\n\n\n<ul><li><code>@param {boolean} hide<\/code> &#8211; <em>true<\/em> to hide and <em>false<\/em> to unhide<\/li><li>@param {CallableFunction} successCallback<\/li><li>@param {CallableFunction} errorCallback<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/ To hide Canvas view\nwindow.EnxRtc.hideCanvasScreen(true,function (data) {\nconsole.log('Excelsior succuss! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});\n\n\/\/ To unhide Canvas view\nwindow.EnxRtc.hideCanvasScreen(false,function (data) {\nconsole.log('Excelsior succuss! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});<\/pre>\n\n\n\n<a name=\"resize-local-view\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Resize Local View<\/h2>\n\n\n\n<p>Use <code>window.EnxRtc.resizeLocalView()<\/code> method to resize the local view in the running conference.<\/p>\n\n\n\n<p><strong>Method:<\/strong> <code>resizeLocalView( resizeOptions, successCallback, errorCallback )<\/code><\/p>\n\n\n\n<p><strong>Parameters:<\/strong><\/p>\n\n\n\n<ul><li><code>@param {JSON} resizeOptions<\/code> &#8211; Consists of Display attributes as given below:<ul><li><code>height<\/code><\/li><li><code>width<\/code><\/li><li><code>margin_top<\/code><\/li><li><code>margin_left<\/code><\/li><li><code>margin_right<\/code><\/li><li><code>margin_bottom<\/code><\/li><li><code>position<\/code><\/li><\/ul><\/li><li><code>@param {CallableFunction} successCallback<\/code><\/li><li><code>@param {CallableFunction} errorCallback<\/code><\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">var options = {\nheight: 130,\nwidth: 100,\nmargin_top: 50,\nmargin_left: 0,\nmargin_right: 15,\nmargin_bottom: 10,\nposition: \"top\"\n};\n\nwindow.EnxRtc.resizeLocalView(options ,function (data) {\nconsole.log('Excelsior succuss! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});<\/pre>\n\n\n\n<a name=\"resize-remote-view\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Resize Remote View<\/h2>\n\n\n\n<p>Use <code>window.EnxRtc.resizeRemoteView() <\/code>method to resize the remote view in the running conference.<\/p>\n\n\n\n<p><strong>Method:<\/strong> <code>resizeRemoteView( resizeOptions, successCallback, errorCallback )<\/code><\/p>\n\n\n\n<p><strong>Parameters:<\/strong><\/p>\n\n\n\n<ul><li><code>@param {JSON} resizeOptions<\/code> &#8211; Contains display attributes as given below:<ul><li><code>height<\/code><\/li><li><code>width<\/code><\/li><li><code>margin_top<\/code><\/li><li><code>margin_left<\/code><\/li><li><code>margin_right<\/code><\/li><li><code>margin_bottom<\/code><\/li><li><code>position<\/code><\/li><\/ul><\/li><li><code>@param {CallableFunction} successCallback<\/code><\/li><li><code>@param {CallableFunction} errorCallback<\/code><\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">var options = {\nheight: 130,\nwidth: 100,\nmargin_top: 50,\nmargin_left: 0,\nmargin_right: 15,\nmargin_bottom: 10,\nposition: \"center\"\n};\n\nwindow.EnxRtc.resizeRemoteView(options ,function (data) {\nconsole.log('Excelsior succuss! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});<\/pre>\n\n\n\n<a name=\"get-video-quality\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Receive Desired Video Quality<\/h2>\n\n\n\n<p>The Client End Point may opt to receive the desired video quality for available bandwidth. You may create UI based on the enumerated values of video quality as explained below.<\/p>\n\n\n\n<p><strong>Method:&nbsp;<\/strong>To set the desired video quality<\/p>\n\n\n\n<p><code>setReceiveVideoQuality( videoQualityOptions, successCallback, errorCallback )<\/code><\/p>\n\n\n\n<p><strong>Parameters:&nbsp;<\/strong><\/p>\n\n\n\n<ul><li><code>@param {JSON} videoQualityOptions<\/code> &#8211; JSON Object consisting of the following keys:<ul><li><code>videoQuality<\/code>: Enumerated Values: <code>Auto, HD, SD, LD.<\/code> Set it to Auto if you want the Portal to decide optimum quality for you dynamically.<\/li><li><code>streamType<\/code>: Enumerated Values: <code>talker, canvas<\/code><\/li><\/ul><\/li><li><code>@param {CallableFunction} successCallback<\/code><\/li><li><code>@param {CallableFunction} errorCallback<\/code><\/li><\/ul>\n\n\n\n<p><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">var videoQualityOptions = {\nstreamType: \u201cAuto\u201d,\nvideoQuality: \u201ctalker\u201d\n};\nwindow.EnxRtc.setReceiveVideoQuality(videoQualityOptions ,function (data)\n{\nconsole.log('Excelsior success! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});<\/pre>\n\n\n\n<p><strong>Method:<\/strong> To get currently selected video quality<\/p>\n\n\n\n<p><code>getReceiveVideoQuality( streamType, successCallback, errorCallback )<\/code><\/p>\n\n\n\n<p><strong>Parameters:<\/strong><\/p>\n\n\n\n<ul><li><code>@param {String} streamType - It should be talker or canvas<\/code><\/li><li><code>@param {CallableFunction} successCallback<\/code><\/li><li><code>@param {CallableFunction} errorCallback<\/code><\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">window.EnxRtc.getReceiveVideoQuality(\u201ctalker\u201d ,function (data) {\nconsole.log('Excelsior success! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});<\/pre>\n\n\n\n<a name=\"adjust-layout\"><\/a>\n\n\n\n<div style=\"height:41px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Adjust Player Layout<\/h2>\n\n\n\n<p>The <code>window.EnxRtc.adjustLayout()<\/code> helps to adjust Video Player Layout in case you have received complete Active Talker View. If the user rotates Screen, this method will help Video layout to re-<br>adjust to fit within its Parent View.<\/p>\n\n\n\n<p><strong>Method:<\/strong> <code>adjustLayout( successCallback, errorCallback )<\/code><\/p>\n\n\n\n<p><strong>Parameters:<\/strong><\/p>\n\n\n\n<ul><li><code>@param {CallableFunction} successCallback<\/code><\/li><li><code>@param {CallableFunction} errorCallback<\/code><\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">window.EnxRtc.adjustLayout(function (data) {\nconsole.log('Excelsior success! ' + JSON.stringify(data.data));\n}, function (err) {\nconsole.log('Uh oh\u2026 error' + JSON.stringify(err));\n});<\/pre>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<hr class=\"wp-block-separator is-style-wide\"\/>\n\n\n\n<div class=\"wp-block-columns\">\n<div class=\"wp-block-column\">\n<p>\u2190 <a href=\"..\/floor-access-control\/\">Lecture Mode<\/a><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column\">\n<p class=\"has-text-align-center\"><a href=\"..\/\">Index<\/a><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column\">\n<p class=\"has-text-align-right\"><a href=\"..\/live-media-statistics\/\"><\/a><a href=\"..\/live-media-statistics\/\">Get Live Media Statistics<\/a> \u2192<a href=\"\/developer\/how-to-use\/\"><\/a><\/p>\n<\/div>\n<\/div>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Table of Contents Hide &amp; Unhide Local View Hide &amp; Unhide Remote View Hide &amp; Unhide Screenshare View Hide &amp; Unhide Canvas View Resize Local View Resize Remote View Receive Desired Video Quality Adjust Player Layout Hide &amp; Unhide Local View Use window.EnxRtc.hideSelfView() method to hide and unhide local stream view in the running conference. Method: hideSelfView( hide, successCallback, errorCallback ) Parameters: @param {boolean} hide &#8211; true to hide and&hellip; <\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3719,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"ub_ctt_via":""},"featured_image_src":null,"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"featured":false,"featured-large":false},"uagb_author_info":{"display_name":"vcxdevwpadmin","author_link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/author\/vcxdevwpadmin\/"},"uagb_comment_info":0,"uagb_excerpt":"Table of Contents Hide &amp; Unhide Local View Hide &amp; Unhide Remote View Hide &amp; Unhide Screenshare View Hide &amp; Unhide Canvas View Resize Local View Resize Remote View Receive Desired Video Quality Adjust Player Layout Hide &amp; Unhide Local View Use window.EnxRtc.hideSelfView() method to hide and unhide local stream view in the running conference.&hellip;","_links":{"self":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4814"}],"collection":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/comments?post=4814"}],"version-history":[{"count":0,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4814\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3719"}],"wp:attachment":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/media?parent=4814"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}