typedef NS_ENUM(NSInteger, ByteRTCAudioScenarioType)
objectivec

音频场景类型。
选择音频场景后，SDK 会自动根据客户端音频采集播放设备和状态，适用通话音量/媒体音量。
如果以下音频场景类型无法满足你的业务需要，请联系技术支持人员。

typedef NS_ENUM(NSInteger, ByteRTCVoiceChangerType)
objectivec

变声特效类型

typedef NS_ENUM(NSInteger, ByteRTCVoiceReverbType)
objectivec

混响特效类型

typedef NS_ENUM(NSInteger, ByteRTCAudioProfileType)
objectivec

音质档位

typedef NS_ENUM(NSInteger, ByteRTCAudioDeviceType)
objectivec

当前音频设备类型

typedef NS_ENUM(NSInteger, ByteRTCAudioSampleRate)
objectivec

音频采样率，单位为 Hz。

typedef NS_ENUM(NSInteger, ByteRTCAudioChannel)
objectivec

音频声道。

typedef NS_ENUM(NSInteger, ByteRTCAACProfile)
objectivec

AAC 编码类型。

typedef NS_ENUM(NSInteger, ByteRTCAudioRoute)
objectivec

音频播放路由

typedef NS_ENUM(NSInteger, ByteRTCAudioPlaybackDevice)
objectivec

音频播放设备

音频设备变化时 SDK 通过 rtcEngine:onAudioPlaybackDeviceChanged: 回调当前音频播放设备。

typedef NS_ENUM(NSInteger, ByteRTCASRAuthorizationType)
objectivec

语音识别服务鉴权方式，详情请咨询语音识别服务相关人员

typedef NS_ENUM(NSInteger, ByteRTCASRErrorCode)
objectivec

语音识别服务错误码。

除网络原因导致的错误，语音识别服务内部会自行重试之外，其他错误都会停止服务，此时建议再次调用 startASR:handler: 重启语音识别功能。

typedef NS_ENUM(NSInteger, ByteRTCAudioMixingType)
objectivec

混音播放类型

typedef NS_ENUM(NSInteger, ByteRTCAudioMixingDualMonoMode)
objectivec

混音播放声道类型

typedef NS_ENUM(NSInteger, ByteRTCAudioMixingState)
objectivec

音频混音文件播放状态。

typedef NS_ENUM(NSInteger, ByteRTCAudioMixingError)
objectivec

混音错误码。

typedef NS_ENUM(NSInteger, ByteRTCAudioSourceType)
objectivec

音频输入源类型

typedef NS_ENUM(NSInteger, ByteRTCAudioRenderType)
objectivec

音频输出源类型

typedef NS_ENUM(NSInteger, ByteRTCAudioFrameCallbackMethod)
objectivec

音频回调方法

typedef NS_ENUM(NSInteger, ByteRTCAudioFrameMethod)
objectivec

返回给音频处理器的音频类型。

typedef NS_ENUM(NSInteger, ByteRTCAudioReportMode)
objectivec

音量回调配置模式

typedef NS_ENUM(NSInteger, ByteRTCAudioPropertiesMode)
objectivec

音频信息提示中是否包含本地混音音频数据。

@interface ByteRTCAudioVolumeInfo : NSObject
objectivec

音频流来源的用户 ID, 及对应的音量。

@property(copy, nonatomic) NSString * _Nonnull uid;
objectivec

音频流来源的用户 ID

@property(assign, nonatomic) NSUInteger linearVolume;
objectivec

线性音量，取值范围为：[0,255]

@property(assign, nonatomic) NSUInteger nonlinearVolume;
objectivec

非线性音量，取值范围为：[-127,0]

@interface ByteRTCAudioFormat : NSObject
objectivec

音频参数格式

@property(nonatomic, assign) ByteRTCAudioSampleRate sampleRate;
objectivec

音频采样率，详见 ByteRTCAudioSampleRate

@property(nonatomic, assign) ByteRTCAudioChannel channel;
objectivec

音频声道，详见 ByteRTCAudioChannel

@interface ByteRTCAudioFrame : NSObject
objectivec

PCM 音频帧

@property(strong, nonatomic) NSData * _Nonnull buffer;
objectivec

PCM 数据

@property(assign, nonatomic) int samples;
objectivec

采样点个数

@property(assign, nonatomic) ByteRTCAudioChannel channel;
objectivec

音频声道，参看 ByteRTCAudioChannel。
双声道的情况下，左右声道的音频帧数据以 LRLRLR 形式排布。

@property(assign, nonatomic) ByteRTCAudioSampleRate sampleRate;
objectivec

采样率，参看 ByteRTCAudioSampleRate。

@interface ByteRTCASRConfig : NSObject
objectivec

使用自动语音识别服务所需校验信息

@property(copy, nonatomic) NSString *_Nonnull appId;
objectivec

应用 ID

@property(copy, nonatomic) NSString *_Nonnull userId;
objectivec

用户 ID

@property(copy, nonatomic) NSString *_Nonnull accessToken;
objectivec

访问令牌

@property(copy, nonatomic) NSString *_Nonnull secretKey;
objectivec

私钥。Signature 鉴权模式下不能为空，token 鉴权模式下为空。参看关于鉴权

@property(copy, nonatomic) NSString *_Nonnull cluster;
objectivec

场景信息，参看业务集群

@property(assign, nonatomic) ByteRTCASRAuthorizationType authorizationType;
objectivec

鉴权模式，参看 ByteRTCASRAuthorizationType

@protocol ByteRTCASREngineEventHandler<NSObject>
objectivec

语音识别服务使用状态回调

- (void)onSuccess;
objectivec

语音识别服务开启成功回调

- (void)onMessage:(NSString *_Nonnull)message;
objectivec

语音转文字成功回调，该回调返回识别后的全量消息。

传入参数

注意
若识别过程中发生了网络连接中断，则重连后回调的信息中只包含重连后识别的文字消息，不再包含上一次连接后识别的消息。

- (void)onError:(NSInteger)errorCode withErrorMessage:(NSString *_Nonnull)errorMessage;
objectivec

