Agora Java API Reference for Android
Public Member Functions | Protected Member Functions | List of all members
io.agora.rte.media.track.AgoraRteAudioTrack Class Referenceabstract

Public Member Functions

abstract long getNativeHandle ()
 
abstract long getNativeAndroidObject ()
 
abstract void setNativeAndroidObject (long nativeAndroidObject)
 
abstract int enableLocalPlayback ()
 
abstract AgoraRteSourceType getSourceType ()
 
abstract int adjustPublishVolume (int volume)
 
abstract int adjustPlayoutVolume (int volume)
 
abstract String getAttachedStreamId ()
 
abstract int enableExtension (String providerName, String extensionName)
 
abstract int setExtensionProviderProperty (AgoraRteExtensionProperty extensionProperty)
 
abstract int setExtensionProperty (AgoraRteExtensionProperty extensionProperty)
 
abstract AgoraRteExtensionProperty getExtensionProperty ()
 
abstract void destroy ()
 

Protected Member Functions

abstract void setNativeHandle (long nativeHandle)
 

Member Function Documentation

◆ enableLocalPlayback()

abstract int io.agora.rte.media.track.AgoraRteAudioTrack.enableLocalPlayback ( )
abstract

Enable local playback.

Returns
  • 0: Success.
  • < 0: Failure.

◆ getSourceType()

abstract AgoraRteSourceType io.agora.rte.media.track.AgoraRteAudioTrack.getSourceType ( )
abstract

Get the audio source type object

Returns
AgoraRteSourceType The audio source type.

◆ adjustPublishVolume()

abstract int io.agora.rte.media.track.AgoraRteAudioTrack.adjustPublishVolume ( int  volume)
abstract

Adjusts the publish volume of the local audio track..

Parameters
volumeThe volume for publishing. The value ranges between 0 and 100
Returns
  • 0: success
  • < 0: failure

◆ adjustPlayoutVolume()

abstract int io.agora.rte.media.track.AgoraRteAudioTrack.adjustPlayoutVolume ( int  volume)
abstract

Adjusts the playback volume.

Parameters
volumeThe playback volume. The value ranges between 0 and 100
Returns
  • 0: success
  • < 0: failure

◆ getAttachedStreamId()

abstract String io.agora.rte.media.track.AgoraRteAudioTrack.getAttachedStreamId ( )
abstract

Gets the stream ID where the track is published to.

Returns
const std::string& The stream ID, empty if the track isn't published yet.

◆ enableExtension()

abstract int io.agora.rte.media.track.AgoraRteAudioTrack.enableExtension ( String  providerName,
String  extensionName 
)
abstract

Enable extension.

Parameters
providerNamename for provider, e.g. agora.io.
extensionNamename for extension, e.g. agora.beauty.
Returns
  • 0: success.
  • < 0: failure.

◆ setExtensionProviderProperty()

abstract int io.agora.rte.media.track.AgoraRteAudioTrack.setExtensionProviderProperty ( AgoraRteExtensionProperty  extensionProperty)
abstract

Set extension provider specific property.

Parameters
extensionPropertythe extension property
Returns
  • 0: Success.
  • < 0: Failure.

◆ setExtensionProperty()

abstract int io.agora.rte.media.track.AgoraRteAudioTrack.setExtensionProperty ( AgoraRteExtensionProperty  extensionProperty)
abstract

Set extension specific property.

Parameters
extensionPropertythe extension property
Returns
  • 0: success.
  • < 0: failure.

◆ getExtensionProperty()

abstract AgoraRteExtensionProperty io.agora.rte.media.track.AgoraRteAudioTrack.getExtensionProperty ( )
abstract

Get extension specific property.

Returns
the extension property

◆ destroy()

abstract void io.agora.rte.media.track.AgoraRteAudioTrack.destroy ( )
abstract

destroy audio track