public class EOS_RTC_Admin_Interface
extends com.sun.jna.PointerType
EOS_Platform_Interface.getRTCAdminInterface()| Constructor and Description |
|---|
EOS_RTC_Admin_Interface() |
EOS_RTC_Admin_Interface(com.sun.jna.Pointer address) |
| Modifier and Type | Method and Description |
|---|---|
EOS_RTCAdmin_UserToken |
copyUserTokenByIndex(EOS_RTCAdmin_CopyUserTokenByIndexOptions options)
Fetches a user token when called inside of the OnQueryJoinRoomTokenComplete callback.
|
EOS_RTCAdmin_UserToken |
copyUserTokenByUserId(EOS_RTCAdmin_CopyUserTokenByUserIdOptions options)
Fetches a user token for a given user ID when called inside of the OnQueryJoinRoomTokenComplete callback.
|
void |
kick(EOS_RTCAdmin_KickOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAdmin_OnKickCompleteCallback completionDelegate)
Starts an asynchronous task that removes a participant from a room and revokes their token.
|
void |
queryJoinRoomToken(EOS_RTCAdmin_QueryJoinRoomTokenOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAdmin_OnQueryJoinRoomTokenCompleteCallback completionDelegate)
Query for a list of user tokens for joining a room.
|
void |
setParticipantHardMute(EOS_RTCAdmin_SetParticipantHardMuteOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAdmin_OnSetParticipantHardMuteCompleteCallback completionDelegate)
Starts an asynchronous task remotely mutes/unmutes a room participant.
|
public EOS_RTC_Admin_Interface(com.sun.jna.Pointer address)
public EOS_RTC_Admin_Interface()
public void queryJoinRoomToken(EOS_RTCAdmin_QueryJoinRoomTokenOptions options, com.sun.jna.Pointer clientData, EOS_RTCAdmin_OnQueryJoinRoomTokenCompleteCallback completionDelegate)
Each query generates a query id (see EOS_RTCAdmin_QueryJoinRoomTokenCompleteCallbackInfo) which should be used to retrieve the tokens from inside the callback.
This query id and query result itself are only valid for the duration of the callback.
options - Structure containing information about the application whose user tokens we're retrieving.clientData - Arbitrary data that is passed back to you in the CompletionDelegatecompletionDelegate - This function is called when the query join room token operation completes.EOS_RTCAdmin_QueryJoinRoomTokenCompleteCallbackInfopublic EOS_RTCAdmin_UserToken copyUserTokenByIndex(EOS_RTCAdmin_CopyUserTokenByIndexOptions options) throws EOSException
options - Structure containing the index being accessed
The order of the tokens doesn't necessarily match the order of the EOS_ProductUserId array specified in the EOS_RTCAdmin_QueryJoinRoomTokenOptions when initiating the query.
EOS_RTCAdmin_UserToken.release() when finishedEOSInvalidParametersException - if you pass a null pointer for the out parameterEOSNotFoundException - if the user token is not foundEOSExceptionEOS_RTCAdmin_UserToken.release()public EOS_RTCAdmin_UserToken copyUserTokenByUserId(EOS_RTCAdmin_CopyUserTokenByUserIdOptions options) throws EOSException
options - Structure containing the user ID being accessedEOS_RTCAdmin_UserToken.release() when finishedEOSInvalidParametersException - if you pass a null pointer for the out parameterEOSNotFoundException - if the user token is not foundEOSExceptionEOS_RTCAdmin_UserToken.release()public void kick(EOS_RTCAdmin_KickOptions options, com.sun.jna.Pointer clientData, EOS_RTCAdmin_OnKickCompleteCallback completionDelegate)
options - structure containing the room and user to revoke the token from.clientData - arbitrary data that is passed back to you in the CompletionDelegatecompletionDelegate - a callback that is fired when the async operation completes, either successfully or in errorpublic void setParticipantHardMute(EOS_RTCAdmin_SetParticipantHardMuteOptions options, com.sun.jna.Pointer clientData, EOS_RTCAdmin_OnSetParticipantHardMuteCompleteCallback completionDelegate)
This remotely mutes the specified participant, so no audio is sent from that participant to any other participant in the room.
options - structure containing the room and user to mute.clientData - arbitrary data that is passed back to you in the CompletionDelegatecompletionDelegate - a callback that is fired when the async operation completes, either successfully or in error