当语音识别服务内部发生错误事件时触发该回调。

传入参数

@interface ByteRTCAudioMixingConfig : NSObject
objectivec

混音配置

@property(assign, nonatomic) ByteRTCAudioMixingType type;
objectivec

混音播放类型，详见 ByteRTCAudioMixingType

@property(assign, nonatomic) NSInteger playCount;
objectivec

混音播放次数

• play_count <= 0: 无限循环
  
• play_count == 1: 播放一次（默认）
  
• play_count > 1: 播放 play_count 次

@property(assign, nonatomic) NSInteger position;
objectivec

混音时音频文件播放进度条位置，参数为整数，单位为毫秒

@property(assign, nonatomic) NSInteger callbackOnProgressInterval;
objectivec

设置音频文件播放进度回调的时间间隔，参数为为大于 0 的 10 的倍数，单位为毫秒，设置后 SDK 将按照设置的值触发 rtcEngine:onAudioMixingPlayingProgress:progress: 回调，默认不回调。

• 当传入的值不能被 10 整除时，则默认向上取整 10，如设为 52ms 时会默认调整为 60ms。
  
• 当传入的值小于等于 0 时，不会触发进度回调。
  

@interface ByteRTCAudioPropertiesConfig : NSObject
objectivec

音频属性信息提示的相关配置。

@property(assign, nonatomic) NSInteger interval;
objectivec

信息提示间隔，单位：ms

• <= 0: 关闭信息提示
  
• (0,100]: 开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms
  
• > 100: 开启信息提示，并将信息提示间隔设置为此值
  

@property(assign, nonatomic) BOOL enable_spectrum;
objectivec

是否开启音频频谱检测。

@property(assign, nonatomic) BOOL enable_vad;
objectivec

是否开启人声检测 (VAD)。

@property(assign, nonatomic) ByteRTCAudioReportMode local_main_report_mode;
objectivec

音量回调模式。详见 ByteRTCAudioReportMode。

@property(assign, nonatomic) ByteRTCAudioPropertiesMode audio_report_mode;
objectivec

设置 rtcEngine:onLocalAudioPropertiesReport: 回调中是否包含本地混音音频数据。参看 ByteRTCAudioPropertiesMode。

默认仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据。

@interface ByteRTCAudioPropertiesInfo : NSObject
objectivec

音频属性信息

@property(assign, nonatomic) NSInteger linearVolume;
objectivec

线性音量，与原始音量呈线性关系，数值越大，音量越大。取值范围是：[0,255]。

• [0, 25]: 无声
  
• [26, 75]: 低音量
  
• [76, 204]: 中音量
  
• [205, 255]: 高音量
  

@property(assign, nonatomic) NSInteger nonlinearVolume;
objectivec

非线性音量。由原始音量的对数值转化而来，因此在中低音量时更灵敏，可以用作 Active Speaker（房间内最活跃用户）的识别。取值范围是：[-127，0]，单位 dB。

• [-127, -60]: 无声
  
• [-59, -40]: 低音量
  
• [-39, -20]: 中音量
  
• [-19, 0]: 高音量
  

@property(assign, nonatomic) NSInteger vad;
objectivec

人声检测（VAD）结果

• 1: 检测到人声。
  
• 0: 未检测到人声。
  
• -1: 未开启 VAD。
  

@property(copy, nonatomic) NSArray<NSNumber*> * _Nonnull spectrum;
objectivec

频谱数组。默认长度为 257。

@interface ByteRTCLocalAudioPropertiesInfo : NSObject
objectivec

本地音频属性信息

@property(assign, nonatomic) ByteRTCStreamIndex streamIndex;
objectivec

流属性，包括主流、屏幕流。参看 ByteRTCStreamIndex

@property(strong, nonatomic) ByteRTCAudioPropertiesInfo *_Nonnull audioPropertiesInfo;
objectivec

音频属性信息，详见 ByteRTCAudioPropertiesInfo

@interface ByteRTCRemoteAudioPropertiesInfo : NSObject
objectivec

远端音频属性信息

@property(strong, nonatomic) ByteRTCRemoteStreamKey *_Nonnull streamKey;
objectivec

远端流信息，详见 ByteRTCRemoteStreamKey

@property(strong, nonatomic) ByteRTCAudioPropertiesInfo *_Nonnull audioPropertiesInfo;
objectivec

音频属性信息，详见 ByteRTCAudioPropertiesInfo

@interface Position : NSObject
objectivec

本地用户在房间内的位置坐标，需自行建立空间直角坐标系

@property(nonatomic, assign) int x;
objectivec

x 坐标

@property(nonatomic, assign) int y;
objectivec

y 坐标

@property(nonatomic, assign) int z;
objectivec

z 坐标

typedef NS_ENUM(NSInteger, ByteRTCMulDimSingScoringMode)
objectivec

K 歌打分维度。

@interface ByteRTCSingScoringRealtimeInfo : NSObject
objectivec

实时评分信息。

@property(nonatomic, assign) int currentPosition;
objectivec

当前的播放进度。

@property(nonatomic, assign) int userPitch;
objectivec

演唱者的音高。

@property(nonatomic, assign) int standardPitch;
objectivec

标准音高。

@property(nonatomic, assign) int sentenceIndex;
objectivec

歌词分句索引。

@property(nonatomic, assign) int sentenceScore;
objectivec

上一句歌词的评分。

@property(nonatomic, assign) int totalScore;
objectivec

当前演唱的累计分数。

@property(nonatomic, assign) int averageScore;
objectivec

当前演唱的平均分数。

@interface ByteRTCStandardPitchInfo : NSObject
objectivec

标准音高数据组。

@property(nonatomic, assign) int startTime;
objectivec

开始时间，单位 ms。

@property(nonatomic, assign) int duration;
objectivec

持续时间，单位 ms。

@property(nonatomic, assign) int pitch;
objectivec

音高。

@interface ByteRTCSingScoringConfig : NSObject
objectivec

K 歌评分配置。

@property(nonatomic, assign) ByteRTCMulDimSingScoringMode mode;
objectivec

打分维度，详见 ByteRTCMulDimSingScoringMode。

