{"id":3740,"date":"2021-10-01T15:28:12","date_gmt":"2021-10-01T07:28:12","guid":{"rendered":"https:\/\/www.enablex.io\/developer\/?page_id=3740"},"modified":"2025-04-04T21:20:21","modified_gmt":"2025-04-04T13:20:21","slug":"android-toolkit","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video-api\/client-api\/android-toolkit\/","title":{"rendered":"Android SDK \u2013 Video API"},"content":{"rendered":"\n<blockquote class=\"wp-block-quote\"><p>The Android SDK is used to integrate the RTC sessions with your Native Android Applications. The SDK consists of APIs required to communicate with video Signaling Server and Media Server and to listen to event-based notifications during a session.<\/p><\/blockquote>\n\n\n\n<div class=\"wp-block-columns\">\n<div class=\"wp-block-column\">\n<div class=\"wp-block-button aligncenter\"><a class=\"wp-block-button__link has-very-light-gray-color has-text-color no-border-radius\" href=\"\/developer\/wp-content\/uploads\/video-sdk\/android\/EnxRtcAndroid-release_2.3.24.aar.zip\">Download Android SDK v2.3.24<\/a><\/div>\n\n\n\n<p class=\"has-text-align-center\"> Released:  January 27, 2025 <\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column\">\n<div class=\"wp-block-button aligncenter\"><a class=\"wp-block-button__link has-very-light-gray-color has-text-color no-border-radius\" href=\"\/developer\/wp-content\/uploads\/webrtc-stack\/android\/Enx_WebRTC_Android.zip\">Download WebRTC Library<\/a><\/div>\n\n\n\n<p class=\"has-text-align-center\"> Released:  October 1, 2024 <\/p>\n<\/div>\n<\/div>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>Table of Contents<\/h4>\n\n\n\n<a name=\"how-to\"><\/a>\n\n\n\n<ul><li><strong>General<\/strong><ul><li><a href=\".\/how-to-use\/\">How to use Android SDK?<\/a><\/li><\/ul><\/li><li><strong>Media Device<\/strong><ul><li><a href=\".\/get-devices\/\">Get list of Audio Devices<\/a><\/li><li><a href=\".\/get-devices\/#get-selected-devices\">Get selected Audio Device by User<\/a><\/li><li><a href=\".\/get-devices\/#handle-audio-device-updates\">Handle Device Updates<\/a><\/li><\/ul><\/li><li><a href=\".\/local-stream\/#init-stream\"><strong>Create Local Stream<\/strong><\/a><ul><li><a href=\".\/local-stream\/#init-stream-multi-video-layers\">Initiate Local Stream with Multiple Video Layers<\/a><\/li><\/ul><\/li><li><a href=\".\/room-connection\/\"><strong><strong>Room Connection<\/strong><\/strong><\/a><ul><li><a href=\".\/room-connection\/#init-room\">Initiate a Room<\/a><\/li><li><a href=\".\/room-connection\/#connect-room\">Connect to Room<\/a><\/li><li><a href=\".\/room-connection\/#join-room\">Join a Room with Stream<\/a><\/li><li><a href=\".\/room-connection\/#disconnect-room\">Disconnect from a Room<\/a><\/li><li><a href=\".\/room-connection\/#handle-disconnect-reconnect\">Handle Disconnection &amp; Reconnections<\/a><\/li><li><a href=\".\/video-quality-adaption\/\">Quality Adjustment based on available Bandwidth<\/a><\/li><\/ul><\/li><li><a href=\".\/publishing-local-stream\/\"><strong>Handle Local Stream<\/strong><\/a> <ul><li><a href=\".\/publishing-local-stream\/#publish-stream\">Publish Stream<\/a><\/li><li><a href=\".\/publishing-local-stream\/#unpublish-stream\">Unpublish Stream<\/a><\/li><li><a href=\".\/switch-camera-mic-speaker\/\">Switch Source Media Devices of Published Stream<\/a><ul><li><a href=\".\/switch-camera-mic-speaker\/#switch-camera\">Switch between Rear &amp; Front Camera<\/a><\/li><li><a href=\".\/switch-camera-mic-speaker\/#switch-mic\">Switch to alternate Microphone<\/a><\/li><\/ul><\/li><\/ul><ul><li><a href=\".\/mute-audio-video-stream\/#mute-unmute-audio\">Mute \/ Unmute Audio in a Stream<\/a><\/li><\/ul><ul><li><a href=\".\/mute-audio-video-stream\/#mute-unmute-video\">Mute \/ Unmute Video in a Stream<\/a><\/li><\/ul><\/li><li><strong>Handle Remote Streams<\/strong><ul><li><a href=\".\/subscribing-remote-streams\/\">Subscribe Remote Streams<\/a><\/li><li><a href=\".\/active-talkers\/#active-talkers\">Handle Active Talkers<\/a> <ul><li><a href=\".\/active-talkers\/#get-max-talkers\">Get maximum permissible Talker Count<\/a><\/li><li><a href=\".\/active-talkers\/#get-talker-count\">Get Talker Count<\/a><\/li><li><a href=\".\/active-talkers\/#set-talker-count\">Set Talker Count<\/a><\/li><li><a href=\".\/active-talkers\/#switch-active-talker\">Switch Active Talker View<\/a><\/li><li><a href=\".\/active-talkers\/#playerview\">Switch to Player View<\/a><\/li><\/ul><\/li><li><a href=\"\/developer\/video-api\/client-api\/android%20toolkit\/receiving-video-quality\/\">Receive desired Video Quality<\/a><\/li><\/ul><\/li><li><a href=\".\/stream-information\/\"><strong>Know your Stream<\/strong><\/a><ul><li><a href=\".\/stream-information\/#get-id\">Get Stream ID<\/a><\/li><li><a href=\".\/stream-information\/#get-attributes\">Get Stream Attributes<\/a><\/li><li><a href=\".\/stream-information\/#track-availability\">Verify availability of Media Tracks in Stream<\/a><\/li><li><a href=\".\/stream-information\/#active-audio-video\">Check Audio Video Track Status in Stream<\/a><\/li><li><a href=\".\/stream-information\/#know-local-remote-stream\">Know if Stream is Local or Remote<\/a><\/li><li><a href=\".\/stream-information\/#stream-state\">Know current state of Stream<\/a><\/li><li><a href=\".\/stream-information\/#get-media\">Get Media of a Stream<\/a><\/li><li><a href=\"\/developer\/video-api\/client-api\/android-toolkit\/play-stream\/\">Play Stream<\/a><\/li><\/ul><\/li><li><a href=\".\/room-information\/\"><strong>Know your Room<\/strong><\/a><ul><li><a href=\".\/room-information\/#get-room-id\">Get Room ID<\/a><\/li><li><a href=\".\/room-information\/#get-room-meta\">Get Room Meta Data<\/a><\/li><li><a href=\".\/room-information\/#get-mode\">Get Room Mode<\/a><\/li><li><a href=\".\/room-information\/#get-connected-user-id\">Get Client ID of the connected User<\/a><\/li><li><a href=\".\/room-information\/#get-connected-user-name\">Get Name of the connected User<\/a><\/li><li><a href=\".\/room-information\/#get-connected-user-role\">Get Role of the connected User<\/a><\/li><li><a href=\".\/room-information\/#whoami\">Get Information of the connected User<\/a><\/li><li><a href=\".\/room-information\/#get-connected-user-list\">Get list of connected Users<\/a><\/li><li><a href=\".\/room-information\/#get-local-stream-id\">Get Local Stream ID<\/a><\/li><li><a href=\".\/room-information\/#get-stream-by-stream-id\">Get Stream by Stream ID<\/a><\/li><li><a href=\".\/room-information\/#get-remote-streams\">Get list of Remote Streams<\/a><\/li><li><a href=\".\/room-information\/#is-publishing\">Get Publish Status of Local Stream<\/a><\/li><\/ul><\/li><li><strong>In-Session Communication<\/strong><ul><li><a href=\".\/chat\/\">Private, Public &amp; Group Messaging<\/a><\/li><\/ul><ul><li><a href=\".\/custom-signalling\/\">Custom Signalling<\/a><\/li><li><a href=\".\/file-share\/\">File Sharing<\/a><ul><li><a href=\".\/file-share\/#upload-file\">Upload file to share<\/a><\/li><li><a href=\".\/file-share\/#download-file\">Download file<\/a><\/li><li><a href=\".\/file-share\/#cancel-upload\">Cancel file upload<\/a><\/li><li><a href=\".\/file-share\/#cancel-file-download\">Cancel file download<\/a><\/li><\/ul><\/li><li><a href=\".\/screen-share\/\">Share Screen<\/a><\/li><li><a href=\".\/canvas-streaming\/\">Use Canvas Streaming<\/a><ul><li><a href=\".\/canvas-streaming\/#start-canvas-streaming\">Start Canvas Streaming<\/a><\/li><li><a href=\".\/canvas-streaming\/#stop-canvas-streaming\">Stop Canvas Streaming<\/a><\/li><li><a href=\".\/canvas-streaming\/#play-canvas-streaming\">Receive &amp; Play Canvas Stream<\/a><\/li><li><a href=\".\/canvas-streaming\/#force-stop-share\">Force Stop Canvas Streaming<\/a><\/li><\/ul><\/li><li><a href=\".\/annotation\/\">Annotation<\/a><\/li><li><a href=\".\/live-transcription\/\">Live Transcription &#8211; Speech to Text<\/a><\/li><\/ul><\/li><li><strong>Session Management<\/strong><ul><li><a href=\".\/recording\/\">Record Session<\/a><\/li><li><a href=\".\/hard-muting\/#hard-mute-unmute-room\">Hard Mute \/ Unmute Room<\/a><\/li><li><a href=\".\/hard-muting\/#hard-mute-unmute-participants\">Hard Mute \/ Unmute Participants<\/a><\/li><li><a href=\".\/room-entry-restriction\/#lock-unlock-room\">Lock \/ Unlock Room<\/a><\/li><li><a href=\".\/disconnect-user\/\">Disconnect User<\/a><\/li><li><a href=\"\/developer\/video-api\/client-api\/android%20toolkit\/destroy-session\/\">Extend &amp; Destroy Session<\/a><\/li><li><a href=\".\/room-entry-restriction\/#allow-deny-room-entry\">Moderate Participants\u2019 entry to Session<\/a><\/li><li><a href=\".\/participant-role-switch\/\">Change Participant&#8217;s Role<\/a><\/li><\/ul><ul><li><a href=\".\/pin-user\/\">Pin User Stream(s)<\/a><\/li><li><a href=\".\/spotlight-user\/\">Spotlight<\/a><\/li><li><a href=\"\/developer\/video-api\/client-api\/android-toolkit\/room-mode-switch\/\">Switch Room Mode<\/a><\/li><\/ul><\/li><li><a href=\".\/break-out-room\/\"><strong>Break-Out Room<\/strong><\/a><ul><li><a href=\".\/break-out-room\/#create-breakout-room\">Create Break-Out Room<\/a><\/li><li><a href=\".\/break-out-room\/#invite-breakout-room\">Invite Users to join a Break-Out Room<\/a><\/li><li><a href=\".\/break-out-room\/#create-breakout-room-invite\">Create Break-Out Room &amp; Auto-Invite Users to join<\/a><\/li><li><a href=\".\/break-out-room\/#join-breakout-room\">Join Break-Out Room<\/a><\/li><li><a href=\".\/break-out-room\/#reject-break-out-room\">Reject Break-Out Room Invitation<\/a><\/li><li><a href=\".\/break-out-room\/#pause-resume-parent-room\">Pause \/ Resume Parent Room<\/a><\/li><li><a href=\".\/break-out-room\/#mute-unmute-parent-room\">Mute \/ Unmute Parent Room<\/a><\/li><li><a href=\".\/break-out-room\/#disconnect-breakout-room\">Disconnect from Break-Out Room<\/a><\/li><li><a rel=\"noreferrer noopener\" href=\".\/break-out-room\/#clearall-breakout-room\" target=\"_blank\">Cancel All Break-Out Rooms<\/a><\/li><\/ul><ul><li><a rel=\"noreferrer noopener\" href=\".\/break-out-room\/#destroyall-breakout-rooms\" target=\"_blank\">Handle All Destroyed Break-Out Rooms<\/a><\/li><\/ul><\/li><li><strong><a href=\".\/join-aside-room\/\">Aside Room<\/a><\/strong><\/li><li><strong><a href=\"\/developer\/video-api\/client-api\/android-toolkit\/floor-access-control\/\">Floor Access Control in Lecture Mode<\/a><\/strong><ul><li><a href=\".\/floor-access-control\/#request-floor-access\">Request Floor Access<\/a><\/li><li><a href=\".\/floor-access-control\/#cancel-floor-access\">Cancel Requested Floor Access<\/a><\/li><li><a href=\".\/floor-access-control\/#deny-floor-access\">Deny Floor Access<\/a><\/li><li><a href=\".\/floor-access-control\/#grant-floor-access\">Grant Floor Access<\/a><\/li><li><a href=\".\/floor-access-control\/#finish-floor-access\">Finish Floor Access<\/a><\/li><li><a href=\".\/floor-access-control\/#release-floor-access\">Release Floor Access<\/a><\/li><li><a href=\".\/floor-access-control\/#invite-floor\">Invite Participant to Floor<\/a><\/li><\/ul><\/li><li><strong>Live Stats<\/strong><ul><li><a href=\".\/live-media-statistics\/\">Enable Streaming Statistics in the Room<\/a><\/li><li><a href=\".\/talker-noise-notification\/\">Get Talker Notification<\/a><\/li><\/ul><\/li><li><strong>Utilities<\/strong><ul><li><a href=\".\/adjust-layout\/\">Adjust Layout<\/a><\/li><li><a href=\".\/bitrate-status-of-client\/\">Get Bitrate Status of Client<\/a><\/li><\/ul><ul><li><a href=\".\/audio-only-mode\/\">Change to Audio Only Call<\/a><\/li><li><a href=\"\/developer\/video-api\/client-api\/android-toolkit\/pre-call-test\/\">Pre-Call Test<\/a><\/li><li><a href=\".\/update-stream-configuration\/\">Update Stream Configuration<\/a><\/li><li><a href=\".\/handle-audio-device-updates\/\">Handle Audio Device Updates<\/a><\/li><li><a href=\"\/developer\/video-api\/client-api\/android-toolkit\/handle-application-switch\/\">Handle Application Switch from Foreground to Background<\/a><\/li><\/ul><ul><li><a href=\".\/detect-local-audio\/\">Detect Local Audio &amp; Noise Energy<\/a><\/li><li><a href=\".\/enable-proximity-sensor\/\">Enable Proximity Sensor<\/a><\/li><li><a href=\".\/take-image-snapshot\/\">Take Image Snapshot<\/a><\/li><li><a href=\".\/share-log\/\">Share Log for audit<\/a><\/li><\/ul><\/li><li><strong><strong>SDK Method Index<\/strong>\u00a0(By Class)<\/strong><ul><li><a href=\".\/enxrtc\/\">EnxRtc &#8211; Base Class<\/a><\/li><\/ul><ul><li><a href=\".\/enxroom\/\">EnxRoom &#8211; Room Handler<\/a><\/li><li><a href=\".\/enxstream\/\">EnxStream &#8211; Stream Handler<\/a><\/li><\/ul><\/li><\/ul>\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\"><\/div>\n\n\n\n<div class=\"wp-block-column\"><\/div>\n\n\n\n<div class=\"wp-block-column\">\n<p class=\"has-text-align-right\"><a href=\".\/how-to-use\/\">How to use Android SDK<\/a> \u2192<\/p>\n<\/div>\n<\/div>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>The Android SDK is used to integrate the RTC sessions with your Native Android Applications. The SDK consists of APIs required to communicate with video Signaling Server and Media Server and to listen to event-based notifications during a session. Download Android SDK v2.3.24 Released: January 27, 2025 Download WebRTC Library Released: October 1, 2024 Table of Contents General How to use Android SDK? Media Device Get list of Audio Devices&hellip; <\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3718,"menu_order":2,"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 Android SDK is used to integrate the RTC sessions with your Native Android Applications. The SDK consists of APIs required to communicate with video Signaling Server and Media Server and to listen to event-based notifications during a session. Download Android SDK v2.3.24 Released: January 27, 2025 Download WebRTC Library Released: October 1, 2024 Table&hellip;","_links":{"self":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3740"}],"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=3740"}],"version-history":[{"count":0,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3740\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3718"}],"wp:attachment":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/media?parent=3740"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}