Agora C++ API Reference for All Platforms
Public Member Functions | List of all members
agora::rtc::IVideoRendererEx Class Reference

Inherits agora::rtc::IVideoRenderer.

Inherited by agora::rtc::IObservableVideoSink.

Public Member Functions

virtual int onFrame (const webrtc::VideoFrame &videoFrame)
 
int setView (void *view) override
 
int addView (void *view, const Rectangle &cropArea) override
 
int removeView (void *view) override
 
virtual int addViewEx (uintptr_t handle, const Rectangle &cropArea)
 
virtual int addViewEx (uintptr_t handle)
 
virtual int removeViewEx (uintptr_t handle)
 
int setRenderMode (void *view, media::base::RENDER_MODE_TYPE renderMode) override
 
int setMirror (void *view, bool mirror) override
 
virtual int setRenderModeEx (uintptr_t handle, media::base::RENDER_MODE_TYPE renderMode)
 
virtual int setMirrorEx (uintptr_t handle, bool mirror)
 
virtual void attachUserInfo (uid_t uid, uint64_t state_space)
 
virtual int getViewMetaInfo (PreviewMetaInfo &info)
 
virtual int getViewMetaInfo (uintptr_t handle, PreviewMetaInfo &info)
 
virtual int getViewCount ()
 
virtual int clearBuffer ()
 
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
 
- Public Member Functions inherited from agora::rtc::IVideoRenderer
virtual int setRenderMode (media::base::RENDER_MODE_TYPE renderMode)=0
 
virtual int setMirror (bool mirror)=0
 
virtual int unsetView ()=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
 

Additional Inherited Members

- Protected Member Functions inherited from agora::RefCountInterface
virtual ~RefCountInterface ()
 

Member Function Documentation

◆ onFrame()

virtual int agora::rtc::IVideoRendererEx::onFrame ( const webrtc::VideoFrame &  videoFrame)
inlinevirtual

◆ setView()

int agora::rtc::IVideoRendererEx::setView ( void *  view)
inlineoverridevirtual

Sets the video display window.

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

Implements agora::rtc::IVideoRenderer.

◆ addView()

int agora::rtc::IVideoRendererEx::addView ( void *  view,
const Rectangle cropArea 
)
inlineoverridevirtual

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.

Implements agora::rtc::IVideoRenderer.

◆ removeView()

int agora::rtc::IVideoRendererEx::removeView ( void *  view)
inlineoverridevirtual

remove rendering the video view on the window.

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

Implements agora::rtc::IVideoRenderer.

◆ addViewEx() [1/2]

virtual int agora::rtc::IVideoRendererEx::addViewEx ( uintptr_t  handle,
const Rectangle cropArea 
)
inlinevirtual

◆ addViewEx() [2/2]

virtual int agora::rtc::IVideoRendererEx::addViewEx ( uintptr_t  handle)
inlinevirtual

◆ removeViewEx()

virtual int agora::rtc::IVideoRendererEx::removeViewEx ( uintptr_t  handle)
inlinevirtual

◆ setRenderMode() [1/3]

int agora::rtc::IVideoRendererEx::setRenderMode ( void *  view,
media::base::RENDER_MODE_TYPE  renderMode 
)
inlineoverridevirtual

Sets the render mode of the view.

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

Implements agora::rtc::IVideoRenderer.

◆ setMirror() [1/3]

int agora::rtc::IVideoRendererEx::setMirror ( void *  view,
bool  mirror 
)
inlineoverridevirtual

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.

Implements agora::rtc::IVideoRenderer.

◆ setRenderModeEx()

virtual int agora::rtc::IVideoRendererEx::setRenderModeEx ( uintptr_t  handle,
media::base::RENDER_MODE_TYPE  renderMode 
)
inlinevirtual

◆ setMirrorEx()

virtual int agora::rtc::IVideoRendererEx::setMirrorEx ( uintptr_t  handle,
bool  mirror 
)
inlinevirtual

◆ attachUserInfo()

virtual void agora::rtc::IVideoRendererEx::attachUserInfo ( uid_t  uid,
uint64_t  state_space 
)
inlinevirtual

◆ getViewMetaInfo() [1/2]

virtual int agora::rtc::IVideoRendererEx::getViewMetaInfo ( PreviewMetaInfo info)
inlinevirtual

◆ getViewMetaInfo() [2/2]

virtual int agora::rtc::IVideoRendererEx::getViewMetaInfo ( uintptr_t  handle,
PreviewMetaInfo info 
)
inlinevirtual

◆ getViewCount()

virtual int agora::rtc::IVideoRendererEx::getViewCount ( )
inlinevirtual

◆ clearBuffer()

virtual int agora::rtc::IVideoRendererEx::clearBuffer ( )
inlinevirtual

◆ setRenderMode() [2/3]

virtual int agora::rtc::IVideoRenderer::setRenderMode

Sets the render mode.

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

◆ setRenderMode() [3/3]

virtual int agora::rtc::IVideoRenderer::setRenderMode

Sets the render mode of the view.

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

◆ setMirror() [2/3]

virtual int agora::rtc::IVideoRenderer::setMirror

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() [3/3]

virtual int agora::rtc::IVideoRenderer::setMirror

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.