@property(nonatomic, assign) ByteRTCAudioSampleRate sampleRate;
objectivec

音频采样率。仅支持 44100 Hz、48000 Hz。

@property(nonatomic, copy) NSString *_Nonnull lyricsFilepath;
objectivec

歌词文件路径。打分功能仅支持 KRC 歌词文件。

@property(nonatomic, copy) NSString *_Nonnull midiFilepath;
objectivec

歌曲 midi 文件路径。

typedef NS_ENUM(NSUInteger, ByteRTCUserOfflineReason)
objectivec

远端用户离开房间的原因。

typedef NS_ENUM(NSInteger, ByteRTCStreamRemoveReason)
objectivec

房间内远端流移除原因。

typedef NS_ENUM(NSInteger, ByteRTCRoomProfile)
objectivec

房间模式

根据所需场景，选择合适的房间模式，应用不同的音视频算法、视频参数和网络配置

调用 setAudioProfile 改变音频参数配置

typedef NS_ENUM(NSInteger, ByteRTCConnectionState)
objectivec

SDK 与信令服务器连接状态。

typedef NS_ENUM(NSInteger, ByteRTCNetworkType)
objectivec

SDK 网络连接类型。

typedef NS_ENUM(NSUInteger, ByteRTCNetworkDetectionStopReason)
objectivec

通话前探测的停止原因
rtcEngine:onNetworkDetectionStopped: 回调的参数类型

typedef NS_ENUM(NSUInteger, ByteRTCNetworkDetectionLinkType)
objectivec

通话前探测链接的类型
rtcEngine:onNetworkDetectionResult:quality:rtt:lostRate:bitrate:jitter: 回调的参数类型

typedef NS_ENUM(NSUInteger, ByteRTCNetworkQuality)
objectivec

媒体流网络质量。

typedef NS_ENUM(NSInteger, ByteRTCSubscribeState)
objectivec

订阅媒体流状态

typedef NS_ENUM(NSInteger, ByteRTCPerformanceAlarmReason)
objectivec

性能相关告警的原因

typedef NS_ENUM(NSInteger, ByteRTCPerformanceAlarmMode)
objectivec

性能回退的模式

typedef NS_ENUM(NSInteger, ByteRTCMessageConfig)
objectivec

发送消息的可靠有序类型

typedef NS_ENUM(NSInteger, ByteRTCUserMessageSendResult)
objectivec

发送消息结果，成功或失败，及失败原因

typedef NS_ENUM(NSInteger, ByteRTCUserOnlineStatus)
objectivec

用户在线状态

typedef NS_ENUM(NSInteger, ByteRTCRoomMessageSendResult)
objectivec

房间内广播消息发送结果

typedef NS_ENUM(NSUInteger, ByteRTCPublishFallbackOption)
objectivec

发布端音视频流回退选项

typedef NS_ENUM(NSUInteger, ByteRTCSubscribeFallbackOption)
objectivec

订阅端音视频流回退选项。

typedef NS_ENUM(NSUInteger, ByteRTCRemoteUserPriority)
objectivec

远端用户优先级。在性能不足需要回退时，会先回退优先级低的用户的音视频流

typedef NS_ENUM(NSInteger, ByteRTCFallbackOrRecoverReason)
objectivec

本地用户订阅的远端流触发回退策略的原因。

typedef NS_ENUM(NSInteger, ByteRTCLocalAudioStreamState)
objectivec

本地音频流状态。

SDK 通过 onLocalAudioStateChanged 回调该状态。

typedef NS_ENUM(NSInteger, ByteRTCLocalAudioStreamError)
objectivec

本地音频流状态改变时的错误码。
SDK 通过 onLocalAudioStateChanged 回调该错误码。

typedef NS_ENUM(NSInteger, ByteRTCLocalVideoStreamState)
objectivec

本地视频流状态

typedef NS_ENUM(NSInteger, ByteRTCLocalVideoStreamError)
objectivec

本地视频状态改变时的错误码

typedef NS_ENUM(NSInteger, ByteRTCRemoteAudioState)
objectivec

用户订阅的远端音频流状态。

SDK 通过 onRemoteAudioStateChanged 回调该状态。

typedef NS_ENUM(NSInteger, ByteRTCRemoteAudioStateChangeReason)
objectivec

接收远端音频流状态改变的原因。

用户可以通过 onRemoteAudioStateChanged 了解该状态。

typedef NS_ENUM(NSInteger, ByteRTCRemoteVideoState)
objectivec

远端视频流状态

typedef NS_ENUM(NSInteger, ByteRTCRemoteVideoStateChangeReason)
objectivec

远端视频流状态改变的原因

typedef NS_ENUM(NSInteger, ByteRTCMediaDeviceState)
objectivec

媒体设备状态

通过 rtcEngine:onAudioDeviceStateChanged:device_type:device_state:device_error: 或 rtcEngine:onVideoDeviceStateChanged:device_type:device_state:device_error: 回调设备状态。

typedef NS_ENUM(NSInteger, ByteRTCMediaDeviceError)
objectivec

媒体设备错误类型

typedef NS_ENUM(NSInteger, ByteRTCMediaDeviceWarning)
objectivec

媒体设备警告

typedef NS_OPTIONS(NSUInteger, ByteRTCProblemFeedbackOption)
objectivec

音视频质量反馈问题类型

@interface ByteRTCProblemOption: NSObject
objectivec

通话质量反馈预设问题列表

@property(nonatomic, assign, readonly) ByteRTCProblemFeedbackOption option;
objectivec

读取音视频质量反馈问题类型，参看 ByteRTCProblemFeedbackOption。

@property(nonatomic, copy, readonly) NSString * _Nonnull desc;
objectivec

读取 ByteRTCProblemOption 类对应的文字描述

- (instancetype _Nonnull)initWithOption:(ByteRTCProblemFeedbackOption)option;
objectivec

初始化 ByteRTCProblemOption

typedef NS_ENUM(NSUInteger, ByteRTCFirstFrameSendState)
objectivec

首帧发送状态

typedef NS_ENUM(NSUInteger, ByteRTCFirstFramePlayState)
objectivec

