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

Inherits agora::RefCountInterface.

Public Member Functions

virtual int startChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration)=0
 
virtual int updateChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration)=0
 
virtual int stopChannelMediaRelay ()=0
 
virtual void registerEventHandler (IMediaRelayObserver *eventObserver, void(*safeDeleter)(IMediaRelayObserver *)=NULL)=0
 
virtual void unregisterEventHandler (IMediaRelayObserver *eventObserver)=0
 
- 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

◆ startChannelMediaRelay()

virtual int agora::rtc::IMediaRelayService::startChannelMediaRelay ( const ChannelMediaRelayConfiguration configuration)
pure virtual

Starts to relay media streams across channels.

Parameters
configurationThe configuration of the media stream relay: ChannelMediaRelayConfiguration.
Returns
  • 0: Success.
  • < 0: Failure.

◆ updateChannelMediaRelay()

virtual int agora::rtc::IMediaRelayService::updateChannelMediaRelay ( const ChannelMediaRelayConfiguration configuration)
pure virtual

Updates the channels for media stream relay. After a successful startChannelMediaRelay method call, if you want to relay the media stream to more channels, or leave the current relay channel, you can call the updateChannelMediaRelay method.

Note
Call this method after the startChannelMediaRelay method to update the destination channel.
Parameters
configurationThe media stream relay configuration: ChannelMediaRelayConfiguration.
Returns
  • 0: Success.
  • < 0: Failure.

◆ stopChannelMediaRelay()

virtual int agora::rtc::IMediaRelayService::stopChannelMediaRelay ( )
pure virtual

Stops the media stream relay.

Once the relay stops, the host quits all the destination channels.

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

◆ registerEventHandler()

virtual void agora::rtc::IMediaRelayService::registerEventHandler ( IMediaRelayObserver eventObserver,
void(*)(IMediaRelayObserver *)  safeDeleter = NULL 
)
pure virtual

◆ unregisterEventHandler()

virtual void agora::rtc::IMediaRelayService::unregisterEventHandler ( IMediaRelayObserver eventObserver)
pure virtual