旁路推流

startRtmpStreamWithoutTranscoding

开始非转码推流。

TypeScript

abstract startRtmpStreamWithoutTranscoding(url: string): number;

详情

声网推荐你使用更加完善的服务端推流功能，详见实现服务端旁路推流。

调用该方法，你可以向指定的旁路推流地址推送直播音视频流。该方法每次只能向一个地址推送媒体流，如果你需要向多个地址转码推流，则需多次调用该方法。

调用该方法后，SDK 会在本地触发 onRtmpStreamingStateChanged 回调，报告推流的状态。

注意

• 请在加入频道后调用该方法。
• 只有直播场景下的主播才能调用该方法。
• 调用该方法推流失败后，如果你想要重新推流，那么请你务必先调用 stopRtmpStream，再调用该方法重推，否则 SDK 会返回与上次推流失败时一样的错误码。

参数

url

旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。
  • -2：URL 或转码属性参数错误，请检查你的 URL 或参数设置。
  • -7：调用该方法前，未初始化 SDK。
  • -19：该旁路推流 URL 已在使用中，请使用其他旁路推流 URL。

所属接口类

• IRtcEngine

startRtmpStreamWithoutTranscodingEx

开始非转码推流。

TypeScript

abstract startRtmpStreamWithoutTranscodingEx(
    url: string,
    connection: RtcConnection
  ): number;

详情

声网推荐你使用更加完善的服务端推流功能，详见实现服务端旁路推流。

调用该方法，你可以向指定的旁路推流地址推送直播音视频流。该方法每次只能向一个地址推送媒体流，如果你需要向多个地址转码推流，则需多次调用该方法。

调用该方法后，SDK 会在本地触发 onRtmpStreamingStateChanged 回调，报告推流的状态。

注意

• 请在加入频道后调用该方法。
• 只有直播场景下的主播才能调用该方法。
• 调用该方法推流失败后，如果你想要重新推流，那么请你务必先调用 stopRtmpStream，再调用该方法重推，否则 SDK 会返回与上次推流失败时一样的错误码。

参数

url

旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。

connection

Connection 信息。详见 RtcConnection。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。
  • -2：URL 或转码属性参数错误，请检查你的 URL 或参数设置。
  • -7：调用该方法前，未初始化 SDK。
  • -19：该旁路推流 URL 已在使用中，请使用其他旁路推流 URL。

所属接口类

• IRtcEngineEx

startRtmpStreamWithTranscoding

开始旁路推流并设置转码属性。

TypeScript

abstract startRtmpStreamWithTranscoding(
    url: string,
    transcoding: LiveTranscoding
  ): number;

详情

声网推荐你使用更加完善的服务端推流功能，详见实现服务端旁路推流。

调用该方法，你可以向指定的旁路推流地址推送直播音视频流并设置转码属性。该方法每次只能向一个地址推送媒体流，如果你需要向多个地址转码推流，则需多次调用该方法。

一次推流代表一个推流任务，最大并发任务数默认为 200，表示你在一个声网项目下最多同时运行 200 个推流任务，如需更高配额，请联系技术支持。

调用该方法后，SDK 会在本地触发 onRtmpStreamingStateChanged 回调，报告推流的状态。

注意

• 请在加入频道后调用该方法。
• 只有直播场景下的主播才能调用该方法。
• 调用该方法推流失败后，如果你想要重新推流，那么请你务必先调用 stopRtmpStream，再调用该方法重推，否则 SDK 会返回与上次推流失败时一样的错误码。

参数

url

旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。

transcoding

旁路推流的转码属性，详见 LiveTranscoding。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。
  • -2：URL 或转码属性参数错误，请检查你的 URL 或参数设置。
  • -7：调用该方法前，未初始化 SDK。
  • -19：该旁路推流 URL 已在使用中，请使用其他旁路推流 URL。

所属接口类

• IRtcEngine

startRtmpStreamWithTranscodingEx

开始旁路推流并设置转码属性。

TypeScript

abstract startRtmpStreamWithTranscodingEx(
    url: string,
    transcoding: LiveTranscoding,
    connection: RtcConnection
  ): number;

详情

声网推荐你使用更加完善的服务端推流功能，详见实现服务端旁路推流。

调用该方法，你可以向指定的旁路推流地址推送直播音视频流并设置转码属性。该方法每次只能向一个地址推送媒体流，如果你需要向多个地址转码推流，则需多次调用该方法。

调用该方法后，SDK 会在本地触发 onRtmpStreamingStateChanged 回调，报告推流的状态。

注意