首帧播放状态

typedef NS_OPTIONS(NSUInteger, ByteRTCEncryptType)
objectivec

自定义加密类型

typedef NS_ENUM(NSInteger, ByteRTCVideoCodecType)
objectivec

视频编码类型

typedef NS_ENUM(NSInteger, ByteRTCMuteState)
objectivec

音视频流的发送/播放状态

typedef NS_ENUM(NSInteger, ByteSEIStreamEventType)
objectivec

黑帧视频流状态

typedef NS_ENUM(NSInteger, ByteRTCStreamIndex)
objectivec

流属性

typedef NS_ENUM(NSInteger, ByteRTCSyncInfoStreamType)
objectivec

媒体流信息同步的流类型

typedef NS_ENUM(NSInteger, ByteRTCForwardStreamState)
objectivec

媒体流跨房间转发状态

typedef NS_ENUM(NSInteger, ByteRTCForwardStreamError)
objectivec

媒体流跨房间转发过程中抛出的错误码

typedef NS_ENUM(NSInteger, ByteRTCForwardStreamEvent)
objectivec

媒体流跨房间转发事件

typedef NS_ENUM(NSInteger, ByteRTCRecordingState)
objectivec

本地录制的状态

typedef NS_ENUM(NSInteger, ByteRTCRecordingErrorCode)
objectivec

本地录制错误码

typedef NS_ENUM(NSInteger, ByteRTCRecordingFileType)
objectivec

本地录制文件的存储格式

typedef NS_ENUM(NSInteger, ByteRTCAVSyncState)
objectivec

音视频同步状态

typedef NS_ENUM(NSInteger, ByteRTCEchoTestResult)
objectivec

音视频回路测试结果

@interface ByteRTCEchoTestConfig : NSObject
objectivec

音视频回路测试参数

@property(strong, nonatomic) ByteRTCView* _Nullable view;
objectivec

用于渲染接收到的视频的视图

@property(copy, nonatomic) NSString *_Nonnull roomId;
objectivec

测试用户加入的房间 ID。

@property(copy, nonatomic) NSString *_Nonnull userId;
objectivec

进行音视频通话回路测试的用户 ID

@property(copy, nonatomic) NSString *_Nonnull token;
objectivec

对用户进房时进行鉴权验证的动态密钥，用于保证音视频通话回路测试的安全性。

@property(assign, nonatomic) BOOL enableAudio;
objectivec

是否检测音频。检测设备为系统默认音频设备。

• true：是
  

• 若使用 SDK 内部采集，此时设备麦克风会自动开启，并在 audioReportInterval 值大于 0 时触发 onLocalAudioPropertiesReport 回调，你可以根据该回调判断麦克风的工作状态
  
• 若使用自定义采集，此时你需调用 pushExternalAudioFrame: 将采集到的音频推送给 SDK
  

• flase：否
  

@property(assign, nonatomic) BOOL enableVideo;
objectivec

是否检测视频。PC 端默认检测列表中第一个视频设备。

• true：是
  

• 若使用 SDK 内部采集，此时设备摄像头会自动开启
  
• If you choose custom capture, you also need to call pushExternalVideoFrame:time: to push the captured video to the SDK.
  

• false: No
  

注意:
The video is published with fixed parameters: resolution 640px × 360px, frame rate 15fps.
The video is published with fixed parameters: resolution 640px × 360px, frame rate 15fps.

@property(assign, nonatomic) NSInteger audioReportInterval;
objectivec

音量信息提示间隔，单位：ms，默认为 100ms

• <= 0: 关闭信息提示
  
• (0,100]: 开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms
  
• > 100: 开启信息提示，并将信息提示间隔设置为此值
  

@interface ByteRTCUserInfo : NSObject
objectivec

用户信息。

@property(copy, nonatomic) NSString *_Nonnull userId;
objectivec

用户 ID。该字符串符合正则表达式：[a-zA-Z0-9_@\-]{1,128}。

@property(copy, nonatomic) NSString *_Nonnull extraInfo;
objectivec

用户需要透传的额外的信息，字符长度限制为 200 字节。会在 rtcEngine:onUserJoined:elapsed: 中回调给远端用户。

@interface ByteRTCRoomStats : NSObject
objectivec

房间通话统计数据，统计周期为 2s 。

用户进房成功后，SDK 会周期性地通过 onRoomStats 回调通知用户当前房间内的汇总统计信息。此数据结构即为回调给用户的参数类型。

@property(assign, nonatomic) NSInteger duration;
objectivec

用户进房开始通话后的总时长，单位为 s ，累计值

@property(assign, nonatomic) NSInteger txBytes;
objectivec

本地用户的总发送字节数 (bytes)，累计值

@property(assign, nonatomic) NSInteger rxBytes;
objectivec

本地用户的总接收字节数 (bytes)，累计值

@property(assign, nonatomic) NSInteger txKbitrate;
objectivec

发送码率（kbps），获取该数据时的瞬时值

@property(assign, nonatomic) NSInteger rxKbitrate;
objectivec

接收码率（kbps），获取该数据时的瞬时值

@property(assign, nonatomic) NSInteger txAudioKBitrate;
objectivec

本地用户的音频发送码率 (kbps)，瞬时值

@property(assign, nonatomic) NSInteger rxAudioKBitrate;
objectivec

本地用户的音频接收码率 (kbps)，瞬时值

@property(assign, nonatomic) NSInteger txVideoKBitrate;
objectivec

本地用户的视频发送码率 (kbps)，瞬时值

@property(assign, nonatomic) NSInteger rxVideoKBitrate;
objectivec

本地用户的视频接收码率 (kbps)，瞬时值

@property(assign, nonatomic) NSInteger txScreenKBitrate;
objectivec

屏幕接收码率，获取该数据时的瞬时值，单位为 Kbps

@property(assign, nonatomic) NSInteger rxScreenKBitrate;
objectivec

屏幕发送码率，获取该数据时的瞬时值，单位为 Kbps

@property(assign, nonatomic) NSInteger userCount;
objectivec

当前房间内的可见用户人数，包括本地用户自身

