推流
介绍跟推流相关的方法和回调。
setDirectCdnStreamingAudioConfiguration
设置主播端直接向 CDN 推流时的音频编码属性。
public abstract int setDirectCdnStreamingAudioConfiguration(int profile);
该方法仅对麦克风采集或自采集的音频有效,即对在 DirectCdnStreamingMediaOptions 中设置 publishMicrophoneTrack 或 publishCustomAudioTrack 为 true
时所采集的音频有效。
参数
- profile
-
音频编码属性,包含采样率、码率、编码模式和声道数。
- DEFAULT (0):默认值
- 直播场景下:48 kHz 采样率,音乐编码,单声道,编码码率最大值为 64 Kbps。
- 通信场景下:32 kHz 采样率,语音编码,单声道,编码码率最大值为 18 Kbps。
- SPEECH_STANDARD (1):指定 32 kHz 采样率,语音编码,单声道,编码码率最大值为 18 Kbps。
- MUSIC_STANDARD (2):指定 48 kHz 采样率,音乐编码,单声道,编码码率最大值为 64 Kbps。
- MUSIC_STANDARD_STEREO (3):指定 48 kHz 采样率,音乐编码,双声道,编码码率最大值为 80 Kbps。
- MUSIC_HIGH_QUALITY (4):指定 48 kHz 采样率,音乐编码,单声道,编码码率最大值为 96 Kbps。
- MUSIC_HIGH_QUALITY_STEREO (5):指定 48 kHz 采样率,音乐编码,双声道,编码码率最大值为 128 Kbps。
- DEFAULT (0):默认值
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
setDirectCdnStreamingVideoConfiguration
设置主播端直接向 CDN 推流时的视频编码属性。
public abstract int setDirectCdnStreamingVideoConfiguration(VideoEncoderConfiguration config);
详情
该方法仅对摄像头采集、屏幕共享或自采集的视频有效。即对在 DirectCdnStreamingMediaOptions 中设置 publishCameraTrack 或 publishCustomVideoTrack 为 true
时所采集的视频有效。
如果你设置的视频分辨率超出你的摄像头设备支持的范围,SDK 会根据你的设置进行自适应,取最接近、且长宽比与你设置的分辨率一致的值进行采集、编码、推流。你可以通过 onDirectCdnStreamingStats 回调了解推送的视频流的实际分辨率。
参数
- config
- 视频编码参数配置。详见 VideoEncoderConfiguration。
注: 在直接向 CDN 推流时,SDK 目前仅支持将 ORIENTATION_MODE 设为横屏模式(ORIENTATION_FIXED_LANDSCAPE)或竖屏模式(ORIENTATION_FIXED_PORTRAIT)。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
setRemoteVideoSubscriptionOptions
设置远端视频流的订阅选项。
public abstract int setRemoteVideoSubscriptionOptions(int uid, VideoSubscriptionOptions options);
详情
当远端发送双流时,可调用此方法来设置远端视频流的订阅选项。
- 如果你只注册了 IVideoFrameObserver 对象,则默认订阅原始视频数据和编码后的视频数据 (效果等同于 encodedFrameOnly 设置为
false
)。 - 如果你只注册了 IVideoEncodedFrameObserver 对象,则默认只订阅编码后的视频数据 (效果等同于 encodedFrameOnly 设置为
true
)。 - 如果你先后注册了 IVideoFrameObserver 和 IVideoEncodedFrameObserver 对象,则默认订阅原始视频数据和编码后的视频数据 (效果等同于 encodedFrameOnly 设置为
false
)。 - 如果你先调用该方法设置了 options 参数、然后再注册 IVideoFrameObserver 或 IVideoEncodedFrameObserver 对象,则需要再次调用该方法并按照以上两项描述设置 options 参数,以获得预期的效果。
- 调用 joinChannel [2/2] 加入频道时设置 autoSubscribeVideo 为
false
。 - 在收到 onUserJoined 回调后调用该方法,设置对指定远端用户视频流的订阅选项。
- 调用 muteRemoteVideoStream 方法,开始恢复订阅指定远端用户的视频流。如果你在上一步中将 encodedFrameOnly 设置为
true
,SDK 会在本地触发 onEncodedVideoFrameReceived 回调,上报接收到的编码后视频帧信息。
参数
- uid
- 远端用户 ID。
- options
- 视频流的订阅设置,详见 VideoSubscriptionOptions。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
startDirectCdnStreaming
设置主播端开始直接向 CDN 推流。
public abstract int startDirectCdnStreaming(IDirectCdnStreamingEventHandler eventHandler, String publishUrl, DirectCdnStreamingMediaOptions options);
详情
SDK 不支持同一时间向同一个 URL 重复推流。
媒体选项说明
SDK 不支持 publishCameraTrack 和 publishCustomVideoTrack 同时为 true
,也不支持 publishMicrophoneTrack 和 publishCustomAudioTrack 同时为 true
。你可以根据场景需求设置媒体选项 (DirectCdnStreamingMediaOptions)。示例如下:
如果你想推送主播端采集的音视频流,请将媒体选项进行如下设置:
- publishCustomAudioTrack 设为
true
并调用 pushExternalAudioFrame - publishCustomVideoTrack 设为
true
并调用 pushExternalVideoFrame [1/2] - 确保 publishCameraTrack 为
false
(默认值) - 确保 publishMicrophoneTrack 为
false
(默认值)
true
,并调用 pushExternalAudioFrame 即可推送纯音频流。
参数
- eventHandler
- 详见 onDirectCdnStreamingStateChanged 及 onDirectCdnStreamingStats。
- publishUrl
- CDN 推流 URL。
- options
- 主播端的媒体选项。详见 DirectCdnStreamingMediaOptions。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
startRtmpStreamWithoutTranscoding
开始非转码推流。
public abstract int startRtmpStreamWithoutTranscoding(String url);
详情
声网推荐你使用更加完善的服务端推流功能,详见实现服务端旁路推流。
调用该方法,你可以向指定的旁路推流地址推送直播音视频流。该方法每次只能向一个地址推送媒体流,如果你需要向多个地址转码推流,则需多次调用该方法。
调用该方法后,SDK 会在本地触发 onRtmpStreamingStateChanged 回调,报告推流的状态。
- 请在加入频道后调用该方法。
- 只有直播场景下的主播才能调用该方法。
- 调用该方法推流失败后,如果你想要重新推流,那么请你务必先调用 stopRtmpStream,再调用该方法重推,否则 SDK 会返回与上次推流失败时一样的错误码。
参数
- url
- 旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -2:url 为空或为长度为 0 的字符串。
- -7:调用该方法前,未初始化 SDK。
- -19:该旁路推流 URL 已在使用中,请使用其他旁路推流 URL。
startRtmpStreamWithTranscoding
开始旁路推流并设置转码属性。
public abstract int startRtmpStreamWithTranscoding(String url, LiveTranscoding transcoding);
详情
声网推荐你使用更加完善的服务端推流功能,详见实现服务端旁路推流。
调用该方法,你可以向指定的旁路推流地址推送直播音视频流并设置转码属性。该方法每次只能向一个地址推送媒体流,如果你需要向多个地址转码推流,则需多次调用该方法。
一次推流代表一个推流任务,最大并发任务数默认为 200,表示你在一个声网项目下最多同时运行 200 个推流任务,如需更高配额,请联系技术支持。
调用该方法后,SDK 会在本地触发 onRtmpStreamingStateChanged 回调,报告推流的状态。
- 请在加入频道后调用该方法。
- 只有直播场景下的主播才能调用该方法。
- 调用该方法推流失败后,如果你想要重新推流,那么请你务必先调用 stopRtmpStream,再调用该方法重推,否则 SDK 会返回与上次推流失败时一样的错误码。
参数
- url
- 旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
- transcoding
-
旁路推流的转码属性,详见 LiveTranscoding 类。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -2:url 为空或为长度为 0 的字符串。
- -7:调用该方法前,未初始化 SDK。
- -19:该旁路推流 URL 已在使用中,请使用其他旁路推流 URL。
stopDirectCdnStreaming
设置主播端停止直接向 CDN 推流。
public abstract int stopDirectCdnStreaming();
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
stopRtmpStream
结束旁路推流。
public abstract int stopRtmpStream(String url);
详情
声网推荐你使用更加完善的服务端推流功能,详见实现服务端旁路推流。
调用该方法,你可以结束指定的旁路推流地址上的直播。该方法每次只能结束一个推流地址上的直播,如果你需要结束多个推流地址的直播,则需多次调用该方法。
调用该方法后,SDK 会在本地触发 onRtmpStreamingStateChanged 回调,报告推流的状态。
参数
- url
- 旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
onDirectCdnStreamingStateChanged
CDN 推流状态改变回调。
void onDirectCdnStreamingStateChanged( DirectCdnStreamingState state, DirectCdnStreamingError error, String message);
主播端直接向 CDN 推流后,当推流状态改变时,SDK 会触发该回调向你报告新的状态、错误码和信息。你可以据此排查问题。
参数
- state
- 当前推流状态。详见 DirectCdnStreamingState。
- error
- 推流出错的原因。详见 DirectCdnStreamingError。
- message
- 状态改变对应的信息。
onDirectCdnStreamingStats
CDN 推流统计数据回调。
void onDirectCdnStreamingStats(DirectCdnStreamingStats stats);
在主播直接向 CDN 推流的过程中,SDK 每隔 1 秒触发一次该回调。
参数
- stats
- 当前推流的统计数据。详见 DirectCdnStreamingStats。
onRtmpStreamingEvent
旁路推流事件回调。
public void onRtmpStreamingEvent(String url, int event) {}
参数
- url
- 旁路推流 URL。
- event
- 旁路推流事件码。
- RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE (1): 旁路推流时,添加背景图或水印出错。
- RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE (2): 该推流 URL 已用于推流。如果你想开始新的推流,请使用新的推流 URL。
- RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT (3): 功能不支持。
- RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN (4): 预留参数。
onRtmpStreamingStateChanged
旁路推流状态发生改变回调。
public void onRtmpStreamingStateChanged(String url, int state, int errCode) {}
旁路推流状态发生改变时,SDK会触发该回调,并在回调中明确状态发生改变的 URL 地址及当前推流状态。该回调方便推流用户了解当前的推流状态;推流出错时,你可以通过返回的错误码了解出错的原因,方便排查问题。
参数
- url
-
推流状态发生改变的 URL 地址。
- state
- 当前的推流状态:
- RTMP_STREAM_PUBLISH_STATE_IDLE (0):推流未开始或已结束。
- RTMP_STREAM_PUBLISH_STATE_CONNECTING (1):正在连接声网推流服务器和 CDN 服务器。
- RTMP_STREAM_PUBLISH_STATE_RUNNING (2):推流正在进行。成功推流后,会返回该状态。
- RTMP_STREAM_PUBLISH_STATE_RECOVERING (3):正在恢复推流。当 CDN 出现异常,或推流短暂中断时,SDK 会自动尝试恢复推流,并返回该状态。
- 如成功恢复推流,则进入状态 RTMP_STREAM_PUBLISH_STATE_RUNNING(2)。
- 如服务器出错或 60 秒内未成功恢复,则进入状态 RTMP_STREAM_PUBLISH_STATE_FAILURE(4)。如果觉得 60 秒太长,也可以主动调用 startRtmpStreamWithTranscoding/startRtmpStreamWithoutTranscoding 和 stopRtmpStream 方法尝试重连。
- RTMP_STREAM_PUBLISH_STATE_FAILURE (4):推流失败。失败后,你可以通过返回的错误码排查错误原因,也可以重新尝试推流。
- RTMP_STREAM_PUBLISH_STATE_DISCONNECTING (5):SDK 正在与声网推流服务器和 CDN 服务器断开连接。当你调用 stopRtmpStream 方法正常结束推流时,SDK 会依次报告推流状态为 RTMP_STREAM_PUBLISH_STATE_DISCONNECTING、RTMP_STREAM_PUBLISH_STATE_IDLE。
- errCode
- 推流错误信息。
- RTMP_STREAM_PUBLISH_ERROR_OK (0):推流成功。
- RTMP_STREAM_PUBLISH_ERROR_INVALID_ARGUMENT (1):参数无效。请检查输入参数是否正确。
- RTMP_STREAM_PUBLISH_ERROR_ENCRYPTED_STREAM_NOT_ALLOWED (2):推流已加密,不能推流。
- RTMP_STREAM_PUBLISH_ERROR_CONNECTION_TIMEOUT (3):推流超时未成功。可尝试重新推流。
- RTMP_STREAM_PUBLISH_ERROR_INTERNAL_SERVER_ERROR (4):推流服务器出现错误。请尝试重新推流。
- RTMP_STREAM_PUBLISH_ERROR_RTMP_SERVER_ERROR (5):CDN 服务器出现错误。
- RTMP_STREAM_PUBLISH_ERROR_TOO_OFTEN (6):预留参数。
- RTMP_STREAM_PUBLISH_ERROR_REACH_LIMIT (7):单个主播的推流地址数目达到上限 10。请先停止对一些非必要地址的推流。
- RTMP_STREAM_PUBLISH_ERROR_NOT_AUTHORIZED (8):主播操作不属于自己的流。例如更新其他主播的流参数、停止其他主播的流。请检查 App 逻辑。
- RTMP_STREAM_PUBLISH_ERROR_STREAM_NOT_FOUND (9):服务器未找到这个流。
- RTMP_STREAM_PUBLISH_ERROR_FORMAT_NOT_SUPPORTED (10):推流地址格式有错误。请检查推流地址格式是否正确。
- RTMP_STREAM_PUBLISH_ERROR_NOT_BROADCASTER (11):用户角色不是主播,该用户无法使用推流功能。请检查你的应用代码逻辑。
- RTMP_STREAM_PUBLISH_ERROR_TRANSCODING_NO_MIX_STREAM (13):非转码推流情况下,调用了 updateRtmpTranscoding 或 setLiveTranscoding 方法更新转码属性。请检查你的应用代码逻辑。
- RTMP_STREAM_PUBLISH_ERROR_NET_DOWN (14):主播的网络出错。
- RTMP_STREAM_PUBLISH_ERROR_INVALID_PRIVILEGE (16):你的项目没有使用声网推流服务的权限。请参考旁路推流中的前提条件开启推流服务。
- RTMP_STREAM_UNPUBLISH_ERROR_OK (100):推流已正常结束。当你调用 stopRtmpStream 结束推流后,SDK 会返回该值。
onTranscodingUpdated
旁路推流转码设置已被更新回调。
public void onTranscodingUpdated() {}
setLiveTranscoding 方法中的直播参数 LiveTranscoding 更新时,onTranscodingUpdated 回调会被触发并向主播报告更新信息。