• 请确保已开通旁路推流服务。
• 请在加入频道后调用该方法。
• 只有直播场景下的主播才能调用该方法。
• 调用该方法推流失败后，如果你想要重新推流，那么请你务必先调用 stopRtmpStreamEx，再调用该方法重推，否则 SDK 会返回与上次推流失败时一样的错误码。

参数

url

旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。

transcoding

旁路推流的转码属性，详见 LiveTranscoding。

connection

Connection 信息。详见 RtcConnection。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。
  • -2：URL 或转码属性参数错误，请检查你的 URL 或参数设置。
  • -7：调用该方法前，未初始化 SDK。
  • -19：该旁路推流 URL 已在使用中，请使用其他旁路推流 URL。

所属接口类

• IRtcEngineEx

stopRtmpStream

结束旁路推流。

TypeScript

abstract stopRtmpStream(url: string): number;

详情

声网推荐你使用更加完善的服务端推流功能，详见实现服务端旁路推流。

调用该方法，你可以结束指定的旁路推流地址上的直播。该方法每次只能结束一个推流地址上的直播，如果你需要结束多个推流地址的直播，则需多次调用该方法。

调用该方法后，SDK 会在本地触发 onRtmpStreamingStateChanged 回调，报告推流的状态。

参数

url

旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IRtcEngine

stopRtmpStreamEx

结束旁路推流。

TypeScript

abstract stopRtmpStreamEx(url: string, connection: RtcConnection): number;

详情

声网推荐你使用更加完善的服务端推流功能，详见实现服务端旁路推流。

调用该方法，你可以结束指定的旁路推流地址上的直播。该方法每次只能结束一个推流地址上的直播，如果你需要结束多个推流地址的直播，则需多次调用该方法。

调用该方法后，SDK 会在本地触发 onRtmpStreamingStateChanged 回调，报告推流的状态。

参数

url

旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IRtcEngineEx

updateRtmpTranscoding

更新旁路推流转码属性。

TypeScript

abstract updateRtmpTranscoding(transcoding: LiveTranscoding): number;

详情

声网推荐你使用更加完善的服务端推流功能，详见实现服务端旁路推流。

开启转码推流后，你可以根据场景需求，动态更新转码属性。转码属性更新后，SDK 会触发 onTranscodingUpdated 回调。

参数

transcoding

旁路推流的转码属性，详见 LiveTranscoding。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IRtcEngine

updateRtmpTranscodingEx

更新旁路推流转码属性。

TypeScript

abstract updateRtmpTranscodingEx(
    transcoding: LiveTranscoding,
    connection: RtcConnection
  ): number;

详情

声网推荐你使用更加完善的服务端推流功能，详见实现服务端旁路推流。

开启转码推流后，你可以根据场景需求，动态更新转码属性。转码属性更新后，SDK 会触发 onTranscodingUpdated 回调。

参数

transcoding

旁路推流的转码属性，详见 LiveTranscoding。

connection

Connection 信息。详见 RtcConnection。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IRtcEngineEx

onRtmpStreamingEvent

旁路推流事件回调。

TypeScript

  onRtmpStreamingEvent?(url: string, eventCode: RtmpStreamingEvent): void;

参数

url

旁路推流 URL。

eventCode

旁路推流事件码。详见 RtmpStreamingEvent。

所属接口类

• IRtcEngineEventHandler

onRtmpStreamingStateChanged

旁路推流状态发生改变回调。

TypeScript

  onRtmpStreamingStateChanged?(
    url: string,
    state: RtmpStreamPublishState,
    reason: RtmpStreamPublishReason
  ): void;

详情

旁路推流状态发生改变时，SDK会触发该回调，并在回调中明确状态发生改变的 URL 地址及当前推流状态。该回调方便推流用户了解当前的推流状态；推流出错时，你可以通过返回的错误码了解出错的原因，方便排查问题。

参数

url

推流状态发生改变的 URL 地址。

state

当前的推流状态，详见 RtmpStreamPublishState。

reason

推流状态改变的原因，详见 RtmpStreamPublishReason。

所属接口类

• IRtcEngineEventHandler

onTranscodingUpdated

旁路推流转码设置已被更新回调。

TypeScript

  onTranscodingUpdated?(): void;

详情

startRtmpStreamWithTranscoding 方法中的直播参数 LiveTranscoding 更新时，onTranscodingUpdated 回调会被触发并向主播报告更新信息。

注意

首次调用 startRtmpStreamWithTranscoding 方法设置转码参数 LiveTranscoding 时，不会触发此回调。

所属接口类

• IRtcEngineEventHandler