public class EOS_RTC_Audio_Interface
extends com.sun.jna.PointerType
EOS_RTC_Interface.getAudioInterface()| Constructor and Description |
|---|
EOS_RTC_Audio_Interface() |
EOS_RTC_Audio_Interface(com.sun.jna.Pointer address) |
| Modifier and Type | Method and Description |
|---|---|
EOS_NotificationId |
addNotifyAudioBeforeRender(EOS_RTCAudio_AddNotifyAudioBeforeRenderOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnAudioBeforeRenderCallback completionDelegate)
Register to receive notifications with remote audio buffers before they are rendered.
|
EOS_NotificationId |
addNotifyAudioBeforeSend(EOS_RTCAudio_AddNotifyAudioBeforeSendOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnAudioBeforeSendCallback completionDelegate)
Register to receive notifications when local audio buffers are about to be encoded and sent.
|
EOS_NotificationId |
addNotifyAudioDevicesChanged(EOS_RTCAudio_AddNotifyAudioDevicesChangedOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnAudioDevicesChangedCallback completionDelegate)
Register to receive notifications when an audio device is added or removed to the system.
|
EOS_NotificationId |
addNotifyAudioInputState(EOS_RTCAudio_AddNotifyAudioInputStateOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnAudioInputStateCallback completionDelegate)
Register to receive notifications when audio input state changed.
|
EOS_NotificationId |
addNotifyAudioOutputState(EOS_RTCAudio_AddNotifyAudioOutputStateOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnAudioOutputStateCallback completionDelegate)
Register to receive notifications when audio output state changed.
|
EOS_NotificationId |
addNotifyParticipantUpdated(EOS_RTCAudio_AddNotifyParticipantUpdatedOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnParticipantUpdatedCallback completionDelegate)
Register to receive notifications when a room participant audio status is updated (f.e when mute state changes or speaking flag changes).
|
EOS_RTCAudio_InputDeviceInformation |
copyInputDeviceInformationByIndex(EOS_RTCAudio_CopyInputDeviceInformationByIndexOptions options)
Fetches an audio input device's information from then given index that are cached locally.
|
EOS_RTCAudio_OutputDeviceInformation |
copyOutputDeviceInformationByIndex(EOS_RTCAudio_CopyOutputDeviceInformationByIndexOptions options)
Fetches an audio output device's information from then given index that are cached locally.
|
int |
getInputDevicesCount(EOS_RTCAudio_GetInputDevicesCountOptions options)
Fetch the number of audio input devices available in the system that are cached locally.
|
int |
getOutputDevicesCount(EOS_RTCAudio_GetOutputDevicesCountOptions options)
Fetch the number of audio output devices available in the system that are cached locally.
|
void |
queryInputDevicesInformation(EOS_RTCAudio_QueryInputDevicesInformationOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnQueryInputDevicesInformationCallback completionDelegate)
Query for a list of audio input devices available in the system together with their specifications.
|
void |
queryOutputDevicesInformation(EOS_RTCAudio_QueryOutputDevicesInformationOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnQueryOutputDevicesInformationCallback completionDelegate)
Query for a list of audio output devices available in the system together with their specifications.
|
void |
registerPlatformUser(EOS_RTCAudio_RegisterPlatformUserOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnRegisterPlatformUserCallback completionDelegate)
Use this function to inform the audio system of a user.
|
void |
removeNotifyAudioBeforeRender(EOS_NotificationId notificationId)
Unregister a previously bound notification handler from receiving remote audio buffers before they are rendered.
|
void |
removeNotifyAudioBeforeSend(EOS_NotificationId notificationId)
Unregister a previously bound notification handler from receiving local audio buffers before they are encoded and sent.
|
void |
removeNotifyAudioDevicesChanged(EOS_NotificationId notificationId)
Unregister a previously bound notification handler from receiving audio devices notifications
|
void |
removeNotifyAudioInputState(EOS_NotificationId notificationId)
Unregister a previously bound notification handler from receiving notifications on audio input state changed.
|
void |
removeNotifyAudioOutputState(EOS_NotificationId notificationId)
Unregister a previously bound notification handler from receiving notifications on audio output state changed.
|
void |
removeNotifyParticipantUpdated(EOS_NotificationId notificationId)
Unregister a previously bound notification handler from receiving participant updated notifications
|
EOS_EResult |
sendAudio(EOS_RTCAudio_SendAudioOptions options)
Use this function to push a new audio buffer to be sent to the participants of a room.
|
void |
setInputDeviceSettings(EOS_RTCAudio_SetInputDeviceSettingsOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnSetInputDeviceSettingsCallback completionDelegate)
Use this function to set audio input device settings, such as the active input device, or platform AEC.
|
void |
setOutputDeviceSettings(EOS_RTCAudio_SetOutputDeviceSettingsOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnSetOutputDeviceSettingsCallback completionDelegate)
Use this function to set audio output device settings, such as the active output device.
|
void |
unregisterPlatformUser(EOS_RTCAudio_UnregisterPlatformUserOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnUnregisterPlatformUserCallback completionDelegate)
Use this function to remove a user that was added with EOS_RTCAudio_RegisterPlatformUser.
|
void |
updateParticipantVolume(EOS_RTCAudio_UpdateParticipantVolumeOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnUpdateParticipantVolumeCallback completionDelegate)
Use this function to change participant audio volume for a room.
|
void |
updateReceiving(EOS_RTCAudio_UpdateReceivingOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnUpdateReceivingCallback completionDelegate)
Use this function to tweak incoming audio options for a room.
|
void |
updateReceivingVolume(EOS_RTCAudio_UpdateReceivingVolumeOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnUpdateReceivingVolumeCallback completionDelegate)
Use this function to change incoming audio volume for a room.
|
void |
updateSending(EOS_RTCAudio_UpdateSendingOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnUpdateSendingCallback completionDelegate)
Use this function to tweak outgoing audio options for a room.
|
void |
updateSendingVolume(EOS_RTCAudio_UpdateSendingVolumeOptions options,
com.sun.jna.Pointer clientData,
EOS_RTCAudio_OnUpdateSendingVolumeCallback completionDelegate)
Use this function to change outgoing audio volume for a room.
|
public EOS_RTC_Audio_Interface(com.sun.jna.Pointer address)
public EOS_RTC_Audio_Interface()
public EOS_EResult sendAudio(EOS_RTCAudio_SendAudioOptions options)
This should only be used if Manual Audio Input was enabled locally for the specified room.
options - structure containing the parameters for the operation.EOS_EResult.EOS_Success if the buffer was successfully queued for sendingEOS_EResult.EOS_InvalidParameters if any of the parameters are incorrectEOS_EResult.EOS_NotFound if the specified room was not foundEOS_EResult.EOS_InvalidState if manual recording was not enabled when joining the room.EOS_RTC_JoinRoomOptions,
EOS_Lobby_LocalRTCOptionspublic void updateSending(EOS_RTCAudio_UpdateSendingOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnUpdateSendingCallback completionDelegate)
Due to internal implementation details, this function requires that you first register to any notification for room
options - structure containing the parameters for the operation.clientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when the operation completes, either successfully or in errorpublic void updateReceiving(EOS_RTCAudio_UpdateReceivingOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnUpdateReceivingCallback completionDelegate)
Due to internal implementation details, this function requires that you first register to any notification for room
options - structure containing the parameters for the operation.clientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when the operation completes, either successfully or in errorpublic void updateSendingVolume(EOS_RTCAudio_UpdateSendingVolumeOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnUpdateSendingVolumeCallback completionDelegate)
Due to internal implementation details, this function requires that you first register to any notification for room
options - structure containing the parameters for the operation.clientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when the operation completes, either successfully or in errorpublic void updateReceivingVolume(EOS_RTCAudio_UpdateReceivingVolumeOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnUpdateReceivingVolumeCallback completionDelegate)
Due to internal implementation details, this function requires that you first register to any notification for room
options - structure containing the parameters for the operation.clientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when the operation completes, either successfully or on errorpublic void updateParticipantVolume(EOS_RTCAudio_UpdateParticipantVolumeOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnUpdateParticipantVolumeCallback completionDelegate)
Due to internal implementation details, this function requires that you first register to any notification for room
options - structure containing the parameters for the operation.clientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when the operation completes, either successfully or in errorpublic EOS_NotificationId addNotifyParticipantUpdated(EOS_RTCAudio_AddNotifyParticipantUpdatedOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnParticipantUpdatedCallback completionDelegate)
The notification is raised when the participant's audio 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_RTCAudio_RemoveNotifyParticipantUpdated when you no longer wish to have your completionDelegate called.
clientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when a participant changes audio statusEOS_NotificationId.EOS_INVALID_NOTIFICATIONID,
removeNotifyParticipantUpdated(EOS_NotificationId),
EOS_RTCAudio_ParticipantUpdatedCallbackInfo,
EOS_ERTCAudioStatuspublic void removeNotifyParticipantUpdated(EOS_NotificationId notificationId)
notificationId - The Notification ID representing the registered callbackpublic EOS_NotificationId addNotifyAudioDevicesChanged(EOS_RTCAudio_AddNotifyAudioDevicesChangedOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnAudioDevicesChangedCallback completionDelegate)
If the returned NotificationId is valid, you must call EOS_RTCAudio_RemoveNotifyAudioDevicesChanged when you no longer wish to have your completionDelegate called.
The library will try to use user selected audio device while following these rules:
clientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when an audio device change occursEOS_NotificationId.EOS_INVALID_NOTIFICATIONID,
removeNotifyAudioDevicesChanged(EOS_NotificationId)public void removeNotifyAudioDevicesChanged(EOS_NotificationId notificationId)
notificationId - The Notification ID representing the registered callbackpublic EOS_NotificationId addNotifyAudioInputState(EOS_RTCAudio_AddNotifyAudioInputStateOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnAudioInputStateCallback completionDelegate)
If the returned NotificationId is valid, you must call EOS_RTCAudio_RemoveNotifyAudioInputState when you no longer wish to have your completionDelegate called.
clientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when audio input state changesEOS_NotificationId.EOS_INVALID_NOTIFICATIONID,
removeNotifyAudioInputState(EOS_NotificationId)public void removeNotifyAudioInputState(EOS_NotificationId notificationId)
notificationId - The Notification ID representing the registered callbackpublic EOS_NotificationId addNotifyAudioOutputState(EOS_RTCAudio_AddNotifyAudioOutputStateOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnAudioOutputStateCallback completionDelegate)
If the returned NotificationId is valid, you must call EOS_RTCAudio_RemoveNotifyAudioOutputState when you no longer wish to have your completionDelegate called.
clientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when audio output state changesEOS_NotificationId.EOS_INVALID_NOTIFICATIONID,
removeNotifyAudioOutputState(EOS_NotificationId)public void removeNotifyAudioOutputState(EOS_NotificationId notificationId)
notificationId - The Notification ID representing the registered callbackpublic EOS_NotificationId addNotifyAudioBeforeSend(EOS_RTCAudio_AddNotifyAudioBeforeSendOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnAudioBeforeSendCallback completionDelegate)
This gives you access to the audio data about to be sent, allowing for example the implementation of custom filters/effects.
If the returned NotificationId is valid, you must call EOS_RTCAudio_RemoveNotifyAudioBeforeSend 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.
clientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when local audio buffers are about to be encoded and sentEOS_NotificationId.EOS_INVALID_NOTIFICATIONID,
removeNotifyAudioBeforeSend(EOS_NotificationId)public void removeNotifyAudioBeforeSend(EOS_NotificationId notificationId)
notificationId - The Notification ID representing the registered callbackpublic EOS_NotificationId addNotifyAudioBeforeRender(EOS_RTCAudio_AddNotifyAudioBeforeRenderOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnAudioBeforeRenderCallback completionDelegate)
This gives you access to the audio data received, allowing for example the implementation of custom filters/effects.
If the returned NotificationId is valid, you must call EOS_RTCAudio_RemoveNotifyAudioBeforeRender 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.
clientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when remote audio buffers are about to be renderedEOS_NotificationId.EOS_INVALID_NOTIFICATIONID,
removeNotifyAudioBeforeRender(EOS_NotificationId)public void removeNotifyAudioBeforeRender(EOS_NotificationId notificationId)
notificationId - The Notification ID representing the registered callbackpublic void registerPlatformUser(EOS_RTCAudio_RegisterPlatformUserOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnRegisterPlatformUserCallback completionDelegate)
This function is only necessary for some platforms.
options - structure containing the parameters for the operationclientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when the operation completes, either successfully or in errorunregisterPlatformUser(EOS_RTCAudio_UnregisterPlatformUserOptions, Pointer, EOS_RTCAudio_OnUnregisterPlatformUserCallback)public void unregisterPlatformUser(EOS_RTCAudio_UnregisterPlatformUserOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnUnregisterPlatformUserCallback completionDelegate)
This function is only necessary for some platforms.
options - structure containing the parameters for the operationclientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when the operation completes, either successfully or in errorpublic void queryInputDevicesInformation(EOS_RTCAudio_QueryInputDevicesInformationOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnQueryInputDevicesInformationCallback completionDelegate)
options - structure containing the parameters for the operationclientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when the operation completes, either successfully or in errorpublic int getInputDevicesCount(EOS_RTCAudio_GetInputDevicesCountOptions options)
The returned value should not be cached and should instead be used immediately with the EOS_RTCAudio_CopyInputDeviceInformationByIndex function.
options - structure containing the parameters for the operationcopyInputDeviceInformationByIndex(EOS_RTCAudio_CopyInputDeviceInformationByIndexOptions),
addNotifyAudioDevicesChanged(EOS_RTCAudio_AddNotifyAudioDevicesChangedOptions, Pointer, EOS_RTCAudio_OnAudioDevicesChangedCallback)public EOS_RTCAudio_InputDeviceInformation copyInputDeviceInformationByIndex(EOS_RTCAudio_CopyInputDeviceInformationByIndexOptions options) throws EOSException
options - structure containing the index being accessedEOSInvalidParametersException - if you pass a null pointer for the out parameterEOSNotFoundException - if the audio input device's information is not foundEOSExceptionEOS_RTCAudio_InputDeviceInformation.release(),
addNotifyAudioDevicesChanged(EOS_RTCAudio_AddNotifyAudioDevicesChangedOptions, Pointer, EOS_RTCAudio_OnAudioDevicesChangedCallback)public void queryOutputDevicesInformation(EOS_RTCAudio_QueryOutputDevicesInformationOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnQueryOutputDevicesInformationCallback completionDelegate)
options - structure containing the parameters for the operationclientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when the operation completes, either successfully or in errorpublic int getOutputDevicesCount(EOS_RTCAudio_GetOutputDevicesCountOptions options)
The returned value should not be cached and should instead be used immediately with the EOS_RTCAudio_CopyOutputDeviceInformationByIndex function.
options - structure containing the parameters for the operationcopyOutputDeviceInformationByIndex(EOS_RTCAudio_CopyOutputDeviceInformationByIndexOptions),
addNotifyAudioDevicesChanged(EOS_RTCAudio_AddNotifyAudioDevicesChangedOptions, Pointer, EOS_RTCAudio_OnAudioDevicesChangedCallback)public EOS_RTCAudio_OutputDeviceInformation copyOutputDeviceInformationByIndex(EOS_RTCAudio_CopyOutputDeviceInformationByIndexOptions options) throws EOSException
options - structure containing the index being accessedEOSInvalidParametersException - if you pass a null pointer for the out parameterEOSNotFoundException - if the audio output device's information is not foundEOSExceptionEOS_RTCAudio_OutputDeviceInformation.release(),
addNotifyAudioDevicesChanged(EOS_RTCAudio_AddNotifyAudioDevicesChangedOptions, Pointer, EOS_RTCAudio_OnAudioDevicesChangedCallback)public void setInputDeviceSettings(EOS_RTCAudio_SetInputDeviceSettingsOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnSetInputDeviceSettingsCallback completionDelegate)
options - structure containing the parameters for the operationclientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when the operation completes, either successfully or in errorpublic void setOutputDeviceSettings(EOS_RTCAudio_SetOutputDeviceSettingsOptions options, com.sun.jna.Pointer clientData, EOS_RTCAudio_OnSetOutputDeviceSettingsCallback completionDelegate)
options - structure containing the parameters for the operationclientData - Arbitrary data that is passed back in the completionDelegatecompletionDelegate - The callback to be fired when the operation completes, either successfully or in error