{"id":6646,"date":"2022-05-31T15:39:59","date_gmt":"2022-05-31T07:39:59","guid":{"rendered":"https:\/\/doc.smartflomeet.ttns.in\/developer\/?page_id=6646"},"modified":"2025-04-04T20:31:00","modified_gmt":"2025-04-04T12:31:00","slug":"virtual-background-android-sdk","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video\/solutions\/virtual-background\/virtual-background-android-sdk\/","title":{"rendered":"Virtual Background Android SDK v1.0"},"content":{"rendered":"\n

The Virtual Background feature allows users to blur own Video Background or to use a image from Library as as Video Background. This feature works best with a physical green screen at your backdrop or with uniform lighting on a plain backdrop. In other cases, user may experience patchy edges.<\/p><\/blockquote>\n\n\n\n

Download Android SDK v1.0<\/a><\/div>\n\n\n\n

Released: June 1, 2024<\/p>\n\n\n\n

<\/div>\n\n\n\n

How to use Virtual Background SDK?<\/h2>\n\n\n\n

Follow these steps:<\/p>\n\n\n\n

  • You get the .aar file after downloading the Virtual Background SDK.<\/li>
  • You get the .aar file after downloading the Android SDK.<\/li>
  • Add the downloaded .aar files under lib folder.<\/li>
  • Go to your application\u2019s build.gradle<\/code> file and add the following code in the dependencies section:<\/li><\/ul>\n\n\n\n
    implementation 'com.google.mlkit:segmentation-selfie:16.0.0-beta4'\nimplementation 'io.github.zncmn.libyuv:core:0.0.7'\nimplementation fileTree(dir: 'libs', include: ['.aar', '.jar'], exclude: [])<\/pre>\n\n\n\n
    <\/div>\n\n\n\n
    SDK Method & Callbacks<\/h2>\n\n\n\n
    <\/div>\n\n\n\n
    The EnxVirtualBackground.enableVirtualBackground()<\/code> method is used to add Virtual Background to Local Stream. To use this method, you need create an instance of Class EnxVirtualBackground<\/code> and pass it’s reference to the  enableVirtualBackground()<\/code>  method.<\/p>\n\n\n\n
    Class:<\/strong> EnxVirtualBackground<\/p>\n\n\n\n
    Observer<\/strong>: public void EnxVirtualBackgroundStateObserver(EnxVirtualBackgroundStateObserver<\/code>–-Object)<\/code><\/p>\n\n\n\n
    Method:<\/strong> public void  enableVirtualBackground<\/code> ( this<\/code><\/code>,  enxRoom)<\/code><\/p>\n\n\n\n
    Parameters:<\/strong><\/p>\n\n\n\n
    • this<\/code>– This is the self instance reference.<\/li>
    • enxRoom – This is the reference of EnxRoom Object.<\/li><\/ul>\n\n\n\n
      Callbacks:<\/strong><\/p>\n\n\n\n
      • onAttachVirtualBackground<\/code>\u2013 Callback when Virtual Background is attached to the Local Stream.<\/li>
      • onDetachVirtualBackground <\/code>– Callback when Virtual Background is detached from the Local Stream.<\/li>
      • onVirtualBackgroundFailure<\/code> – Callback when Virtual Background fails to attach with Local Stream.<\/li><\/ul>\n\n\n\n
        \/\/ Initiate Object of EnxVirtualBackground\nEnxVirtualBackground virtualBackground = new EnxVirtualBackground(); \n\n\/\/ Enable Virtual Background\nvirtualBackground.enableVirtualBackground(this, enxRoom);\n\n\/\/ Set Observer\nvirtualBackground.SetEnxVirtualBackgroundStateObserver(this);\n\n\n\/\/ Callback when Virtual Background is attached to the Local Stream.\n@Override \npublic void onAttachVirtualBackground(JSONObject jsonObject) { \n\n} \n \n\/\/ Callback when Virtual Background is detached from the Local Stream.\n@Override \npublic void onDetachVirtualBackground(JSONObject jsonObject) { \n\n} \n \n\/\/ Callback when Virtual Background fails to attach with Local Stream.\n@Override \npublic void onVirtualBackgroundFailure(JSONObject jsonObject) { \n\n}<\/pre>\n","protected":false},"excerpt":{"rendered":"
        The Virtual Background feature allows users to blur own Video Background or to use a image from Library as as Video Background. This feature works best with a physical green screen at your backdrop or with uniform lighting on a plain backdrop. In other cases, user may experience patchy edges. Download Android SDK v1.0 Released: June 1, 2024 How to use Virtual Background SDK? Follow these steps: You get the… <\/p>\n","protected":false},"author":1,"featured_media":0,"parent":6642,"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":"The Virtual Background feature allows users to blur own Video Background or to use a image from Library as as Video Background. This feature works best with a physical green screen at your backdrop or with uniform lighting on a plain backdrop. In other cases, user may experience patchy edges. Download Android SDK v1.0 Released:…","_links":{"self":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/6646"}],"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=6646"}],"version-history":[{"count":0,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/6646\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/6642"}],"wp:attachment":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/media?parent=6646"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}