# 旁路推流 (/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## startRtmpStreamWithoutTranscoding [#startrtmpstreamwithouttranscoding]
开始非转码推流。
```cpp
virtual int startRtmpStreamWithoutTranscoding(const char* url) = 0;
```
### 详情 [#详情]
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](/zh-CN/realtime-media/media-push)。
调用该方法,你可以向指定的旁路推流地址推送直播音视频流。该方法每次只能向一个地址推送媒体流,如果你需要向多个地址转码推流,则需多次调用该方法。
调用该方法后,SDK 会在本地触发 [onRtmpStreamingStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#callback_irtcengineeventhandler_onrtmpstreamingstatechanged) 回调,报告推流的状态。
:::caution
注意:
- 请在加入频道后调用该方法。
- 只有直播场景下的主播才能调用该方法。
- 调用该方法推流失败后,如果你想要重新推流,那么请你务必先调用 [stopRtmpStream](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#api_irtcengine_stoprtmpstream),再调用该方法重推,否则 SDK 会返回与上次推流失败时一样的错误码。
:::
### 参数 [#参数]
旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
### 返回值 [#返回值]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -2:URL 或转码属性参数错误,请检查你的 URL 或参数设置。
- -7:调用该方法前,未初始化 SDK。
- -19:该旁路推流 URL 已在使用中,请使用其他旁路推流 URL。
### 所属接口类 [#所属接口类]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## startRtmpStreamWithoutTranscodingEx [#startrtmpstreamwithouttranscodingex]
开始非转码推流。
```cpp
virtual int startRtmpStreamWithoutTranscodingEx(const char* url, const RtcConnection& connection) = 0;
```
### 详情 [#详情-1]
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](/zh-CN/realtime-media/media-push)。
调用该方法,你可以向指定的旁路推流地址推送直播音视频流。该方法每次只能向一个地址推送媒体流,如果你需要向多个地址转码推流,则需多次调用该方法。
调用该方法后,SDK 会在本地触发 [onRtmpStreamingStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#callback_irtcengineeventhandler_onrtmpstreamingstatechanged) 回调,报告推流的状态。
:::caution
注意:
- 请在加入频道后调用该方法。
- 只有直播场景下的主播才能调用该方法。
- 调用该方法推流失败后,如果你想要重新推流,那么请你务必先调用 [stopRtmpStream](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#api_irtcengine_stoprtmpstream),再调用该方法重推,否则 SDK 会返回与上次推流失败时一样的错误码。
:::
### 参数 [#参数-1]
旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unreal-cpp/class-rtcconnection)。
### 返回值 [#返回值-1]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -2:URL 或转码属性参数错误,请检查你的 URL 或参数设置。
- -7:调用该方法前,未初始化 SDK。
- -19:该旁路推流 URL 已在使用中,请使用其他旁路推流 URL。
### 所属接口类 [#所属接口类-1]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineex)
## startRtmpStreamWithTranscoding [#startrtmpstreamwithtranscoding]
开始旁路推流并设置转码属性。
```cpp
virtual int startRtmpStreamWithTranscoding(const char* url, const LiveTranscoding& transcoding) = 0;
```
### 详情 [#详情-2]
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](/zh-CN/realtime-media/media-push)。
调用该方法,你可以向指定的旁路推流地址推送直播音视频流并设置转码属性。该方法每次只能向一个地址推送媒体流,如果你需要向多个地址转码推流,则需多次调用该方法。
一次推流代表一个推流任务,最大并发任务数默认为 200,表示你在一个声网项目下最多同时运行 200 个推流任务,如需更高配额,请[联系技术支持](https://ticket.shengwang.cn/)。
调用该方法后,SDK 会在本地触发 [onRtmpStreamingStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#callback_irtcengineeventhandler_onrtmpstreamingstatechanged) 回调,报告推流的状态。
:::caution
注意:
- 请在加入频道后调用该方法。
- 只有直播场景下的主播才能调用该方法。
- 调用该方法推流失败后,如果你想要重新推流,那么请你务必先调用 [stopRtmpStream](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#api_irtcengine_stoprtmpstream),再调用该方法重推,否则 SDK 会返回与上次推流失败时一样的错误码。
:::
### 参数 [#参数-2]
旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
旁路推流的转码属性,详见 [LiveTranscoding](/zh-CN/api-reference/rtc/unreal-cpp/class-livetranscoding)。
### 返回值 [#返回值-2]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -2:URL 或转码属性参数错误,请检查你的 URL 或参数设置。
- -7:调用该方法前,未初始化 SDK。
- -19:该旁路推流 URL 已在使用中,请使用其他旁路推流 URL。
### 所属接口类 [#所属接口类-2]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## startRtmpStreamWithTranscodingEx [#startrtmpstreamwithtranscodingex]
开始旁路推流并设置转码属性。
```cpp
virtual int startRtmpStreamWithTranscodingEx(const char* url, const LiveTranscoding& transcoding, const RtcConnection& connection) = 0;
```
### 详情 [#详情-3]
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](/zh-CN/realtime-media/media-push)。
调用该方法,你可以向指定的旁路推流地址推送直播音视频流并设置转码属性。该方法每次只能向一个地址推送媒体流,如果你需要向多个地址转码推流,则需多次调用该方法。
调用该方法后,SDK 会在本地触发 [onRtmpStreamingStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#callback_irtcengineeventhandler_onrtmpstreamingstatechanged) 回调,报告推流的状态。
:::caution
注意:
- 请确保已开通旁路推流服务。
- 请在加入频道后调用该方法。
- 只有直播场景下的主播才能调用该方法。
- 调用该方法推流失败后,如果你想要重新推流,那么请你务必先调用 [stopRtmpStreamEx](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#api_irtcengineex_stoprtmpstreamex),再调用该方法重推,否则 SDK 会返回与上次推流失败时一样的错误码。
:::
### 参数 [#参数-3]
旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
旁路推流的转码属性,详见 [LiveTranscoding](/zh-CN/api-reference/rtc/unreal-cpp/class-livetranscoding)。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unreal-cpp/class-rtcconnection)。
### 返回值 [#返回值-3]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -2:URL 或转码属性参数错误,请检查你的 URL 或参数设置。
- -7:调用该方法前,未初始化 SDK。
- -19:该旁路推流 URL 已在使用中,请使用其他旁路推流 URL。
### 所属接口类 [#所属接口类-3]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineex)
## stopRtmpStream [#stoprtmpstream]
结束旁路推流。
```cpp
virtual int stopRtmpStream(const char* url) = 0;
```
### 详情 [#详情-4]
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](/zh-CN/realtime-media/media-push)。
调用该方法,你可以结束指定的旁路推流地址上的直播。该方法每次只能结束一个推流地址上的直播,如果你需要结束多个推流地址的直播,则需多次调用该方法。
调用该方法后,SDK 会在本地触发 [onRtmpStreamingStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#callback_irtcengineeventhandler_onrtmpstreamingstatechanged) 回调,报告推流的状态。
### 参数 [#参数-4]
旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
### 返回值 [#返回值-4]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-4]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## stopRtmpStreamEx [#stoprtmpstreamex]
结束旁路推流。
```cpp
virtual int stopRtmpStreamEx(const char* url, const RtcConnection& connection) = 0;
```
### 详情 [#详情-5]
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](/zh-CN/realtime-media/media-push)。
调用该方法,你可以结束指定的旁路推流地址上的直播。该方法每次只能结束一个推流地址上的直播,如果你需要结束多个推流地址的直播,则需多次调用该方法。
调用该方法后,SDK 会在本地触发 [onRtmpStreamingStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#callback_irtcengineeventhandler_onrtmpstreamingstatechanged) 回调,报告推流的状态。
### 参数 [#参数-5]
旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
### 返回值 [#返回值-5]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-5]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineex)
## updateRtmpTranscoding [#updatertmptranscoding]
更新旁路推流转码属性。
```cpp
virtual int updateRtmpTranscoding(const LiveTranscoding& transcoding) = 0;
```
### 详情 [#详情-6]
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](/zh-CN/realtime-media/media-push)。
开启转码推流后,你可以根据场景需求,动态更新转码属性。转码属性更新后,SDK 会触发 [onTranscodingUpdated](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#callback_irtcengineeventhandler_ontranscodingupdated) 回调。
### 参数 [#参数-6]
旁路推流的转码属性,详见 [LiveTranscoding](/zh-CN/api-reference/rtc/unreal-cpp/class-livetranscoding)。
### 返回值 [#返回值-6]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-6]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## updateRtmpTranscodingEx [#updatertmptranscodingex]
更新旁路推流转码属性。
```cpp
virtual int updateRtmpTranscodingEx(const LiveTranscoding& transcoding, const RtcConnection& connection) = 0;
```
### 详情 [#详情-7]
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](/zh-CN/realtime-media/media-push)。
开启转码推流后,你可以根据场景需求,动态更新转码属性。转码属性更新后,SDK 会触发 [onTranscodingUpdated](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#callback_irtcengineeventhandler_ontranscodingupdated) 回调。
### 参数 [#参数-7]
旁路推流的转码属性,详见 [LiveTranscoding](/zh-CN/api-reference/rtc/unreal-cpp/class-livetranscoding)。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unreal-cpp/class-rtcconnection)。
### 返回值 [#返回值-7]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-7]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineex)
## onRtmpStreamingEvent [#onrtmpstreamingevent]
旁路推流事件回调。
```cpp
virtual void onRtmpStreamingEvent(const char* url, RTMP_STREAMING_EVENT eventCode) {
(void)url;
(void)eventCode;
}
```
### 参数 [#参数-8]
旁路推流 URL。
旁路推流事件码。详见 [RTMP_STREAMING_EVENT](/zh-CN/api-reference/rtc/unreal-cpp/enum-rtmpstreamingevent)。
### 所属接口类 [#所属接口类-8]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler)
## onRtmpStreamingStateChanged [#onrtmpstreamingstatechanged]
旁路推流状态发生改变回调。
```cpp
virtual void onRtmpStreamingStateChanged(const char* url, RTMP_STREAM_PUBLISH_STATE state,
RTMP_STREAM_PUBLISH_REASON reason) {
(void)url;
(void)state;
(void)reason;
}
```
### 详情 [#详情-8]
旁路推流状态发生改变时,SDK会触发该回调,并在回调中明确状态发生改变的 URL 地址及当前推流状态。该回调方便推流用户了解当前的推流状态;推流出错时,你可以通过返回的错误码了解出错的原因,方便排查问题。
### 参数 [#参数-9]
推流状态发生改变的 URL 地址。
当前的推流状态,详见 [RTMP_STREAM_PUBLISH_STATE](/zh-CN/api-reference/rtc/unreal-cpp/enum-rtmpstreampublishstate)。
推流状态改变的原因,详见 [RTMP_STREAM_PUBLISH_REASON](/zh-CN/api-reference/rtc/unreal-cpp/enum-rtmpstreampublishreason)。
### 所属接口类 [#所属接口类-9]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler)
## onTranscodingUpdated [#ontranscodingupdated]
旁路推流转码设置已被更新回调。
```cpp
virtual void onTranscodingUpdated()
```
### 详情 [#详情-9]
[startRtmpStreamWithTranscoding](/zh-CN/api-reference/rtc/unreal-cpp/cloud-media-relay/media-push#api_irtcengine_startrtmpstreamwithtranscoding) 方法中的直播参数 [LiveTranscoding](/zh-CN/api-reference/rtc/unreal-cpp/class-livetranscoding) 更新时,onTranscodingUpdated 回调会被触发并向主播报告更新信息。
:::caution
注意: 首次调用 startRtmpStreamWithTranscoding 方法设置转码参数 LiveTranscoding 时,不会触发此回调。
:::
### 所属接口类 [#所属接口类-10]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler)