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

Public Member Functions

abstract long getNativeHandle ()
 
abstract long getNativeAndroidObject ()
 
abstract void setNativeAndroidObject (long nativeAndroidObject)
 
abstract int setPreviewCanvas (AgoraRteVideoCanvas canvas)
 
abstract AgoraRteSourceType getSourceType ()
 
abstract void registerVideoFrameObserver (AgoraRteVideoFrameObserver observer)
 
abstract void unregisterVideoFrameObserver (AgoraRteVideoFrameObserver observer)
 
abstract int setFilterProperty (String id, String key, String json)
 
abstract String getFilterProperty (String id, String key)
 
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

◆ setPreviewCanvas()

abstract int io.agora.rte.media.track.AgoraRteVideoTrack.setPreviewCanvas ( AgoraRteVideoCanvas  canvas)
abstract

Sets the video canvas for local preview.

Parameters
canvasVideo canvas settings.
Returns
  • 0: success
  • < 0: failure

◆ getSourceType()

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

Get the video source Type

Returns
AgoraRteSourceType The video source type

◆ registerVideoFrameObserver()

abstract void io.agora.rte.media.track.AgoraRteVideoTrack.registerVideoFrameObserver ( AgoraRteVideoFrameObserver  observer)
abstract

Registers a video frame observer.

Parameters
observeran IAgoraRteVideoFrameObserver object.

◆ unregisterVideoFrameObserver()

abstract void io.agora.rte.media.track.AgoraRteVideoTrack.unregisterVideoFrameObserver ( AgoraRteVideoFrameObserver  observer)
abstract

Unregisters a video frame observer.

Parameters
observeran IAgoraRteVideoFrameObserver object.

◆ setFilterProperty()

abstract int io.agora.rte.media.track.AgoraRteVideoTrack.setFilterProperty ( String  id,
String  key,
String  json 
)
abstract

Sets the property of a filter by ID

Parameters
idID of the filter.
keyKey of the filter.
jsonValue of the filter in JSON format.
Returns
  • 0: success
  • < 0: failure

◆ getFilterProperty()

abstract String io.agora.rte.media.track.AgoraRteVideoTrack.getFilterProperty ( String  id,
String  key 
)
abstract

Gets the property of a filter by ID.

Parameters
idID of the filter.
keyKey of the filter.
Returns
  • 0: success
  • < 0: failure

◆ getAttachedStreamId()

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

Gets the stream ID where the track is published to.

Returns
String The stream ID, empty if the track isn't published yet.

◆ enableExtension()

abstract int io.agora.rte.media.track.AgoraRteVideoTrack.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.AgoraRteVideoTrack.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.AgoraRteVideoTrack.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.AgoraRteVideoTrack.getExtensionProperty ( )
abstract

Get extension specific property.

Returns
the extension property

◆ destroy()

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

destroy video track