@property(assign, nonatomic) float rxLostrate;
objectivec

App 现在的下行丢包率

@property(assign, nonatomic) float txLostrate;
objectivec

App 现在的上行丢包率

@property(assign, nonatomic) NSInteger rtt;
objectivec

客户端到服务端的往返时延

@property(assign, nonatomic) NSInteger txJitter;
objectivec

系统上行网络抖动（ms）

@property(assign, nonatomic) NSInteger rxJitter;
objectivec

系统下行网络抖动（ms）

@property(assign, nonatomic) NSInteger tx_cellular_kbitrate;
objectivec

蜂窝路径发送的码率 (kbps)，为获取该数据时的瞬时值

@property(assign, nonatomic) NSInteger rx_cellular_kbitrate;
objectivec

蜂窝路径接收码率 (kbps)，为获取该数据时的瞬时值

@interface ByteRTCSysStats : NSObject
objectivec

App 使用的 cpu 和 memory 信息

信息由 SDK 周期性（2s）地通过 reportSysStats 回调事件通知给用户。

@property(assign, nonatomic) unsigned int cpu_cores;
objectivec

当前系统 cpu 核数

@property(assign, nonatomic) double cpu_app_usage;
objectivec

当前应用的 CPU 使用率，取值范围为 [0, 1]。

@property(assign, nonatomic) double cpu_total_usage;
objectivec

当前系统的 CPU 使用率，取值范围为 [0, 1]。

@property(assign, nonatomic) double memory_usage;
objectivec

当前App的内存使用（单位 MB）

@property(assign, nonatomic) unsigned long long full_memory;
objectivec

全量内存（单位MB）

@property(assign, nonatomic) unsigned long long total_memory_usage;
objectivec

系统已使用内存（单位MB）

@property(assign, nonatomic) unsigned long long free_memory;
objectivec

空闲可分配内存（单位MB）

@property(assign, nonatomic) double memory_ratio;
objectivec

当前应用的内存使用率（单位 %）

@property(assign, nonatomic) double total_memory_ratio;
objectivec

系统内存使用率（单位 %）

@interface ByteRTCLocalVideoStats : NSObject
objectivec

本地视频流统计信息，统计周期为 2s 。

本地用户发布视频流成功后，SDK 会周期性地通过 onLocalStreamStats
通知本地用户发布的视频流在此次统计周期内的发送状况。此数据结构即为回调给本地用户的参数类型。

@property(assign, nonatomic) float sentKBitrate;
objectivec

发送码率。此次统计周期内实际发送的分辨率最大的视频流的发送码率，单位为 Kbps

@property(assign, nonatomic) NSInteger inputFrameRate;
objectivec

采集帧率。此次统计周期内的视频采集帧率，单位为 fps 。

@property(assign, nonatomic) NSInteger sentFrameRate;
objectivec

发送帧率。此次统计周期内实际发送的分辨率最大的视频流的视频发送帧率，单位为 fps 。

@property(assign, nonatomic) NSInteger encoderOutputFrameRate;
objectivec

编码器输出帧率。当前编码器在此次统计周期内实际发送的分辨率最大的视频流的输出帧率，单位为 fps 。

@property(assign, nonatomic) NSInteger rendererOutputFrameRate;
objectivec

本地渲染帧率。此次统计周期内的本地视频渲染帧率，单位为 fps 。

@property(assign, nonatomic) NSInteger statsInterval;
objectivec

统计间隔，单位为 ms 。
此字段用于设置回调的统计周期，默认设置为 2s 。

@property(assign, nonatomic) float videoLossRate;
objectivec

视频丢包率。统计周期内的视频上行丢包率，取值范围为 [0, 1] 。

@property(assign, nonatomic) NSInteger rtt;
objectivec

往返时延。单位为 ms 。

@property(assign, nonatomic) NSInteger encodedBitrate;
objectivec

视频编码码率。此次统计周期内的实际发送的分辨率最大的视频流视频编码码率，单位为 Kbps 。

@property(assign, nonatomic) NSInteger encodedFrameWidth;
objectivec

实际发送的分辨率最大的视频流的视频编码宽度，单位为 px 。

@property(assign, nonatomic) NSInteger encodedFrameHeight;
objectivec

实际发送的分辨率最大的视频流的视频编码高度，单位为 px 。

@property(assign, nonatomic) NSInteger encodedFrameCount;
objectivec

此次统计周期内实际发送的分辨率最大的视频流的发送的视频帧总数。

@property(nonatomic) ByteRTCVideoCodecType codecType;
objectivec

编码类型。参看 ByteRTCVideoCodecType 类型。

@property(assign, nonatomic) BOOL isScreen;
objectivec

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

@property(assign, nonatomic) NSInteger jitter;
objectivec

视频上行网络抖动，单位为 ms。

@interface ByteRTCRemoteVideoStats : NSObject
objectivec

远端视频流统计信息，统计周期为 2s 。

本地用户订阅远端视频流成功后，SDK 会周期性地通过 onRemoteStreamStats
通知本地用户订阅的远端视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。

@property(assign, nonatomic) NSInteger width;
objectivec

远端视频宽度。

@property(assign, nonatomic) NSInteger height;
objectivec

远端视频高度。

@property(assign, nonatomic) float videoLossRate;
objectivec

远端视频丢包率。统计周期内的视频下行丢包率，取值范围为 [0, 1] 。

@property(assign, nonatomic) float receivedKBitrate;
objectivec

接收码率。统计周期内的视频接收码率，单位为 kbps 。

@property(assign, nonatomic) NSInteger receivedFrameRate;
objectivec

远端视频接收帧率。

@property(assign, nonatomic) NSInteger decoderOutputFrameRate;
objectivec

远端视频解码输出帧率。

@property(assign, nonatomic) NSInteger renderOutputFrameRate;
objectivec

远端视频渲染输出帧率。

@property(assign, nonatomic) NSInteger stallCount;
objectivec

远端视频卡顿次数。

@property(assign, nonatomic) NSInteger stallDuration;
objectivec

远端视频卡顿时长，单位为 ms 。

