Agora RTC Objective-C API Reference  Refactor
Public Member Functions
IMediaNodeFactory Class Referenceabstract

Inherits RefCountInterface.

Public Member Functions

virtual agora_refptr< IAudioPcmDataSendercreateAudioPcmDataSender ()=0
 
virtual agora_refptr< IAudioEncodedFrameSendercreateAudioEncodedFrameSender ()=0
 
virtual agora_refptr< IRemoteAudioMixerSourcecreateRemoteAudioMixerSource ()=0
 
virtual agora_refptr< ICameraCapturercreateCameraCapturer ()=0
 
virtual agora_refptr< IScreenCapturercreateScreenCapturer ()=0
 
virtual agora_refptr< IVideoMixerSourcecreateVideoMixer ()=0
 
virtual agora_refptr< IVideoFrameTransceivercreateVideoFrameTransceiver ()=0
 
virtual agora_refptr< IVideoFrameSendercreateVideoFrameSender ()=0
 
virtual agora_refptr< IVideoEncodedImageSendercreateVideoEncodedImageSender ()=0
 
virtual agora_refptr< IVideoRenderercreateVideoRenderer ()=0
 
virtual agora_refptr< IAudioFiltercreateAudioFilter (const char *provider_name, const char *extension_name)=0
 
virtual agora_refptr< IVideoFiltercreateVideoFilter (const char *provider_name, const char *extension_name)=0
 
virtual agora_refptr< IVideoSinkBasecreateVideoSink (const char *provider_name, const char *extension_name)=0
 
virtual agora_refptr< IMediaPlayerSourcecreateMediaPlayerSource (media::base::MEDIA_PLAYER_SOURCE_TYPE type=agora::media::base::MEDIA_PLAYER_SOURCE_DEFAULT)=0
 
virtual agora_refptr< IMediaStreamingSourcecreateMediaStreamingSource ()=0
 
virtual agora_refptr< IMediaPacketSendercreateMediaPacketSender ()=0
 

Detailed Description

The IMediaNodeFactory class.

Constructor & Destructor Documentation

◆ ~IMediaNodeFactory()

~IMediaNodeFactory ( )
inlineprotected

Member Function Documentation

◆ createAudioPcmDataSender()

virtual agora_refptr<IAudioPcmDataSender> createAudioPcmDataSender ( )
pure virtual

Creates a PCM audio data sender.

This method creates an IAudioPcmDataSender object, which can be used by createCustomAudioTrack to send PCM audio data.

Returns

◆ createAudioEncodedFrameSender()

virtual agora_refptr<IAudioEncodedFrameSender> createAudioEncodedFrameSender ( )
pure virtual

Creates an encoded audio data sender.

This method creates an IAudioEncodedFrameSender object, which can be used by createCustomAudioTrack to send encoded audio data.

Returns

◆ createRemoteAudioMixerSource()

virtual agora_refptr<IRemoteAudioMixerSource> createRemoteAudioMixerSource ( )
pure virtual

Creates a remote audio mixer source object and returns the pointer.

Parameters
typeThe type of audio mixer source you want to create.
Returns

◆ createCameraCapturer()

virtual agora_refptr<ICameraCapturer> createCameraCapturer ( )
pure virtual

Creates a camera capturer.

Once a camera capturer object is created, you can use the video data captured by the camera as the custom video source.

Returns

◆ createScreenCapturer()

virtual agora_refptr<IScreenCapturer> createScreenCapturer ( )
pure virtual

Creates a screen capturer.

Once a screen capturer object is created, you can use the screen video data as the custom video source.

Returns

◆ createVideoMixer()

virtual agora_refptr<IVideoMixerSource> createVideoMixer ( )
pure virtual

Creates a video mixer.

Once a video mixer object is created, you can use the video mixer data as the custom video source.

Returns

◆ createVideoFrameTransceiver()

virtual agora_refptr<IVideoFrameTransceiver> createVideoFrameTransceiver ( )
pure virtual

Creates a video transceiver.

Once a video transceiver object is created, you can use the video transceiver data as the custom video source.

Returns

◆ createVideoFrameSender()

virtual agora_refptr<IVideoFrameSender> createVideoFrameSender ( )
pure virtual

Creates a video frame sender.

This method creates an IVideoFrameSender object, which can be used by createCustomVideoTrack to send the custom video data.

Returns

◆ createVideoEncodedImageSender()

virtual agora_refptr<IVideoEncodedImageSender> createVideoEncodedImageSender ( )
pure virtual

Creates an encoded video image sender.

This method creates an IVideoEncodedImageSender object, which can be used by createCustomVideoTrack to send the encoded video data.

Returns

◆ createVideoRenderer()

virtual agora_refptr<IVideoRenderer> createVideoRenderer ( )
pure virtual

Creates a built-in video renderer.

Parameters
viewThe video window view.
Returns

◆ createAudioFilter()

virtual agora_refptr<IAudioFilter> createAudioFilter ( const char *  provider_name,
const char *  extension_name 
)
pure virtual

Creates an audio filter for the extension.

This method creates an IAudioFilter object, which can be used to filter the audio data from the inside extension.

Parameters
provider_nameprovider name string.
extension_nameextension name string.
Returns
  • The pointer to IAudioFilter: Success.
  • A null pointer: Failure.

◆ createVideoFilter()

virtual agora_refptr<IVideoFilter> createVideoFilter ( const char *  provider_name,
const char *  extension_name 
)
pure virtual

Creates a video filter for the extension.

This method creates an IVideoFilter object, which can be used to filter the video from inside extension.

Parameters
provider_nameprovider name string.
extension_nameextension name string.
Returns
  • The pointer to IVideoFilter: Success.
  • A null pointer: Failure.

◆ createVideoSink()

virtual agora_refptr<IVideoSinkBase> createVideoSink ( const char *  provider_name,
const char *  extension_name 
)
pure virtual

Creates a video sink for the extension.

This method creates an IVideoSinkBase object, which can be used to receive the video from the inside extension.

Parameters
provider_nameprovider name string.
extension_nameextension name string.
Returns

◆ createMediaPlayerSource()

Creates a media player source object and returns the pointer.

Parameters
typeThe type of media player source you want to create.
Returns
  • The pointer to IMediaPlayerSource, if the method call succeeds.
  • A null pointer: Failure.

◆ createMediaStreamingSource()

virtual agora_refptr<IMediaStreamingSource> createMediaStreamingSource ( )
pure virtual

Creates a media streaming source object and returns the pointer.

Parameters
typeThe type of media streaming source you want to create.
Returns

◆ createMediaPacketSender()

virtual agora_refptr<IMediaPacketSender> createMediaPacketSender ( )
pure virtual

Creates a media packet sender object and returns the pointer.

Returns
  • The pointer to IMediaPacketSender, if the method call succeeds.
  • A null pointer: Failure.

◆ AddRef()

virtual void AddRef ( ) const
pure virtualinherited

◆ Release()

virtual RefCountReleaseStatus Release ( ) const
pure virtualinherited

◆ HasOneRef()

virtual bool HasOneRef ( ) const
pure virtualinherited