Package host.anzo.eossdk.eos.sdk

Class EOS_RTC_Data_Interface

java.lang.Object
com.sun.jna.PointerType
host.anzo.eossdk.eos.sdk.EOS_RTC_Data_Interface
All Implemented Interfaces:
com.sun.jna.NativeMapped
public class EOS_RTC_Data_Interface extends com.sun.jna.PointerType
The RTC Data Interface. This is used to manage Data specific RTC features
Since:
3/24/2024

  • Constructor Details

    • EOS_RTC_Data_Interface

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

    • EOS_RTC_Data_Interface

      public EOS_RTC_Data_Interface()

  • Method Details

    • addNotifyDataReceived

      public EOS_NotificationId addNotifyDataReceived(EOS_RTCData_AddNotifyDataReceivedOptions options, com.sun.jna.Pointer clientData, EOS_RTCData_OnDataReceivedCallback completionDelegate)
      Register to receive notifications with remote data packet received. If the returned NotificationId is valid, you must call EOS_RTCData_RemoveNotifyDataReceived when you no longer wish to have your CompletionDelegate called.

      The CompletionDelegate may be called from a thread other than the one from which the SDK is ticking.

      Parameters:
      clientData - Arbitrary data that is passed back in the CompletionDelegate
      completionDelegate - The callback to be fired when a data packet is received
      Returns:
      Notification ID representing the registered callback if successful, an invalid NotificationId if not
      See Also:

    • removeNotifyDataReceived

      public void removeNotifyDataReceived(EOS_NotificationId notificationId)
      Unregister a previously bound notification handler from receiving remote data packets.
      Parameters:
      notificationId - The Notification ID representing the registered callback

    • sendData

      public EOS_EResult sendData(EOS_RTCData_SendDataOptions options)
      Use this function to send a data packet to the rest of participants.
      Parameters:
      options - structure containing the parameters for the operation.
      Returns:
      EOS_EResult.EOS_Success the data packet was queued for sending
      EOS_EResult.EOS_InvalidParameters if any of the options are invalid
      EOS_EResult.EOS_NotFound if the specified room was not found

    • updateSending

      public void updateSending(EOS_RTCData_UpdateSendingOptions options, com.sun.jna.Pointer clientData, EOS_RTCData_OnUpdateSendingCallback completionDelegate)
      Use this function to tweak outgoing data options for a room.
      Parameters:
      options - structure containing the parameters for the operation.
      clientData - Arbitrary data that is passed back in the CompletionDelegate
      completionDelegate - The callback to be fired when the operation completes, either successfully or in error

    • updateReceiving

      public void updateReceiving(EOS_RTCData_UpdateReceivingOptions options, com.sun.jna.Pointer clientData, EOS_RTCData_OnUpdateReceivingCallback completionDelegate)
      Use this function to tweak incoming data options for a room.
      Parameters:
      options - structure containing the parameters for the operation.
      clientData - Arbitrary data that is passed back in the CompletionDelegate
      completionDelegate - The callback to be fired when the operation completes, either successfully or in error

    • addNotifyParticipantUpdated

      public EOS_NotificationId addNotifyParticipantUpdated(EOS_RTCData_AddNotifyParticipantUpdatedOptions options, com.sun.jna.Pointer clientData, EOS_RTCData_OnParticipantUpdatedCallback completionDelegate)
      Register to receive notifications when a room participant data status is updated (f.e when connection state changes).

      The notification is raised when the participant's data status is updated. In order not to miss any participant status changes, applications need to add the notification before joining a room.

      If the returned NotificationId is valid, you must call EOS_RTCData_RemoveNotifyParticipantUpdated when you no longer wish to have your CompletionDelegate called.

      Parameters:
      options - structure containing the parameters for the operation.
      clientData - Arbitrary data that is passed back in the CompletionDelegate
      completionDelegate - The callback to be fired when a participant changes data status
      Returns:
      Notification ID representing the registered callback if successful, an invalid NotificationId if not
      See Also:

    • removeNotifyParticipantUpdated

      public void removeNotifyParticipantUpdated(EOS_NotificationId notificationId)
      Unregister a previously bound notification handler from receiving participant updated notifications
      Parameters:
      notificationId - The Notification ID representing the registered callback