@property(assign, nonatomic) NSInteger e2eDelay;
objectivec

用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为 ms 。

@property(assign, nonatomic) BOOL isScreen;
objectivec

远端视频流是否是屏幕共享流。你可以知道当前数据来自主流还是屏幕流。

@property(assign, nonatomic) NSInteger statsInterval;
objectivec

统计间隔，此次统计周期的间隔，单位为 ms 。

此字段用于设置回调的统计周期，目前设置为 2s 。

@property(assign, nonatomic) NSInteger rtt;
objectivec

往返时延。单位为 ms 。

@property(assign, nonatomic) NSInteger frozenRate;
objectivec

远端用户在进房后发生视频卡顿的累计时长占视频总有效时长的百分比（%）。视频有效时长是指远端用户进房发布视频流后，除停止发送视频流和禁用视频模块之外的视频时长。

@property(nonatomic) ByteRTCVideoCodecType codecType;
objectivec

编码类型。参看 ByteRTCVideoCodecType 类型。

@property(assign, nonatomic) NSInteger videoIndex;
objectivec

SDK 订阅的远端视频流的分辨率下标。

@property(assign, nonatomic) NSInteger jitter;
objectivec

视频下行网络抖动，单位为 ms。

@interface ByteRTCLocalAudioStats : NSObject
objectivec

本地音频流统计信息，统计周期为 2s 。

本地用户发布音频流成功后，SDK 会周期性地通过 onLocalStreamStats
通知本地用户发布的音频流在此次统计周期内的发送状况。此数据结构即为回调给本地用户的参数类型。

@property(assign, nonatomic) float audioLossRate;
objectivec

音频丢包率。此次统计周期内的音频上行丢包率，取值范围为 [0, 1] 。

@property(assign, nonatomic) float sentKBitrate;
objectivec

发送的码率。此次统计周期内的音频发送码率，单位为 kbps 。

@property(assign, nonatomic) NSInteger recordSampleRate;
objectivec

采集采样率。此次统计周期内的音频采集采样率信息，单位为 Hz 。

@property(assign, nonatomic) NSInteger statsInterval;
objectivec

统计间隔。此次统计周期的间隔，单位为 ms 。

此字段用于设置回调的统计周期，默认设置为 2s 。

@property(assign, nonatomic) NSInteger rtt;
objectivec

往返时延。单位为 ms 。

@property(assign, nonatomic) NSInteger numChannels;
objectivec

音频声道数。

@property(assign, nonatomic) NSInteger sentSampleRate;
objectivec

音频发送采样率。此次统计周期内的音频发送采样率信息，单位为 Hz 。

@property(assign, nonatomic) NSInteger jitter;
objectivec

音频上行网络抖动，单位为 ms。

@interface ByteRTCRemoteAudioStats : NSObject
objectivec

远端音频流统计信息，统计周期为 2s 。

本地用户订阅远端音频流成功后，SDK 会周期性地通过 onRemoteStreamStats
通知本地用户订阅的音频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。

@property(assign, nonatomic) float audioLossRate;
objectivec

音频丢包率。统计周期内的音频下行丢包率，取值范围为 [0, 1] 。

@property(assign, nonatomic) float receivedKBitrate;
objectivec

接收码率。统计周期内的音频接收码率，单位为 kbps 。

@property(assign, nonatomic) NSInteger stallCount;
objectivec

音频卡顿次数。统计周期内的卡顿次数。

@property(assign, nonatomic) NSInteger stallDuration;
objectivec

音频卡顿时长。统计周期内的卡顿时长，单位为 ms 。

@property(assign, nonatomic) NSInteger playoutSampleRate;
objectivec

播放采样率。统计周期内的音频播放采样率信息，单位为 Hz 。

@property(assign, nonatomic) NSInteger e2eDelay;
objectivec

用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为 ms 。

@property(assign, nonatomic) NSInteger statsInterval;
objectivec

统计间隔。此次统计周期的间隔，单位为 ms 。

@property(assign, nonatomic) NSInteger rtt;
objectivec

客户端到服务端数据传输的往返时延，单位为 ms。

@property(assign, nonatomic) NSInteger total_rtt;
objectivec

发送端——服务端——接收端全链路数据传输往返时延。单位为 ms 。

@property(assign, nonatomic) NSInteger quality;
objectivec

远端用户发送的音频流质量。值含义参考 ByteRTCNetworkQuality 。

@property(assign, nonatomic) NSInteger jitterBufferDelay;
objectivec

因引入 jitter buffer 机制导致的延时。单位为 ms 。

@property(assign, nonatomic) NSInteger numChannels;
objectivec

音频声道数。

@property(assign, nonatomic) NSInteger receivedSampleRate;
objectivec

音频接收采样率。统计周期内接收到的远端音频采样率信息，单位为 Hz 。

@property(assign, nonatomic) NSInteger frozenRate;
objectivec

远端用户在加入房间后发生音频卡顿的累计时长占音频总有效时长的百分比。音频有效时长是指远端用户进房发布音频流后，除停止发送音频流和禁用音频模块之外的音频时长。

@property(assign, nonatomic) NSInteger concealedSamples;
objectivec

音频 PLC 样点总个数。

@property(assign, nonatomic) NSInteger concealmentEvent;
objectivec

音频丢包补偿(PLC) 累计次数。

@property(assign, nonatomic) NSInteger decSampleRate;
objectivec

音频解码采样率。统计周期内的音频解码采样率信息，单位为 Hz 。

@property(assign, nonatomic) NSInteger decDuration;
objectivec

此次订阅中，对远端音频流进行解码的累计耗时。单位为 s。

@property(assign, nonatomic) NSInteger jitter;
objectivec

视频下行网络抖动，单位为 ms。

@interface ByteRTCLocalStreamStats : NSObject
objectivec

本地音/视频流统计信息以及网络状况，统计周期为 2s 。

本地用户发布音/视频流成功后，SDK 会周期性地通过 onLocalStreamStats
通知本地用户发布的音/视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。

@property(strong, nonatomic) ByteRTCLocalAudioStats *_Nonnull audio_stats;
objectivec

