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

#include <NGIAgoraRtmpLocalUser.h>

Public Types

enum  VideoBitrateAdjustType { None = 0, Increasing = 1, Decreasing = 2 }
 

Public Member Functions

virtual int setAudioStreamConfiguration (const RtmpStreamingAudioConfiguration &config)=0
 
virtual int setVideoStreamConfiguration (const RtmpStreamingVideoConfiguration &config)=0
 
virtual int adjustRecordingSignalVolume (int volume)=0
 
virtual int getRecordingSignalVolume (int32_t *volume)=0
 
virtual int setAudioEnabled (bool enabled)=0
 
virtual void adjustVideoBitrate (VideoBitrateAdjustType type)=0
 
virtual int setVideoEnabled (bool enabled)=0
 
virtual int publishAudio (agora_refptr< rtc::ILocalAudioTrack > audioTrack)=0
 
virtual int unpublishAudio (agora_refptr< rtc::ILocalAudioTrack > audioTrack)=0
 
virtual int publishMediaPlayerAudio (agora_refptr< rtc::ILocalAudioTrack > audioTrack, int32_t playerId=0)=0
 
virtual int unpublishMediaPlayerAudio (agora_refptr< rtc::ILocalAudioTrack > audioTrack, int32_t playerId=0)=0
 
virtual int publishVideo (agora_refptr< rtc::ILocalVideoTrack > videoTrack)=0
 
virtual int unpublishVideo (agora_refptr< rtc::ILocalVideoTrack > videoTrack)=0
 
virtual int registerRtmpUserObserver (IRtmpLocalUserObserver *observer, void(*safeDeleter)(IRtmpLocalUserObserver *)=NULL)=0
 
virtual int unregisteRtmpUserObserver (IRtmpLocalUserObserver *observer)=0
 
virtual int registerAudioFrameObserver (media::base::IAudioFrameObserver *observer)=0
 
virtual void unregisterAudioFrameObserver (media::base::IAudioFrameObserver *observer)=0
 
virtual int registerVideoFrameObserver (media::base::IVideoFrameObserver *observer)=0
 
virtual void unregisterVideoFrameObserver (media::base::IVideoFrameObserver *observer)=0
 

Detailed Description

The IRtmpLocalUser class defines the behavior and state of the RTMP user.

Once connected, a RTMP connection has its own user. Apps can get the user object using IRtmpConnection::getUser.

Member Function Documentation

◆ publishAudio()

virtual int agora::rtc::IRtmpLocalUser::publishAudio ( agora_refptr< rtc::ILocalAudioTrack audioTrack)
pure virtual

Publishes a local audio track to the RTMP connection.

Parameters
audioTrackThe local audio track to be published: ILocalAudioTrack.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unpublishAudio()

virtual int agora::rtc::IRtmpLocalUser::unpublishAudio ( agora_refptr< rtc::ILocalAudioTrack audioTrack)
pure virtual

Stops publishing the local audio track to the RTMP connection.

Parameters
audioTrackThe local audio track that you want to stop publishing: ILocalAudioTrack.
Returns
  • 0: Success.
  • < 0: Failure.

◆ publishMediaPlayerAudio()

virtual int agora::rtc::IRtmpLocalUser::publishMediaPlayerAudio ( agora_refptr< rtc::ILocalAudioTrack audioTrack,
int32_t  playerId = 0 
)
pure virtual

Publishes a media player local audio track to the RTMP connection.

Parameters
audioTrackThe local audio track to be published: ILocalAudioTrack.
playerIdThe player source ID.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unpublishMediaPlayerAudio()

virtual int agora::rtc::IRtmpLocalUser::unpublishMediaPlayerAudio ( agora_refptr< rtc::ILocalAudioTrack audioTrack,
int32_t  playerId = 0 
)
pure virtual

Stops publishing the media player local audio track to the RTMP connection.

Parameters
audioTrackThe local audio track that you want to stop publishing: ILocalAudioTrack.
playerIdThe player source ID.
Returns
  • 0: Success.
  • < 0: Failure.

◆ publishVideo()

virtual int agora::rtc::IRtmpLocalUser::publishVideo ( agora_refptr< rtc::ILocalVideoTrack videoTrack)
pure virtual

Publishes a local video track to the RTMP connection.

Parameters
videoTrackThe local video track to be published: ILocalVideoTrack.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unpublishVideo()

virtual int agora::rtc::IRtmpLocalUser::unpublishVideo ( agora_refptr< rtc::ILocalVideoTrack videoTrack)
pure virtual

Stops publishing the local video track to the RTMP connection.

Parameters
videoTrackThe local video track that you want to stop publishing: ILocalVideoTrack.
  • 0: Success.
  • < 0: Failure.

◆ registerRtmpUserObserver()

virtual int agora::rtc::IRtmpLocalUser::registerRtmpUserObserver ( IRtmpLocalUserObserver observer,
void(*)(IRtmpLocalUserObserver *)  safeDeleter = NULL 
)
pure virtual

Registers a RTMP user observer object.

You need to implement the IRtmpLocalUserObserver class in this method. Once registered, the IRtmpLocalUserObserver receives events sent by the IRtmpLocalUser object.

Parameters
observerThe pointer to the IRtmpLocalUserObserver object.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unregisteRtmpUserObserver()

virtual int agora::rtc::IRtmpLocalUser::unregisteRtmpUserObserver ( IRtmpLocalUserObserver observer)
pure virtual

Releases the IRtmpLocalUserObserver object previously registered using registerRtmpUserObserver().

Parameters
observerThe pointer to the IRtmpLocalUserObserver object that you want to release.
Returns
  • 0: Success.
  • < 0: Failure.

◆ registerAudioFrameObserver()

virtual int agora::rtc::IRtmpLocalUser::registerAudioFrameObserver ( media::base::IAudioFrameObserver observer)
pure virtual

Registers an audio frame observer object.

Parameters
observerA pointer to the audio frame observer object: IAudioFrameObserver.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unregisterAudioFrameObserver()

virtual void agora::rtc::IRtmpLocalUser::unregisterAudioFrameObserver ( media::base::IAudioFrameObserver observer)
pure virtual

Unregisters an audio frame observer object.

Parameters
observerA pointer to the audio frame observer object: IAudioFrameObserver.

◆ registerVideoFrameObserver()

virtual int agora::rtc::IRtmpLocalUser::registerVideoFrameObserver ( media::base::IVideoFrameObserver observer)
pure virtual

Registers a video frame observer object.

Parameters
observerA pointer to the video frame observer: IVideoFrameObserver.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unregisterVideoFrameObserver()

virtual void agora::rtc::IRtmpLocalUser::unregisterVideoFrameObserver ( media::base::IVideoFrameObserver observer)
pure virtual

Unregisters a video frame observer object.

Parameters
observerA pointer to the video frame observer: IVideoFrameObserver.