| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_111) on Wed Jan 25 23:58:33 NOVT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ScopeApplicationAdapter (Openmeetings Core 3.1.5 API)</title> |
| <meta name="date" content="2017-01-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ScopeApplicationAdapter (Openmeetings Core 3.1.5 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":42,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":42,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":42,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ScopeApplicationAdapter.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.MessageSender.html" title="class in org.apache.openmeetings.core.remote.red5"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html" target="_top">Frames</a></li> |
| <li><a href="ScopeApplicationAdapter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.red5.server.adapter.MultiThreadedApplicationAdapter">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openmeetings.core.remote.red5</div> |
| <h2 title="Class ScopeApplicationAdapter" class="title">Class ScopeApplicationAdapter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.red5.server.adapter.AbstractScopeAdapter</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.red5.server.adapter.StatefulScopeWrappingAdapter</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.red5.server.adapter.MultiThreadedApplicationAdapter</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openmeetings.core.remote.red5.ScopeApplicationAdapter</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.red5.server.api.event.IEventHandler, org.red5.server.api.IAttributeStore, org.red5.server.api.scheduling.ISchedulingService, org.red5.server.api.scope.IScopeAware, org.red5.server.api.scope.IScopeHandler, org.red5.server.api.scope.IScopeService, org.red5.server.api.service.IBroadcastStreamService, org.red5.server.api.service.IOnDemandStreamService, org.red5.server.api.service.IPendingServiceCallback, org.red5.server.api.service.IStreamSecurityService, org.red5.server.api.service.ISubscriberStreamService, org.red5.server.api.so.ISharedObjectSecurityService, org.red5.server.api.so.ISharedObjectService, org.red5.server.api.stream.IStreamAwareScopeHandler, org.red5.server.jmx.mxbeans.ApplicationMXBean, org.red5.server.jmx.mxbeans.AttributeStoreMXBean</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ScopeApplicationAdapter</span> |
| extends org.red5.server.adapter.MultiThreadedApplicationAdapter |
| implements org.red5.server.api.service.IPendingServiceCallback</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.MessageSender.html" title="class in org.apache.openmeetings.core.remote.red5">ScopeApplicationAdapter.MessageSender</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.red5.server.adapter.MultiThreadedApplicationAdapter"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.red5.server.adapter.MultiThreadedApplicationAdapter</h3> |
| <code>schedulingService</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.red5.server.adapter.StatefulScopeWrappingAdapter"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.red5.server.adapter.StatefulScopeWrappingAdapter</h3> |
| <code>plugins, scope</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.red5.server.api.so.ISharedObjectService"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.red5.server.api.so.ISharedObjectService</h3> |
| <code>BEAN_NAME</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.red5.server.api.service.IBroadcastStreamService"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.red5.server.api.service.IBroadcastStreamService</h3> |
| <code>BROADCAST_STREAM_SERVICE</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.red5.server.api.service.IOnDemandStreamService"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.red5.server.api.service.IOnDemandStreamService</h3> |
| <code>BEAN_NAME</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.red5.server.api.service.ISubscriberStreamService"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.red5.server.api.service.ISubscriberStreamService</h3> |
| <code>BEAN_NAME</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.red5.server.api.scheduling.ISchedulingService"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.red5.server.api.scheduling.ISchedulingService</h3> |
| <code>BEAN_NAME</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.red5.server.api.service.IStreamSecurityService"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.red5.server.api.service.IStreamSecurityService</h3> |
| <code>BEAN_NAME</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.red5.server.api.so.ISharedObjectSecurityService"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.red5.server.api.so.ISharedObjectSecurityService</h3> |
| <code>BEAN_NAME</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#ScopeApplicationAdapter--">ScopeApplicationAdapter</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#addModerator-java.lang.String-">addModerator</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</code> |
| <div class="block">Adds a Moderator by its publicSID</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#applyForModeration-java.lang.String-">applyForModeration</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</code> |
| <div class="block">Invoked by a User whenever he want to become moderator this is needed, |
| cause if the room has no moderator yet there is no-one he can ask to get |
| the moderation, in case its a Non-Moderated Room he should then get the |
| Moderation without any confirmation needed</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#appStart-org.red5.server.api.scope.IScope-">appStart</a></span>(org.red5.server.api.scope.IScope scope)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#checkRoomValues-java.lang.Long-">checkRoomValues</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.openmeetings.db.entity.room.Client></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#checkScreenSharing--">checkScreenSharing</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getActiveRoomIds--">getActiveRoomIds</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getBroadCastId--">getBroadCastId</a></span>()</code> |
| <div class="block">there will be set an attribute called "broadCastCounter" this is the name |
| this user will publish his stream</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>org.red5.server.api.scope.IBroadcastScope</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getBroadcastScope-org.red5.server.api.scope.IScope-java.lang.String-">getBroadcastScope</a></span>(org.red5.server.api.scope.IScope scope, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.openmeetings.db.entity.room.Client></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getClientListScope--">getClientListScope</a></span>()</code> |
| <div class="block">Get all ClientList Objects of that room and domain Used in |
| lz.applyForModeration.lzx</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getCryptKey--">getCryptKey</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.openmeetings.db.entity.room.Client></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getCurrentModeratorList--">getCurrentModeratorList</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getInterviewRecordingStatus--">getInterviewRecordingStatus</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">this method should be reworked to use a single SQL query in |
| the cache to get any client in the current room that is |
| recording instead of iterating through connections!</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getMicMutedByPublicSID-java.lang.String-">getMicMutedByPublicSID</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getPublicSID--">getPublicSID</a></span>()</code> |
| <div class="block">this function is invoked directly after initial connecting</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>org.red5.server.api.scope.IScope</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getRoomScope-java.lang.String-">getRoomScope</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> room)</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getSipNumber-java.lang.Long-">getSipNumber</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#giveExclusiveAudio-java.lang.String-">giveExclusiveAudio</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#joinToConfCall-java.lang.String-">joinToConfCall</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> number)</code> |
| <div class="block">Perform call to specified phone number and join to conference</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#listRoomBroadcast--">listRoomBroadcast</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#loadTestSyncMessage-java.lang.String-java.lang.Object-boolean-">loadTestSyncMessage</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> remoteMethodName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| boolean sendSelf)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#logicalRoomLeave--">logicalRoomLeave</a></span>()</code> |
| <div class="block">this means a user has left a room but only logically, he didn't leave the |
| app he just left the room |
| |
| FIXME: Is this really needed anymore if you re-connect to another scope? |
| |
| Exit Room by Application</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#overwritePublicSID-java.lang.String-">overwritePublicSID</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newPublicSID)</code> |
| <div class="block">this function is invoked after a reconnect</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#removeModerator-java.lang.String-">removeModerator</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#resultReceived-org.red5.server.api.service.IPendingServiceCall-">resultReceived</a></span>(org.red5.server.api.service.IPendingServiceCall arg0)</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#roomConnect-org.red5.server.api.IConnection-java.lang.Object:A-">roomConnect</a></span>(org.red5.server.api.IConnection conn, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] params)</code> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#roomLeave-org.red5.server.api.IClient-org.red5.server.api.scope.IScope-">roomLeave</a></span>(org.red5.server.api.IClient client, |
| org.red5.server.api.scope.IScope room)</code> |
| <div class="block">Logic must be before roomDisconnect cause otherwise you cannot throw a |
| message to each one</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#roomLeaveByScope-org.apache.openmeetings.db.entity.room.Client-org.red5.server.api.scope.IScope-boolean-">roomLeaveByScope</a></span>(org.apache.openmeetings.db.entity.room.Client client, |
| org.red5.server.api.scope.IScope scope, |
| boolean removeUserFromSessionList)</code> |
| <div class="block">Removes the Client from the List, stops recording, adds the Room-Leave |
| event to running recordings, clear Polls and removes Client from any list |
| |
| This function is kind of private/protected as the client won't be able |
| to call it with proper values.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#screenSharerAction-java.util.Map-">screenSharerAction</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> map)</code> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendBrowserMessageToMembers-java.lang.Object-">sendBrowserMessageToMembers</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage)</code> |
| <div class="block">send status for shared browsing to all members except self</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendMessage-java.lang.Object-">sendMessage</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage)</code> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendMessageAll-java.lang.Object-">sendMessageAll</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage)</code> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendMessageById-java.lang.Object-java.lang.String-org.red5.server.api.scope.IScope-">sendMessageById</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId, |
| org.red5.server.api.scope.IScope scope)</code> |
| <div class="block">Function is used to send the kick Trigger at the moment, |
| it sends a general message to a specific clientId</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.openmeetings.db.entity.room.Client></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendMessageByRoomAndDomain-java.lang.Long-java.lang.Object-">sendMessageByRoomAndDomain</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> message)</code> |
| <div class="block">used by the Screen-Sharing Servlet to trigger events</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendMessageToCurrentScope-java.lang.String-java.lang.Object-boolean-">sendMessageToCurrentScope</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> remoteMethodName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| boolean sendSelf)</code> |
| <div class="block">General sync mechanism for all messages that are send from within the |
| scope of the current client, but: |
| |
| optionally do not send to self (see param: sendSelf) |
| do not send to clients that are screen sharing clients |
| do not send to clients that are audio/video clients (or potentially ones) |
| do not send to connections where no RoomClient is registered |
| </div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendMessageToCurrentScope-java.lang.String-java.lang.Object-boolean-boolean-">sendMessageToCurrentScope</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> remoteMethodName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| boolean sendSelf, |
| boolean sendScreen)</code> |
| <div class="block">General sync mechanism for all messages that are send from within the |
| scope of the current client, but: |
| |
| optionally do not send to self (see param: sendSelf) |
| send to clients that are screen sharing clients based on parameter |
| do not send to clients that are audio/video clients (or potentially ones) |
| do not send to connections where no RoomClient is registered |
| </div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendMessageToMembers-java.lang.Object-">sendMessageToMembers</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage)</code> |
| <div class="block">wrapper method</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendMessageWithClient-java.lang.Object-">sendMessageWithClient</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage)</code> |
| <div class="block">wrapper method</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendMessageWithClientById-java.lang.Object-java.lang.String-">sendMessageWithClientById</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId)</code> |
| <div class="block">Sends a message to a user in the same room by its clientId</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendMessageWithClientByPublicSID-java.lang.Object-java.lang.String-">sendMessageWithClientByPublicSID</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> message, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</code> </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendMessageWithClientWithSyncObject-java.lang.Object-boolean-">sendMessageWithClientWithSyncObject</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| boolean sync)</code> |
| <div class="block">wrapper method</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendRemoteCursorEvent-java.lang.String-java.util.Map-">sendRemoteCursorEvent</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamid, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> messageObj)</code> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendVarsByWhiteboardId-java.util.ArrayList-java.lang.Long-">sendVarsByWhiteboardId</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> whiteboardObjParam, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> whiteboardId)</code> |
| <div class="block">This Function is triggered from the Whiteboard</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#sendVarsModeratorGeneral-java.lang.Object-">sendVarsModeratorGeneral</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> vars)</code> </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#setBroadCastingFlag-java.lang.String-boolean-boolean-java.lang.Integer-">setBroadCastingFlag</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID, |
| boolean value, |
| boolean canVideo, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interviewPodId)</code> </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#setConnectionAsSharingClient-java.util.Map-">setConnectionAsSharingClient</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> map)</code> </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#setNewCursorPosition-java.lang.Object-">setNewCursorPosition</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> item)</code> </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>org.apache.openmeetings.db.dto.room.RoomStatus</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#setRoomValues-java.lang.Long-boolean-boolean-java.lang.String-">setRoomValues</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId, |
| boolean becomeModerator, |
| boolean isSuperModerator, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colorObj)</code> |
| <div class="block">This function is called once a User enters a Room |
| |
| It contains several different mechanism depending on what roomtype and |
| what options are available for the room to find out if the current user |
| will be a moderator of that room or not<br/> |
| <br/> |
| Some rules:<br/> |
| |
| If it is a room that was created through the calendar, the user that |
| organized the room will be moderator, the param Boolean becomeModerator |
| will be ignored then |
| In regular rooms you can use the param Boolean becomeModerator to set |
| any user to become a moderator of the room |
| |
| <br/> |
| If a new moderator is detected a Push Call to all current users of the |
| room is invoked "setNewModeratorByList" to notify them of the new |
| moderator<br/> |
| <br/> |
| At the end of the mechanism a push call with the new client-object |
| and all the informations about the new user is send to every user of the |
| current conference room<br/> |
| <br/></div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#setSipTransport-java.lang.Long-java.lang.String-java.lang.String-">setSipTransport</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> broadCastId)</code> </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>org.apache.openmeetings.db.entity.room.Client</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#setUserAVSettings-java.lang.String-java.lang.Object-java.lang.Integer-java.lang.Integer-long-java.lang.String-java.lang.Integer-">setUserAVSettings</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> avsettings, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> vWidth, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> vHeight, |
| long roomId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interviewPodId)</code> |
| <div class="block">this must be set _after_ the Video/Audio-Settings have been chosen (see |
| editrecordstream.lzx) but _before_ anything else happens, it cannot be |
| applied _after_ the stream has started! avsettings can be: av - video and |
| audio a - audio only v - video only n - no a/v only static image |
| furthermore</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>org.apache.openmeetings.db.entity.room.Client</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#setUsernameAndSession-java.lang.String-java.lang.Long-java.lang.String-java.lang.String-java.lang.String-">setUsernameAndSession</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SID, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> userId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> firstname, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lastname)</code> |
| <div class="block">this is set initial directly after login/loading language</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>org.apache.openmeetings.db.entity.room.Client</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#setUsernameReconnect-java.lang.String-java.lang.Long-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">setUsernameReconnect</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SID, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> userId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> firstname, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lastname, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> picture_uri)</code> |
| <div class="block">This method is invoked when the user has disconnected and reconnects to |
| the Gateway with the new scope</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#startInterviewRecording--">startInterviewRecording</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">@see <a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getInterviewRecordingStatus--"><code>getInterviewRecordingStatus()</code></a></span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#stopInterviewRecording--">stopInterviewRecording</a></span>()</code> |
| <div class="block">Stop the recording of the streams and send event to connected users of scope</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#streamBroadcastClose-org.red5.server.api.stream.IBroadcastStream-">streamBroadcastClose</a></span>(org.red5.server.api.stream.IBroadcastStream stream)</code> |
| <div class="block">This method handles the Event after a stream has been removed all |
| connected Clients in the same room will get a notification</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#streamPublishStart-org.red5.server.api.stream.IBroadcastStream-">streamPublishStart</a></span>(org.red5.server.api.stream.IBroadcastStream stream)</code> |
| <div class="block">This method handles the Event after a stream has been added all connected |
| Clients in the same room will get a notification</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#switchMicMuted-java.lang.String-boolean-">switchMicMuted</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID, |
| boolean mute)</code> </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#updateSipTransport--">updateSipTransport</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.red5.server.adapter.MultiThreadedApplicationAdapter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.red5.server.adapter.MultiThreadedApplicationAdapter</h3> |
| <code>addListener, addScheduledJob, addScheduledJobAfterDelay, addScheduledOnceJob, addScheduledOnceJob, appConnect, appDisconnect, appJoin, appLeave, appStop, clearSharedObjects, connect, connect, createSharedObject, disconnect, FCPublish, FCSubscribe, FCUnpublish, FCUnpublish, getBroadcastStream, getBroadcastStreamNames, getClientTTL, getGhostConnsCleanupPeriod, getListeners, getOnDemandStream, getScheduledJobNames, getSharedObject, getSharedObject, getSharedObjectNames, getSharedObjectSecurity, getStreamLength, getStreamPlaybackSecurity, getStreamPublishSecurity, getSubscriberStream, handleEvent, hasBroadcastStream, hasOnDemandStream, hasSharedObject, join, leave, measureBandwidth, measureBandwidth, pauseScheduledJob, registerSharedObjectSecurity, registerStreamPlaybackSecurity, registerStreamPublishSecurity, rejectClient, rejectClient, removeListener, removeScheduledJob, resumeScheduledJob, roomDisconnect, roomJoin, roomStart, roomStop, setClientTTL, setGhostConnsCleanupPeriod, start, startTransmit, stop, stopTransmit, stopTransmit, streamBroadcastStart, streamPlayItemPause, streamPlayItemPlay, streamPlayItemResume, streamPlayItemSeek, streamPlayItemStop, streamRecordStart, streamRecordStop, streamSubscriberClose, streamSubscriberStart, unregisterSharedObjectSecurity, unregisterStreamPlaybackSecurity, unregisterStreamPublishSecurity</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.red5.server.adapter.StatefulScopeWrappingAdapter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.red5.server.adapter.StatefulScopeWrappingAdapter</h3> |
| <code>createChildScope, getAttribute, getAttribute, getAttributeNames, getAttributes, getChildScope, getChildScopeNames, getClients, getConnections, getContext, getDepth, getName, getParent, getPath, getPlugins, getResource, getResources, getScope, hasAttribute, hasChildScope, hasParent, lookupConnections, removeAttribute, removeAttributes, setAttribute, setAttributes, setAttributes, setPlugins, setScope, size</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.red5.server.adapter.AbstractScopeAdapter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.red5.server.adapter.AbstractScopeAdapter</h3> |
| <code>addChildScope, checkBandwidth, checkBandwidthUp, removeChildScope, serviceCall, setCanCallService, setCanConnect, setCanStart, setJoin</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.red5.server.api.scope.IScopeHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.red5.server.api.scope.IScopeHandler</h3> |
| <code>addChildScope, removeChildScope, serviceCall</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ScopeApplicationAdapter--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ScopeApplicationAdapter</h4> |
| <pre>public ScopeApplicationAdapter()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="resultReceived-org.red5.server.api.service.IPendingServiceCall-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resultReceived</h4> |
| <pre>public void resultReceived(org.red5.server.api.service.IPendingServiceCall arg0)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>resultReceived</code> in interface <code>org.red5.server.api.service.IPendingServiceCallback</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="appStart-org.red5.server.api.scope.IScope-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appStart</h4> |
| <pre>public boolean appStart(org.red5.server.api.scope.IScope scope)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>appStart</code> in interface <code>org.red5.server.jmx.mxbeans.ApplicationMXBean</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>appStart</code> in class <code>org.red5.server.adapter.MultiThreadedApplicationAdapter</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="roomConnect-org.red5.server.api.IConnection-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>roomConnect</h4> |
| <pre>public boolean roomConnect(org.red5.server.api.IConnection conn, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] params)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>roomConnect</code> in interface <code>org.red5.server.jmx.mxbeans.ApplicationMXBean</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>roomConnect</code> in class <code>org.red5.server.adapter.MultiThreadedApplicationAdapter</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="screenSharerAction-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>screenSharerAction</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> screenSharerAction(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> map)</pre> |
| </li> |
| </ul> |
| <a name="checkScreenSharing--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkScreenSharing</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.openmeetings.db.entity.room.Client> checkScreenSharing()</pre> |
| </li> |
| </ul> |
| <a name="setConnectionAsSharingClient-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionAsSharingClient</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> setConnectionAsSharingClient(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> map)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>map</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>returns key,value Map with multiple return values or null in case of exception</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listRoomBroadcast--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listRoomBroadcast</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> listRoomBroadcast()</pre> |
| </li> |
| </ul> |
| <a name="getPublicSID--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPublicSID</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPublicSID()</pre> |
| <div class="block">this function is invoked directly after initial connecting</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>publicSID of current client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="overwritePublicSID-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>overwritePublicSID</h4> |
| <pre>public boolean overwritePublicSID(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newPublicSID)</pre> |
| <div class="block">this function is invoked after a reconnect</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newPublicSID</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="roomLeave-org.red5.server.api.IClient-org.red5.server.api.scope.IScope-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>roomLeave</h4> |
| <pre>public void roomLeave(org.red5.server.api.IClient client, |
| org.red5.server.api.scope.IScope room)</pre> |
| <div class="block">Logic must be before roomDisconnect cause otherwise you cannot throw a |
| message to each one</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>roomLeave</code> in interface <code>org.red5.server.jmx.mxbeans.ApplicationMXBean</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>roomLeave</code> in class <code>org.red5.server.adapter.MultiThreadedApplicationAdapter</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="logicalRoomLeave--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logicalRoomLeave</h4> |
| <pre>public void logicalRoomLeave()</pre> |
| <div class="block">this means a user has left a room but only logically, he didn't leave the |
| app he just left the room |
| |
| FIXME: Is this really needed anymore if you re-connect to another scope? |
| |
| Exit Room by Application</div> |
| </li> |
| </ul> |
| <a name="roomLeaveByScope-org.apache.openmeetings.db.entity.room.Client-org.red5.server.api.scope.IScope-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>roomLeaveByScope</h4> |
| <pre>public void roomLeaveByScope(org.apache.openmeetings.db.entity.room.Client client, |
| org.red5.server.api.scope.IScope scope, |
| boolean removeUserFromSessionList)</pre> |
| <div class="block">Removes the Client from the List, stops recording, adds the Room-Leave |
| event to running recordings, clear Polls and removes Client from any list |
| |
| This function is kind of private/protected as the client won't be able |
| to call it with proper values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>client</code> - </dd> |
| <dd><code>scope</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="streamPublishStart-org.red5.server.api.stream.IBroadcastStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>streamPublishStart</h4> |
| <pre>public void streamPublishStart(org.red5.server.api.stream.IBroadcastStream stream)</pre> |
| <div class="block">This method handles the Event after a stream has been added all connected |
| Clients in the same room will get a notification</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>streamPublishStart</code> in interface <code>org.red5.server.api.stream.IStreamAwareScopeHandler</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>streamPublishStart</code> in class <code>org.red5.server.adapter.MultiThreadedApplicationAdapter</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBroadcastScope-org.red5.server.api.scope.IScope-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBroadcastScope</h4> |
| <pre>public org.red5.server.api.scope.IBroadcastScope getBroadcastScope(org.red5.server.api.scope.IScope scope, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| </li> |
| </ul> |
| <a name="streamBroadcastClose-org.red5.server.api.stream.IBroadcastStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>streamBroadcastClose</h4> |
| <pre>public void streamBroadcastClose(org.red5.server.api.stream.IBroadcastStream stream)</pre> |
| <div class="block">This method handles the Event after a stream has been removed all |
| connected Clients in the same room will get a notification</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>streamBroadcastClose</code> in interface <code>org.red5.server.api.stream.IStreamAwareScopeHandler</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>streamBroadcastClose</code> in class <code>org.red5.server.adapter.MultiThreadedApplicationAdapter</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addModerator-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addModerator</h4> |
| <pre>public long addModerator(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</pre> |
| <div class="block">Adds a Moderator by its publicSID</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>publicSID</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>-1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNewCursorPosition-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNewCursorPosition</h4> |
| <pre>public void setNewCursorPosition(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> item)</pre> |
| </li> |
| </ul> |
| <a name="removeModerator-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeModerator</h4> |
| <pre>public long removeModerator(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</pre> |
| </li> |
| </ul> |
| <a name="setBroadCastingFlag-java.lang.String-boolean-boolean-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBroadCastingFlag</h4> |
| <pre>public long setBroadCastingFlag(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID, |
| boolean value, |
| boolean canVideo, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interviewPodId)</pre> |
| </li> |
| </ul> |
| <a name="giveExclusiveAudio-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>giveExclusiveAudio</h4> |
| <pre>public long giveExclusiveAudio(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</pre> |
| </li> |
| </ul> |
| <a name="switchMicMuted-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>switchMicMuted</h4> |
| <pre>public long switchMicMuted(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID, |
| boolean mute)</pre> |
| </li> |
| </ul> |
| <a name="getMicMutedByPublicSID-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMicMutedByPublicSID</h4> |
| <pre>public boolean getMicMutedByPublicSID(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</pre> |
| </li> |
| </ul> |
| <a name="applyForModeration-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyForModeration</h4> |
| <pre>public long applyForModeration(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</pre> |
| <div class="block">Invoked by a User whenever he want to become moderator this is needed, |
| cause if the room has no moderator yet there is no-one he can ask to get |
| the moderation, in case its a Non-Moderated Room he should then get the |
| Moderation without any confirmation needed</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Long 1 => means get Moderation, 2 => ask Moderator for |
| Moderation, 3 => wait for Moderator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBroadCastId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBroadCastId</h4> |
| <pre>public long getBroadCastId()</pre> |
| <div class="block">there will be set an attribute called "broadCastCounter" this is the name |
| this user will publish his stream</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>long broadCastId</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUserAVSettings-java.lang.String-java.lang.Object-java.lang.Integer-java.lang.Integer-long-java.lang.String-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUserAVSettings</h4> |
| <pre>public org.apache.openmeetings.db.entity.room.Client setUserAVSettings(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> avsettings, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> vWidth, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> vHeight, |
| long roomId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interviewPodId)</pre> |
| <div class="block">this must be set _after_ the Video/Audio-Settings have been chosen (see |
| editrecordstream.lzx) but _before_ anything else happens, it cannot be |
| applied _after_ the stream has started! avsettings can be: av - video and |
| audio a - audio only v - video only n - no a/v only static image |
| furthermore</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>avsettings</code> - </dd> |
| <dd><code>newMessage</code> - </dd> |
| <dd><code>vWidth</code> - </dd> |
| <dd><code>vHeight</code> - </dd> |
| <dd><code>roomId</code> - </dd> |
| <dd><code>publicSID</code> - </dd> |
| <dd><code>interviewPodId</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>RoomClient being updated in case of no errors, null otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkRoomValues-java.lang.Long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkRoomValues</h4> |
| <pre>public boolean checkRoomValues(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId)</pre> |
| </li> |
| </ul> |
| <a name="setRoomValues-java.lang.Long-boolean-boolean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRoomValues</h4> |
| <pre>public org.apache.openmeetings.db.dto.room.RoomStatus setRoomValues(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId, |
| boolean becomeModerator, |
| boolean isSuperModerator, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colorObj)</pre> |
| <div class="block">This function is called once a User enters a Room |
| |
| It contains several different mechanism depending on what roomtype and |
| what options are available for the room to find out if the current user |
| will be a moderator of that room or not<br/> |
| <br/> |
| Some rules:<br/> |
| <ul> |
| <li>If it is a room that was created through the calendar, the user that |
| organized the room will be moderator, the param Boolean becomeModerator |
| will be ignored then</li> |
| <li>In regular rooms you can use the param Boolean becomeModerator to set |
| any user to become a moderator of the room</li> |
| </ul> |
| <br/> |
| If a new moderator is detected a Push Call to all current users of the |
| room is invoked "setNewModeratorByList" to notify them of the new |
| moderator<br/> |
| <br/> |
| At the end of the mechanism a push call with the new client-object |
| and all the informations about the new user is send to every user of the |
| current conference room<br/> |
| <br/></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>roomId</code> - - id of the room</dd> |
| <dd><code>becomeModerator</code> - - is user will become moderator</dd> |
| <dd><code>isSuperModerator</code> - - is user super moderator</dd> |
| <dd><code>groupId</code> - - group id of the user</dd> |
| <dd><code>colorObj</code> - - some color</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>RoomStatus object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUsernameReconnect-java.lang.String-java.lang.Long-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsernameReconnect</h4> |
| <pre>public org.apache.openmeetings.db.entity.room.Client setUsernameReconnect(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SID, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> userId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> firstname, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lastname, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> picture_uri)</pre> |
| <div class="block">This method is invoked when the user has disconnected and reconnects to |
| the Gateway with the new scope</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>SID</code> - </dd> |
| <dd><code>userId</code> - </dd> |
| <dd><code>username</code> - </dd> |
| <dd><code>firstname</code> - </dd> |
| <dd><code>lastname</code> - </dd> |
| <dd><code>picture_uri</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>client being updated in case of success, null otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUsernameAndSession-java.lang.String-java.lang.Long-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsernameAndSession</h4> |
| <pre>public org.apache.openmeetings.db.entity.room.Client setUsernameAndSession(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SID, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> userId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> firstname, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lastname)</pre> |
| <div class="block">this is set initial directly after login/loading language</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>SID</code> - - id of the session</dd> |
| <dd><code>userId</code> - - id of the user being set</dd> |
| <dd><code>username</code> - - username of the user</dd> |
| <dd><code>firstname</code> - - firstname of the user</dd> |
| <dd><code>lastname</code> - - lastname of the user</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>RoomClient in case of everything is OK, null otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendMessageByRoomAndDomain-java.lang.Long-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessageByRoomAndDomain</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.openmeetings.db.entity.room.Client> sendMessageByRoomAndDomain(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> message)</pre> |
| <div class="block">used by the Screen-Sharing Servlet to trigger events</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>roomId</code> - </dd> |
| <dd><code>message</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of room clients</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCurrentModeratorList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentModeratorList</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.openmeetings.db.entity.room.Client> getCurrentModeratorList()</pre> |
| </li> |
| </ul> |
| <a name="sendVarsByWhiteboardId-java.util.ArrayList-java.lang.Long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendVarsByWhiteboardId</h4> |
| <pre>public int sendVarsByWhiteboardId(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> whiteboardObjParam, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> whiteboardId)</pre> |
| <div class="block">This Function is triggered from the Whiteboard</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>whiteboardObjParam</code> - - array of parameters being sended to whiteboard</dd> |
| <dd><code>whiteboardId</code> - - id of whiteboard parameters will be send to</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendVarsModeratorGeneral-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendVarsModeratorGeneral</h4> |
| <pre>public int sendVarsModeratorGeneral(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> vars)</pre> |
| </li> |
| </ul> |
| <a name="sendMessage-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessage</h4> |
| <pre>public int sendMessage(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage)</pre> |
| </li> |
| </ul> |
| <a name="sendMessageAll-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessageAll</h4> |
| <pre>public int sendMessageAll(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage)</pre> |
| </li> |
| </ul> |
| <a name="sendBrowserMessageToMembers-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendBrowserMessageToMembers</h4> |
| <pre>public int sendBrowserMessageToMembers(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage)</pre> |
| <div class="block">send status for shared browsing to all members except self</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newMessage</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendMessageToMembers-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessageToMembers</h4> |
| <pre>public void sendMessageToMembers(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage)</pre> |
| <div class="block">wrapper method</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newMessage</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendMessageToCurrentScope-java.lang.String-java.lang.Object-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessageToCurrentScope</h4> |
| <pre>public void sendMessageToCurrentScope(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> remoteMethodName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| boolean sendSelf)</pre> |
| <div class="block">General sync mechanism for all messages that are send from within the |
| scope of the current client, but: |
| <ul> |
| <li>optionally do not send to self (see param: sendSelf)</li> |
| <li>do not send to clients that are screen sharing clients</li> |
| <li>do not send to clients that are audio/video clients (or potentially ones)</li> |
| <li>do not send to connections where no RoomClient is registered</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remoteMethodName</code> - The method to be called</dd> |
| <dd><code>newMessage</code> - parameters</dd> |
| <dd><code>sendSelf</code> - send to the current client as well</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="loadTestSyncMessage-java.lang.String-java.lang.Object-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadTestSyncMessage</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public boolean loadTestSyncMessage(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> remoteMethodName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| boolean sendSelf)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Only temporary for load test, with return argument for the client to have a result</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remoteMethodName</code> - </dd> |
| <dd><code>newMessage</code> - </dd> |
| <dd><code>sendSelf</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendMessageToCurrentScope-java.lang.String-java.lang.Object-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessageToCurrentScope</h4> |
| <pre>public void sendMessageToCurrentScope(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> remoteMethodName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| boolean sendSelf, |
| boolean sendScreen)</pre> |
| <div class="block">General sync mechanism for all messages that are send from within the |
| scope of the current client, but: |
| <ul> |
| <li>optionally do not send to self (see param: sendSelf)</li> |
| <li>send to clients that are screen sharing clients based on parameter</li> |
| <li>do not send to clients that are audio/video clients (or potentially ones)</li> |
| <li>do not send to connections where no RoomClient is registered</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remoteMethodName</code> - The method to be called</dd> |
| <dd><code>newMessage</code> - parameters</dd> |
| <dd><code>sendSelf</code> - send to the current client as well</dd> |
| <dd><code>sendScreen</code> - send to the current client as well</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendMessageWithClient-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessageWithClient</h4> |
| <pre>public int sendMessageWithClient(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage)</pre> |
| <div class="block">wrapper method</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newMessage</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>1 in case of success, -1 otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendMessageWithClientWithSyncObject-java.lang.Object-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessageWithClientWithSyncObject</h4> |
| <pre>public int sendMessageWithClientWithSyncObject(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| boolean sync)</pre> |
| <div class="block">wrapper method</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newMessage</code> - </dd> |
| <dd><code>sync</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>1 in case of success, -1 otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendMessageById-java.lang.Object-java.lang.String-org.red5.server.api.scope.IScope-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessageById</h4> |
| <pre>public int sendMessageById(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId, |
| org.red5.server.api.scope.IScope scope)</pre> |
| <div class="block">Function is used to send the kick Trigger at the moment, |
| it sends a general message to a specific clientId</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newMessage</code> - </dd> |
| <dd><code>clientId</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>1 in case of success, -1 otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendMessageWithClientById-java.lang.Object-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessageWithClientById</h4> |
| <pre>public int sendMessageWithClientById(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newMessage, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId)</pre> |
| <div class="block">Sends a message to a user in the same room by its clientId</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newMessage</code> - </dd> |
| <dd><code>clientId</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>1 in case of no exceptions, -1 otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendMessageWithClientByPublicSID-java.lang.Object-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessageWithClientByPublicSID</h4> |
| <pre>public void sendMessageWithClientByPublicSID(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> message, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</pre> |
| </li> |
| </ul> |
| <a name="getInterviewRecordingStatus--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInterviewRecordingStatus</h4> |
| <pre>public boolean getInterviewRecordingStatus()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">this method should be reworked to use a single SQL query in |
| the cache to get any client in the current room that is |
| recording instead of iterating through connections!</span></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true in case there is recording session, false otherwise, null if any exception happend</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startInterviewRecording--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startInterviewRecording</h4> |
| <pre>public boolean startInterviewRecording()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">@see <a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html#getInterviewRecordingStatus--"><code>getInterviewRecordingStatus()</code></a></span></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- false if there were existing recording, true if recording was started successfully, null if any exception happens</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendRemoteCursorEvent-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendRemoteCursorEvent</h4> |
| <pre>public boolean sendRemoteCursorEvent(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamid, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> messageObj)</pre> |
| </li> |
| </ul> |
| <a name="stopInterviewRecording--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopInterviewRecording</h4> |
| <pre>public boolean stopInterviewRecording()</pre> |
| <div class="block">Stop the recording of the streams and send event to connected users of scope</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if interview was found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClientListScope--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientListScope</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.openmeetings.db.entity.room.Client> getClientListScope()</pre> |
| <div class="block">Get all ClientList Objects of that room and domain Used in |
| lz.applyForModeration.lzx</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all ClientList Objects of that room</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCryptKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCryptKey</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCryptKey()</pre> |
| </li> |
| </ul> |
| <a name="getRoomScope-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoomScope</h4> |
| <pre>public org.red5.server.api.scope.IScope getRoomScope(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> room)</pre> |
| </li> |
| </ul> |
| <a name="getActiveRoomIds--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getActiveRoomIds</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> getActiveRoomIds()</pre> |
| </li> |
| </ul> |
| <a name="updateSipTransport--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateSipTransport</h4> |
| <pre>public int updateSipTransport()</pre> |
| </li> |
| </ul> |
| <a name="joinToConfCall-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>joinToConfCall</h4> |
| <pre>public void joinToConfCall(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> number)</pre> |
| <div class="block">Perform call to specified phone number and join to conference</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>number</code> - to call</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSipNumber-java.lang.Long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSipNumber</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSipNumber(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId)</pre> |
| </li> |
| </ul> |
| <a name="setSipTransport-java.lang.Long-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setSipTransport</h4> |
| <pre>public void setSipTransport(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> broadCastId)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ScopeApplicationAdapter.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.MessageSender.html" title="class in org.apache.openmeetings.core.remote.red5"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/openmeetings/core/remote/red5/ScopeApplicationAdapter.html" target="_top">Frames</a></li> |
| <li><a href="ScopeApplicationAdapter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.red5.server.adapter.MultiThreadedApplicationAdapter">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012–2017 <a href="http://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
