Inherits agora::RefCountInterface.
The IRtmpStreamingService class, which enables the live stream service.
◆ ~IRtmpStreamingService()
agora::rtc::IRtmpStreamingService::~IRtmpStreamingService |
( |
| ) |
|
|
inlineprotected |
◆ addPublishStreamUrl()
virtual int agora::rtc::IRtmpStreamingService::addPublishStreamUrl |
( |
const char * |
url, |
|
|
bool |
transcodingEnabled |
|
) |
| |
|
pure virtual |
Publishes the local stream to the CDN.
This method triggers the onRtmpStreamingStateChanged
callback on the local client to report the state of adding a local stream to the CDN.
- Note
- Ensure that you enable the RTMP Converter service before using this function.
- This method applies to Live-Broadcast only.
- Ensure that the user joins a channel before calling this method.
- This method adds only one stream URL address each time it is called.
- Parameters
-
url | The CDN streaming URL in the RTMP format. The maximum length of this parameter is 1024 bytes. The URL address must not contain special character, such as Chinese language characters. |
transcodingEnabled | Sets whether transcoding is enabled/disabled. If you set this parameter as true , ensure that you call the setLiveTranscoding method before this method.
- true: Enable transcoding.
- false: Disable transcoding.
|
- Returns
- 0: Success.
- < 0: Failure.
◆ removePublishStreamUrl()
virtual int agora::rtc::IRtmpStreamingService::removePublishStreamUrl |
( |
const char * |
url | ) |
|
|
pure virtual |
Removes an RTMP stream from the CDN.
This method removes the RTMP URL address added by addPublishStreamUrl
from a CDN live stream. The SDK triggers the onRtmpStreamingStated
callback on the local client to report the state of removing an RTMP stream from the CDN.
- Note
- Ensure that you enable the RTMP Converter service before using this function.
- This method applies to Live-Broadcast only.
- This method removes only one stream URL address each time it is called.
- Parameters
-
url | The RTMP URL address to be removed. The maximum length of this parameter is 1024 bytes. The URL address must not contain special character, such as Chinese language characters. |
- Returns
- 0: Success.
- < 0: Failure.
◆ setLiveTranscoding()
virtual int agora::rtc::IRtmpStreamingService::setLiveTranscoding |
( |
const LiveTranscoding & |
transcoding | ) |
|
|
pure virtual |
Sets the video layout and audio settings for CDN live.
The SDK triggers the onTranscodingUpdated
callback when the LiveTranscoding
class is updated using this method. If you call this method to set LiveTrancoding
for the first time, the SDK does not trigger this callback.
- Note
- Ensure that you enable the RTMP Converter service before using this function.
- This method applies to Live-Broadcast only.
- Ensure that you call this method before calling addPublishStreamUrl().
◆ registerObserver()
Registers an RTMP streaming observer.
- Parameters
-
- Returns
- 0: Success.
- < 0: Failure.
◆ unregisterObserver()
Releases the RTMP streaming observer created by registerObserver().
- Parameters
-
- Returns
- 0: Success.
- < 0: Failure.