推流
介绍跟推流相关的方法和回调。
setDirectCdnStreamingAudioConfiguration
设置主播端直接向 CDN 推流时的音频编码属性。
- (int)setDirectCdnStreamingAudioConfiguration:(AgoraAudioProfile)profile;
该方法仅对麦克风采集或自采集的音频有效,即对在 AgoraDirectCdnStreamingMediaOptions 中设置 publishMicrophoneTrack 或 publishCustomAudioTrack 为 YES
时所采集的音频有效。
参数
- profile
-
音频编码属性,包含采样率、码率、编码模式和声道数。详见 AgoraAudioProfile。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
setDirectCdnStreamingVideoConfiguration
设置主播端直接向 CDN 推流时的视频编码属性。
- (int)setDirectCdnStreamingVideoConfiguration:(AgoraVideoEncoderConfiguration * _Nonnull)config;
详情
该方法仅对摄像头采集、屏幕共享或自采集的视频有效。即对在 AgoraDirectCdnStreamingMediaOptions 中设置 publishCameraTrack 或 publishCustomVideoTrack 为 YES
时所采集的视频有效。
如果你设置的视频分辨率超出你的摄像头设备支持的范围,SDK 会根据你的设置进行自适应,取最接近、且长宽比与你设置的分辨率一致的值进行采集、编码、推流。你可以通过 onDirectCdnStreamingStats 回调了解推送的视频流的实际分辨率。
参数
- config
- 视频编码参数配置。详见 AgoraVideoEncoderConfiguration。
注: 在直接向 CDN 推流时,SDK 目前仅支持将 AgoraVideoOutputOrientationMode 设为横屏模式(AgoraVideoOutputOrientationModeFixedLandscape)或竖屏模式(AgoraVideoOutputOrientationModeFixedPortrait)。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
startDirectCdnStreaming
设置主播端开始直接向 CDN 推流。
- (int)startDirectCdnStreaming:(id<AgoraDirectCdnStreamingEventDelegate> _Nonnull)delegate publishUrl:(NSString * _Nonnull)publishUrl mediaOptions:(AgoraDirectCdnStreamingMediaOptions * _Nonnull)options;
详情
SDK 不支持同一时间向同一个 URL 重复推流。
媒体选项说明
SDK 不支持 publishCameraTrack 和 publishCustomVideoTrack 同时为 YES
,也不支持 publishMicrophoneTrack 和 publishCustomAudioTrack 同时为 YES
。你可以根据场景需求设置媒体选项 (AgoraDirectCdnStreamingMediaOptions)。示例如下:
如果你想推送主播端采集的音视频流,请将媒体选项进行如下设置:
- publishCustomAudioTrack 设为
YES
并调用 pushExternalAudioFrameSampleBuffer 或 pushExternalAudioFrameRawData - publishCustomVideoTrack 设为
YES
并调用 pushExternalVideoFrame - 确保 publishCameraTrack 为
NO
(默认值) - 确保 publishMicrophoneTrack 为
NO
(默认值)
YES
,并调用 pushExternalAudioFrameSampleBuffer 或 pushExternalAudioFrameRawData 即可推送纯音频流。
参数
- delegate
- 详见 onDirectCdnStreamingStateChanged 及 onDirectCdnStreamingStats。
- publishUrl
- CDN 推流 URL。
- options
- 主播端的媒体选项。详见 AgoraDirectCdnStreamingMediaOptions。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
startRtmpStreamWithoutTranscoding
开始非转码推流。
- (int)startRtmpStreamWithoutTranscoding:(NSString* _Nonnull)url;
详情
声网推荐你使用更加完善的服务端推流功能,详见实现服务端旁路推流。
调用该方法,你可以向指定的旁路推流地址推送直播音视频流。该方法每次只能向一个地址推送媒体流,如果你需要向多个地址转码推流,则需多次调用该方法。
调用该方法后,SDK 会在本地触发 rtmpStreamingChangedToState 回调,报告推流的状态。
- 请在加入频道后调用该方法。
- 只有直播场景下的主播才能调用该方法。
- 调用该方法推流失败后,如果你想要重新推流,那么请你务必先调用 stopRtmpStream,再调用该方法重推,否则 SDK 会返回与上次推流失败时一样的错误码。
参数
- url
- 旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -2:url 为空或为长度为 0 的字符串。
- -7:调用该方法前,未初始化 SDK。
- -19:该旁路推流 URL 已在使用中,请使用其他旁路推流 URL。
startRtmpStreamWithTranscoding
开始旁路推流并设置转码属性。
- (int)startRtmpStreamWithTranscoding:(NSString* _Nonnull)url transcoding:(AgoraLiveTranscoding* _Nullable)transcoding;
详情
声网推荐你使用更加完善的服务端推流功能,详见实现服务端旁路推流。
调用该方法,你可以向指定的旁路推流地址推送直播音视频流并设置转码属性。该方法每次只能向一个地址推送媒体流,如果你需要向多个地址转码推流,则需多次调用该方法。
一次推流代表一个推流任务,最大并发任务数默认为 200,表示你在一个声网项目下最多同时运行 200 个推流任务,如需更高配额,请联系技术支持。
调用该方法后,SDK 会在本地触发 rtmpStreamingChangedToState 回调,报告推流的状态。
- 请在加入频道后调用该方法。
- 只有直播场景下的主播才能调用该方法。
- 调用该方法推流失败后,如果你想要重新推流,那么请你务必先调用 stopRtmpStream,再调用该方法重推,否则 SDK 会返回与上次推流失败时一样的错误码。
参数
- url
- 旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
- transcoding
-
旁路推流的转码属性,详见 AgoraLiveTranscoding 类。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -2:url 为空或为长度为 0 的字符串。
- -7:调用该方法前,未初始化 SDK。
- -19:该旁路推流 URL 已在使用中,请使用其他旁路推流 URL。
stopDirectCdnStreaming
设置主播端停止直接向 CDN 推流。
- (int)stopDirectCdnStreaming;
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
stopRtmpStream
结束旁路推流。
- (int)stopRtmpStream:(NSString* _Nonnull)url;
详情
声网推荐你使用更加完善的服务端推流功能,详见实现服务端旁路推流。
调用该方法,你可以结束指定的旁路推流地址上的直播。该方法每次只能结束一个推流地址上的直播,如果你需要结束多个推流地址的直播,则需多次调用该方法。
调用该方法后,SDK 会在本地触发 rtmpStreamingChangedToState 回调,报告推流的状态。
参数
- url
- 旁路推流地址。格式为 RTMP 或 RTMPS。字符长度不能超过 1024 字节。不支持中文字符等特殊字符。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
updateLocalTranscoderConfiguration
更新本地合图配置。
- (int)updateLocalTranscoderConfiguration:(AgoraLocalTranscoderConfiguration* _Nonnull)config NS_SWIFT_NAME(updateLocalTranscoderConfiguration(_:));
详情
调用 startLocalVideoTranscoder 后,如果你希望更新本地合图配置,请调用该方法。
参数
- config
- 本地合图的配置,详见 AgoraLocalTranscoderConfiguration。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
updateRtmpTranscoding
更新旁路推流转码属性。
- (int)updateRtmpTranscoding:(AgoraLiveTranscoding* _Nullable)transcoding;
详情
声网推荐你使用更加完善的服务端推流功能,详见实现服务端旁路推流。
开启转码推流后,你可以根据场景需求,动态更新转码属性。转码属性更新后,SDK 会触发 rtcEngineTranscodingUpdated 回调。
参数
- transcoding
-
旁路推流的转码属性,详见 AgoraLiveTranscoding 类。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
onDirectCdnStreamingStateChanged
CDN 推流状态改变回调。
- (void)onDirectCdnStreamingStateChanged:(AgoraDirectCdnStreamingState)state error:(AgoraDirectCdnStreamingError)error message:(NSString *_Nullable)message;
主播端直接向 CDN 推流后,当推流状态改变时,SDK 会触发该回调向你报告新的状态、错误码和信息。你可以据此排查问题。
参数
- state
- 当前推流状态。详见 AgoraDirectCdnStreamingState。
- error
- 推流出错的原因。详见 AgoraDirectCdnStreamingError。
- message
- 状态改变对应的信息。
onDirectCdnStreamingStats
CDN 推流统计数据回调。
- (void)onDirectCdnStreamingStats:(AgoraDirectCdnStreamStats *_Nonnull)stats;
在主播直接向 CDN 推流的过程中,SDK 每隔 1 秒触发一次该回调。
参数
- stats
- 当前推流的统计数据。详见 AgoraDirectCdnStreamingStats。
rtmpStreamingEventWithUrl
旁路推流事件回调。
- (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine rtmpStreamingEventWithUrl:(NSString* _Nonnull)url eventCode:(AgoraRtmpStreamingEvent)eventCode;
参数
- url
- 旁路推流 URL。
- eventCode
- 旁路推流事件码。详见 AgoraRtmpStreamingEvent。
rtmpStreamingChangedToState
旁路推流状态发生改变回调。
- (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine rtmpStreamingChangedToState:(NSString* _Nonnull)url state:(AgoraRtmpStreamingState)state errCode:(AgoraRtmpStreamingErrorCode)errCode;
旁路推流状态发生改变时,SDK会触发该回调,并在回调中明确状态发生改变的 URL 地址及当前推流状态。该回调方便推流用户了解当前的推流状态;推流出错时,你可以通过返回的错误码了解出错的原因,方便排查问题。
参数
- engine
- AgoraRtcEngineKit 对象。
- url
-
推流状态发生改变的 URL 地址。
- state
- 当前的推流状态,详见 AgoraRtmpStreamingState。
- errCode
- 推流错误信息,详见 AgoraRtmpStreamingErrorCode。
rtcEngineTranscodingUpdated
旁路推流转码设置已被更新回调。
- (void)rtcEngineTranscodingUpdated:(AgoraRtcEngineKit * _Nonnull)engine;
setLiveTranscoding 方法中的直播参数 AgoraLiveTranscoding 更新时,rtcEngineTranscodingUpdated 回调会被触发并向主播报告更新信息。
参数
- engine
- AgoraRtcEngineKit 对象。