本地设备发送音频流的统计信息，详见 ByteRTCLocalAudioStats

@property(strong, nonatomic) ByteRTCLocalVideoStats *_Nonnull video_stats;
objectivec

本地设备发送视频流的统计信息，详见 ByteRTCLocalVideoStats

@property(nonatomic, assign) BOOL is_screen;
objectivec

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

@interface ByteRTCRemoteStreamStats : NSObject
objectivec

用户订阅的远端音/视频流统计信息以及网络状况，统计周期为 2s 。

订阅远端用户发布音/视频流成功后，SDK 会周期性地通过 onRemoteStreamStats
通知本地用户订阅的远端音/视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。

@property(copy, nonatomic) NSString *_Nonnull uid;
objectivec

用户 ID 。音频来源的用户 ID 。

@property(strong, nonatomic) ByteRTCRemoteAudioStats *_Nonnull audio_stats;
objectivec

远端音频流的统计信息，详见 ByteRTCRemoteAudioStats

@property(strong, nonatomic) ByteRTCRemoteVideoStats *_Nonnull video_stats;
objectivec

远端视频流的统计信息，详见 ByteRTCRemoteVideoStats

@property(nonatomic, assign) BOOL is_screen;
objectivec

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

@interface ByteRTCUser : NSObject
objectivec

用户信息

@property(nonatomic, copy, nullable) NSString *userId;
objectivec

用户 ID

@property(nonatomic, copy, nullable) NSString *metaData;
objectivec

元信息

@interface ByteRTCRemoteStreamKey : NSObject
objectivec

用户信息

@property(nonatomic, copy, nullable) NSString *userId;
objectivec

用户 ID

@property(nonatomic, copy, nullable) NSString *roomId;
objectivec

房间 ID

@property(nonatomic, assign) ByteRTCStreamIndex streamIndex;
objectivec

流属性，包括主流、屏幕流。参看 ByteRTCStreamIndex

@interface ByteRTCRecordingConfig : NSObject
objectivec

本地录制参数配置

@property(strong, nonatomic) NSString* _Nullable dirPath;
objectivec

录制文件保存的绝对路径。你需要指定一个有读写权限的合法路径。

@property(assign, nonatomic) ByteRTCRecordingFileType recordingFileType;
objectivec

录制存储文件格式，参看 ByteRTCRecordingFileType

@interface ByteRTCRecordingProgress : NSObject
objectivec

本地录制进度

@property(assign, nonatomic) unsigned long long duration;
objectivec

当前文件的累计录制时长，单位：毫秒

@property(assign, nonatomic) unsigned long long fileSize;
objectivec

当前录制文件的大小，单位：byte

@interface ByteRTCRecordingInfo : NSObject
objectivec

本地录制的详细信息

@property(strong, nonatomic) NSString* _Nullable filePath;
objectivec

录制文件的绝对路径，包含文件名和文件后缀

@property(assign, nonatomic) ByteRTCVideoCodecType codecType;
objectivec

录制文件的视频编码类型，参看 ByteRTCVideoCodecType

@property(nonatomic, assign) NSInteger width;
objectivec

录制视频的宽，单位：像素。纯音频录制请忽略该字段

@property(nonatomic, assign) NSInteger height;
objectivec

录制视频的高，单位：像素。纯音频录制请忽略该字段

@interface ByteRTCStreamSycnInfoConfig : NSObject
objectivec

媒体流信息同步的相关配置

@property(assign, nonatomic) ByteRTCStreamIndex streamIndex;
objectivec

流属性，主流或屏幕流。见 ByteRTCStreamIndex 。

@property(assign, nonatomic) int repeatCount;
objectivec

消息发送的重复次数，取值范围是 [0,25]，建议设置为 [3,5]。

@property(assign, nonatomic) ByteRTCSyncInfoStreamType streamType;
objectivec

媒体流信息同步的流类型，见 ByteRTCSyncInfoStreamType 。

@interface ForwardStreamConfiguration: NSObject
objectivec

媒体流跨房间转发的目标房间的相关信息

@property(strong, nonatomic) NSString* _Nullable roomId;
objectivec

跨房间转发媒体流过程中目标房间 ID

@property(strong, nonatomic) NSString* _Nullable token;
objectivec

使用转发目标房间 RoomID 和 UserID 生成 Token。

测试时可使用控制台生成临时 Token，正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token。

如果 Token 无效，转发失败。

@interface ForwardStreamStateInfo: NSObject
objectivec

跨房间转发媒体流过程中的不同目标房间的状态和错误信息

@property(strong, nonatomic) NSString* _Nullable roomId;
objectivec

跨房间转发媒体流过程中目标房间 ID

空字符串代表所有目标房间

@property(assign, nonatomic) ByteRTCForwardStreamState state;
objectivec

跨房间转发媒体流过程中该目标房间的状态，参看 ByteRTCForwardStreamState

@property(assign, nonatomic) ByteRTCForwardStreamError error;
objectivec

跨房间转发媒体流过程中该目标房间抛出的错误码，参看 ByteRTCForwardStreamError

@interface ForwardStreamEventInfo: NSObject
objectivec

跨房间转发媒体流过程中的不同目标房间发生的事件

@property(strong, nonatomic) NSString* _Nullable roomId;
objectivec

跨房间转发媒体流过程中的发生该事件的目标房间 ID

空字符串代表所有目标房间

@property(assign, nonatomic) ByteRTCForwardStreamEvent event;
objectivec

跨房间转发媒体流过程中该目标房间发生的事件，参看 ByteRTCForwardStreamEvent

@interface ByteRTCNetworkQualityStats: NSObject
objectivec

上行/下行网络质量

@property(strong, nonatomic) NSString* _Nonnull uid;
objectivec

用户 ID

@property(assign, nonatomic) double lossRatio;
objectivec

本端的上行/下行的丢包率，范围 [0.0,1.0]
当 uid 为本地用户时，代表发布流的上行丢包率。
当 uid 为远端用户时，代表接收所有订阅流的下行丢包率。

@property(assign, nonatomic) int rtt;
objectivec

