Agora C++ API Reference for All Platforms
|
Public Types | |
enum | VideoBitrateAdjustType { None = 0, Increasing = 1, Decreasing = 2 } |
Public Member Functions | |
virtual | ~IRtmpLocalUser () |
virtual int | setAudioStreamConfiguration (const RtmpStreamingAudioConfiguration &config, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual int | setVideoStreamConfiguration (const RtmpStreamingVideoConfiguration &config, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual int | adjustRecordingSignalVolume (int volume, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual int | getRecordingSignalVolume (int32_t *volume)=0 |
virtual int | adjustVideoBitrate (VideoBitrateAdjustType type, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual int | setVideoEnabled (bool enabled, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual int | publishAudio (agora_refptr< rtc::ILocalAudioTrack > audioTrack, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual int | unpublishAudio (agora_refptr< rtc::ILocalAudioTrack > audioTrack, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual int | publishVideo (agora_refptr< rtc::ILocalVideoTrack > videoTrack, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual int | unpublishVideo (agora_refptr< rtc::ILocalVideoTrack > videoTrack, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual int | registerRtmpUserObserver (IRtmpLocalUserObserver *observer, void(*safeDeleter)(IRtmpLocalUserObserver *)=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual int | unregisterRtmpUserObserver (IRtmpLocalUserObserver *observer)=0 |
virtual int | registerAudioFrameObserver (media::IAudioPcmFrameSink *observer, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual void | unregisterAudioFrameObserver (media::IAudioPcmFrameSink *observer)=0 |
virtual int | registerVideoFrameObserver (media::base::IVideoFrameObserver *observer, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
virtual void | unregisterVideoFrameObserver (media::base::IVideoFrameObserver *observer)=0 |
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.
|
inlinevirtual |
|
pure virtual |
Set the parameters of the audio encoder when pushing the stream
config | Audio encoder parameters |
|
pure virtual |
Set the parameters of the video encoder when pushing the stream
config | Video encoder parameters |
|
pure virtual |
Adjusts the audio volume for publishing.
volume | The volume for publishing. The value ranges between 0 and 100 (default). |
|
pure virtual |
Gets the current volume for publishing.
volume | A pointer to the publishing volume. |
|
pure virtual |
Dynamically adjust the bit rate parameters of the video encoder in the push stream
type | The type of adjustment mode for the bit-rate parameter of the video encoder in the push stream:
|
|
pure virtual |
Set whether to enable local video
enabled | Whether to enable local video:
|
|
pure virtual |
Publishes a local audio track to the RTMP connection.
audioTrack | The local audio track to be published: ILocalAudioTrack. |
|
pure virtual |
Stops publishing the local audio track to the RTMP connection.
audioTrack | The local audio track that you want to stop publishing: ILocalAudioTrack. |
|
pure virtual |
Publishes a local video track to the RTMP connection.
videoTrack | The local video track to be published: ILocalVideoTrack. |
|
pure virtual |
Stops publishing the local video track to the RTMP connection.
videoTrack | The local video track that you want to stop publishing: ILocalVideoTrack.
|
|
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.
observer | The pointer to the IRtmpLocalUserObserver object. |
|
pure virtual |
Releases the IRtmpLocalUserObserver object previously registered using registerRtmpUserObserver().
observer | The pointer to the IRtmpLocalUserObserver object that you want to release. |
|
pure virtual |
Registers an audio frame observer object.
observer | A pointer to the audio frame observer object: IAudioFrameObserver. |
|
pure virtual |
Unregisters an audio frame observer object.
observer | A pointer to the audio frame observer object: IAudioFrameObserver. |
|
pure virtual |
Registers a video frame observer object.
observer | A pointer to the video frame observer: IVideoFrameObserver. |
|
pure virtual |
Unregisters a video frame observer object.
observer | A pointer to the video frame observer: IVideoFrameObserver. |