Agora Java API Reference for Android
Public Member Functions | List of all members
agora::rtc::IVideoRenderer Class Referenceabstract

#include <NGIAgoraMediaNode.h>

Inheritance diagram for agora::rtc::IVideoRenderer:
agora::rtc::IVideoSinkBase agora::RefCountInterface

Public Member Functions

virtual int setRenderMode (media::base::RENDER_MODE_TYPE renderMode)=0
 
virtual int setRenderMode (void *view, media::base::RENDER_MODE_TYPE renderMode)=0
 
virtual int setMirror (bool mirror)=0
 
virtual int setMirror (void *view, bool mirror)=0
 
virtual int setView (void *view)=0
 
virtual int addView (void *view, const Rectangle &cropArea)=0
 
virtual int unsetView ()=0
 
virtual int removeView (void *view)=0
 
- Public Member Functions inherited from agora::rtc::IVideoSinkBase
virtual int setProperty (const char *key, const void *buf, int buf_size)
 
virtual int getProperty (const char *key, void *buf, int buf_size)
 
virtual int onFrame (const media::base::VideoFrame &videoFrame)=0
 
virtual bool isExternalSink ()
 
virtual bool onDataStreamWillStart ()
 
virtual void onDataStreamWillStop ()
 
virtual bool applyMirror ()
 
virtual bool applyRotation ()
 
- Public Member Functions inherited from agora::RefCountInterface
virtual void AddRef () const =0
 
virtual RefCountReleaseStatus Release () const =0
 
virtual bool HasOneRef () const =0
 

Detailed Description

The IVideoRenderer class.

Member Function Documentation

◆ setRenderMode() [1/2]

virtual int agora::rtc::IVideoRenderer::setRenderMode ( media::base::RENDER_MODE_TYPE  renderMode)
pure virtual

Sets the render mode.

Parameters
renderModeThe video render mode.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setRenderMode() [2/2]

virtual int agora::rtc::IVideoRenderer::setRenderMode ( void *  view,
media::base::RENDER_MODE_TYPE  renderMode 
)
pure virtual

Sets the render mode of the view.

Parameters
viewthe view to set render mode.
renderModeThe video render mode.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setMirror() [1/2]

virtual int agora::rtc::IVideoRenderer::setMirror ( bool  mirror)
pure virtual

Sets whether to mirror the video.

Parameters
mirrorWhether to mirror the video:
  • true: Mirror the video.
  • false: Do not mirror the video.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setMirror() [2/2]

virtual int agora::rtc::IVideoRenderer::setMirror ( void *  view,
bool  mirror 
)
pure virtual

Sets whether to mirror the video.

Parameters
viewthe view to set mirror mode.
mirrorWhether to mirror the video:
  • true: Mirror the video.
  • false: Do not mirror the video.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setView()

virtual int agora::rtc::IVideoRenderer::setView ( void *  view)
pure virtual

Sets the video display window.

Parameters
viewThe pointer to the video display window.
Returns
  • 0: Success.
  • < 0: Failure.

◆ addView()

virtual int agora::rtc::IVideoRenderer::addView ( void *  view,
const Rectangle cropArea 
)
pure virtual

Sets the video display window.

Parameters
viewThe pointer to the video display window.
cropArea(Optional) Sets the relative location of the region to show. See Rectangle.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unsetView()

virtual int agora::rtc::IVideoRenderer::unsetView ( )
pure virtual

Stops rendering the video view on the window.

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

◆ removeView()

virtual int agora::rtc::IVideoRenderer::removeView ( void *  view)
pure virtual

remove rendering the video view on the window.

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