当 uid 为本地用户时有效，客户端到服务端的往返延时（RTT），单位：ms

@property(assign, nonatomic) int totalBandwidth;
objectivec

本端的音视频 RTP 包 2 秒内的平均传输速率，单位：bps
当 uid 为本地用户时，代表发送速率。
当 uid 为远端用户时，代表所有订阅流的接收速率。

@property(assign, nonatomic) ByteRTCNetworkQuality txQuality;
objectivec

上行网络质量评分，详见 ByteRTCNetworkQuality。

@property(assign, nonatomic) ByteRTCNetworkQuality rxQuality;
objectivec

下行网络质量评分，详见 ByteRTCNetworkQuality。

@interface ByteRTCCloudProxyInfo: NSObject
objectivec

云代理信息

@property(strong, nonatomic) NSString* _Nonnull cloudProxyIp;
objectivec

云代理服务器 IP

@property(assign, nonatomic) int cloudProxyPort;
objectivec

云代理服务器端口

typedef NS_ENUM(NSInteger, AttenuationType)
objectivec

空间音频音量随距离衰减模式

@interface ReceiveRange : NSObject
objectivec

本地用户能收听到、且具有衰减效果的音频接收范围

@property(nonatomic, assign) int min;
objectivec

能够接收语音、并且具有衰减效果的最小距离值，该值须 ≥ 0，但 ≤ max。

小于该值的范围内没有范围语音效果，即收听到的音频音量相同。

@property(nonatomic, assign) int max;
objectivec

能够收听语音的最大距离值，该值须 > 0 且 ≥ min。

当收听者和声源距离处于 [min, max) 之间时，收听到的音量根据距离呈衰减效果。

超出该值范围的音频将无法收听到。

@interface ByteRTCRangeAudioInfo : NSObject
objectivec

范围语音流信息

@property(copy, nonatomic) NSString * _Nonnull userId;
objectivec

远端音频发布用户 ID

@property(nonatomic, assign) int factor;
objectivec

本地用户听到该远端音频发布用户的衰减系数，范围 [0,100]，数值为 0 时表示远端用户音频音量为 0。

@protocol ByteRtcScreenCapturerExtDelegate <NSObject>
objectivec

屏幕采集相关扩展协议，仅适用于 SDK 内部采集。

用户创建 extesion 后生成的 SampleHandler 需继承此协议以实现屏幕共享相关能力。

- (void)onQuitFromApp;
objectivec

通知 Broadcast Upload Extension 停止采集屏幕并退出。

注意
用户调用 stopScreenCapture 后，会触发该方法通知 extension 端的 SDK 停止屏幕采集。

- (void)onReceiveMessageFromApp:(NSData *)message;
objectivec

Socket 收到 App 侧发来的信息时，触发该回调

传入参数

- (void)onSocketDisconnect;
objectivec

Socket 连接断开时触发此回调

- (void)onSocketConnect;
objectivec

Socket 连接成功时触发此回调

- (void)onNotifyAppRunning;
objectivec

检测到 App 正在进行音视频通话时触发此回调。

@interface ByteRtcScreenCapturerExt : NSObject
objectivec

屏幕采集相关扩展实例，仅适用于 SDK 内部采集。

用户创建 extesion 后生成的 SampleHandler 需通过此实例实现屏幕共享相关能力。

- (void)startWithDelegate:(NSObject<ByteRtcScreenCapturerExtDelegate> *)delegate groupId:(NSString *)groupId;
objectivec

开始屏幕采集

Extension 启动后，系统将自动调用该方法开启屏幕采集。

传入参数

- (void)stop;
objectivec

结束屏幕采集

Extension 关闭后，系统将自动调用该方法停止屏幕采集。

- (void)processSampleBuffer:(CMSampleBufferRef)sampleBuffer withType:(RPSampleBufferType)sampleBufferType API_AVAILABLE(ios(10));
objectivec

推送 Extension 采集的数据

传入参数

@interface Orientation : NSObject
objectivec

方向朝向信息

@property(nonatomic, assign) float x;
objectivec

x 坐标

@property(nonatomic, assign) float y;
objectivec

y 坐标

@property(nonatomic, assign) float z;
objectivec

z 坐标

@interface HumanOrientation : NSObject
objectivec

三维朝向信息，三个向量需要两两垂直。参看 Orientation。

@property(nonatomic, strong) Orientation* _Nonnull forward;
objectivec

正前方朝向，默认值为 {1,0,0}，即正前方朝向 x 轴正方向

@property(nonatomic, strong) Orientation* _Nonnull right;
objectivec

正右方朝向，默认值为 {0,1,0}，即右手朝向 y 轴正方向

@property(nonatomic, strong) Orientation* _Nonnull up;
objectivec

正上方朝向，默认值为 {0,0,1}，即头顶朝向 z 轴正方向

typedef NS_ENUM(NSUInteger, ByteRTCRenderMode)
objectivec

视频帧渲染设置

typedef NS_ENUM(NSUInteger, ByteRTCTranscoderContentControlType)
objectivec

合流输出内容类型

typedef NS_ENUM(NSUInteger, ByteRTCTranscoderLayoutRegionType)
objectivec

合流布局区域类型

typedef NS_ENUM(NSInteger, ByteRTCVideoStreamType)
objectivec

视频流类型
目前C++ SDK 只支持 ByteRTCVideoStreamTypeHigh 类型

typedef NS_ENUM(NSInteger, ByteRTCVideoStreamState)
objectivec

设置本地视频属性的返回状态。

typedef NS_ENUM(NSInteger, ByteRTCVideoOutputOrientationMode)
objectivec

视频输出方向模式

typedef NS_ENUM(NSUInteger, ByteRTCMirrorType)
objectivec

镜像类型

typedef NS_ENUM(NSUInteger, ByteRTCEffectBeautyMode)
objectivec

基础美颜模式

typedef NS_ENUM(NSInteger, ByteRTCVideoRotation)
objectivec

视频旋转信息，枚举类型，定义了以 90 度为间隔的四种旋转模式。

typedef NS_ENUM(NSInteger, ByteRTCVideoContentType)
objectivec

视频内容类型