host.anzo.eossdk.eos.sdk

Class EOS_RTC_Admin_Interface

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.EOS_RTC_Admin_Interface

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_RTC_Admin_Interface
extends com.sun.jna.PointerType

The RTC Admin interface. This is used to manage admin-specific RTC features, such as requesting join tokens, kick users, etc.

Since:

11/1/2023

See Also:

EOS_Platform_Interface.getRTCAdminInterface()

Constructor Summary

Constructors

Constructor and Description
EOS_RTC_Admin_Interface()
EOS_RTC_Admin_Interface(com.sun.jna.Pointer address)

Method Summary

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.

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EOS_RTC_Admin_Interface

public EOS_RTC_Admin_Interface(com.sun.jna.Pointer address)

EOS_RTC_Admin_Interface

public EOS_RTC_Admin_Interface()

Method Detail

queryJoinRoomToken

public 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.

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.

Parameters:

options - Structure containing information about the application whose user tokens we're retrieving.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - This function is called when the query join room token operation completes.

See Also:

EOS_RTCAdmin_QueryJoinRoomTokenCompleteCallbackInfo

copyUserTokenByIndex

public EOS_RTCAdmin_UserToken copyUserTokenByIndex(EOS_RTCAdmin_CopyUserTokenByIndexOptions options)
                                            throws EOSException

Fetches a user token when called inside of the OnQueryJoinRoomTokenComplete callback.

Parameters:

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.

Returns:

The user token for the given index, if it exists and is valid. Use EOS_RTCAdmin_UserToken.release() when finished

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the user token is not found

EOSException

See Also:

EOS_RTCAdmin_UserToken.release()

copyUserTokenByUserId

public EOS_RTCAdmin_UserToken copyUserTokenByUserId(EOS_RTCAdmin_CopyUserTokenByUserIdOptions options)
                                             throws EOSException

Fetches a user token for a given user ID when called inside of the OnQueryJoinRoomTokenComplete callback.

Parameters:

options - Structure containing the user ID being accessed

Returns:

The user token for the given user ID, if it exists and is valid. Use EOS_RTCAdmin_UserToken.release() when finished

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the user token is not found

EOSException

See Also:

EOS_RTCAdmin_UserToken.release()

kick

public 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.

Parameters:

options - structure containing the room and user to revoke the token from.

clientData - arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - a callback that is fired when the async operation completes, either successfully or in error

setParticipantHardMute

public 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.

This remotely mutes the specified participant, so no audio is sent from that participant to any other participant in the room.

Parameters:

options - structure containing the room and user to mute.

clientData - arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - a callback that is fired when the async operation completes, either successfully or in error