typedef NS_ENUM(NSInteger, ByteRTCAudioScenarioType)
objectivec

音频场景类型。
选择音频场景后，SDK 会根据操作系统和开麦、闭麦状态，应用通话音量或媒体音量。参看通话音量与媒体音量了解更多相关信息。
如果以下音频场景类型无法满足你的业务需要，请联系技术支持人员。

typedef NS_ENUM(NSInteger, ByteRTCVoiceChangerType)
objectivec

变声特效类型。如需更多类型，联系技术支持。

typedef NS_ENUM(NSInteger, ByteRTCVoiceReverbType)
objectivec

混响特效类型

typedef NS_ENUM(NSInteger, ByteRTCBandFrequency)
objectivec

音频均衡效果。

@interface ByteRTCVoiceEqualizationConfig : NSObject
objectivec

语音均衡效果。

@property(assign, nonatomic) ByteRTCBandFrequency frequency;
objectivec

频带。参看 ByteRTCBandFrequency。

@property(assign, nonatomic) int gain;
objectivec

频带增益（dB）。取值范围是 [-15, 15]。

@interface ByteRTCVoiceReverbConfig : NSObject
objectivec

音频混响效果。

@property(assign, nonatomic) float roomSize;
objectivec

混响模拟的房间大小，取值范围 [0.0, 100.0]。默认值为 50.0f。房间越大，混响越强。

@property(assign, nonatomic) float decayTime;
objectivec

混响的拖尾长度，取值范围 [0.0, 100.0]。默认值为 50.0f。

@property(assign, nonatomic) float damping;
objectivec

混响的衰减阻尼大小，取值范围 [0.0, 100.0]。默认值为 50.0f。

@property(assign, nonatomic) float wetGain;
objectivec

早期反射信号强度。取值范围 [-20.0, 10.0]，单位为 dB。默认值为 0.0f。

@property(assign, nonatomic) float dryGain;
objectivec

原始信号强度。取值范围 [-20.0, 10.0]，单位为 dB。默认值为 0.0f。

@property(assign, nonatomic) float preDelay;
objectivec

早期反射信号的延迟。取值范围 [0.0, 200.0]，单位为 ms。默认值为 0.0f。

typedef NS_ENUM(NSInteger, ByteRTCAudioProfileType)
objectivec

音质档位

typedef NS_ENUM(NSInteger, ByteRTCAnsMode)
objectivec

降噪模式。降噪算法受调用 joinRoom:userInfo:roomConfig: 时设置的房间模式影响。

typedef NS_ENUM(NSInteger, ByteRTCAudioDeviceType)
objectivec

当前音频设备类型

typedef NS_ENUM(NSInteger, ByteRTCAudioSampleRate)
objectivec

音频采样率，单位为 Hz。

typedef NS_ENUM(NSInteger, ByteRTCAudioChannel)
objectivec

音频声道。

typedef NS_ENUM(NSInteger, ByteRTCTranscodingAudioCodec)
objectivec

音频编码类型。

typedef NS_ENUM(NSInteger, ByteRTCMixedStreamAudioCodecType)
objectivec

音频编码类型。(新)

typedef NS_ENUM(NSInteger, ByteRTCMixedStreamAudioProfile)
objectivec

AAC 编码规格。

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, ByteRTCMediaPlayerCustomSourceMode)
objectivec

自定义音频源模式

typedef NS_ENUM(NSInteger, ByteRTCMediaPlayerCustomSourceStreamType)
objectivec

自定义音频流类型

typedef NS_ENUM(NSInteger, ByteRTCMediaPlayerCustomSourceSeekWhence)
objectivec

音频数据的起始读取位置。

typedef NS_ENUM(NSInteger, ByteRTCPlayerState)
objectivec

播放状态。

typedef NS_ENUM(NSInteger, ByteRTCPlayerError)
objectivec

播放错误码。

typedef NS_ENUM(NSInteger, ByteRTCAudioSourceType)
objectivec

音频输入源类型

typedef NS_ENUM(NSInteger, ByteRTCAudioRenderType)
objectivec

音频输出源类型

typedef NS_ENUM(NSInteger, ByteRTCEarMonitorMode)
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

rtcEngine:onLocalAudioPropertiesReport: 中包含的音频信息的范围。

@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

@property(nonatomic, assign) int samplesPerCall;
objectivec

单次回调的音频帧中包含的采样点数。默认值为 0，此时，采样点数取最小值。
最小值为回调间隔是 0.01s 时的值，即 sampleRate 最大值是 2048`。超出取值范围时，采样点数取默认值。
该参数仅在设置读写回调时生效，调用 enableAudioFrameCallback:format: 开启只读模式回调时设置该参数不生效。

@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

@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 时，不会触发进度回调。
  

@property(assign, nonatomic) BOOL syncProgressToRecordFrame;
objectivec

在采集音频数据时，附带本地混音文件播放进度的时间戳。启用此功能会提升远端人声和音频文件混音播放时的同步效果。

• 仅在单个音频文件混音时使用有效。
  
• true 时开启此功能，false 时关闭此功能，默认为关闭。

@interface ByteRTCAudioEffectPlayerConfig : NSObject
objectivec

混音配置

@property(assign, nonatomic) ByteRTCAudioMixingType type;
objectivec

混音播放类型，详见 ByteRTCAudioMixingType

@property(assign, nonatomic) NSInteger pitch;
objectivec

与音乐文件原始音调相比的升高/降低值，取值范围为 [-12，12]，默认值为 0。每相邻两个值的音高距离相差半音，正值表示升调，负值表示降调。

@property(assign, nonatomic) NSInteger playCount;
objectivec

混音播放次数

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

@property(assign, nonatomic) NSInteger startPos;
objectivec

混音起始位置。默认值为 0，单位为毫秒。

@interface ByteRTCMediaPlayerConfig : 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 startPos;
objectivec

混音起始位置。默认值为 0，单位为毫秒。

@property(assign, nonatomic) NSInteger callbackOnProgressInterval;
objectivec

设置音频文件混音时，收到 onMediaPlayerPlayingProgress:progress: 的间隔。单位毫秒。

• interval > 0 时，触发回调。实际间隔为 10 的倍数。如果输入数值不能被 10 整除，将自动向上取整。例如传入 52，实际间隔为 60 ms。
• interval <= 0 时，不会触发回调。

@property(assign, nonatomic) BOOL syncProgressToRecordFrame;
objectivec

在采集音频数据时，附带本地混音文件播放进度的时间戳。启用此功能会提升远端人声和音频文件混音播放时的同步效果。

• 仅在单个音频文件混音时使用有效。
  
• true 时开启此功能，false 时关闭此功能，默认为关闭。

@property(assign, nonatomic) BOOL autoPlay;
objectivec

是否自动播放。如果不自动播放，调用 start 播放音乐文件。默认为 True。

@interface ByteRTCMediaPlayerCustomSource : NSObject
objectivec

音频源

@property(weak, nonatomic) id<ByteRTCMediaPlayerCustomSourceProvider> _Nullable provider;
objectivec

仅在使用内存播放时，传入对应的 ByteRTCMediaPlayerCustomSourceProvider 实例。

@property(assign, nonatomic) ByteRTCMediaPlayerCustomSourceMode mode;
objectivec

数据源模式，详见 ByteRTCMediaPlayerCustomSourceMode。默认为 push。

@property(assign, nonatomic) ByteRTCMediaPlayerCustomSourceStreamType type;
objectivec

数据源类型，详见 ByteRTCMediaPlayerCustomSourceStreamType。默认为 raw。

@interface ByteRTCAudioPropertiesConfig : NSObject
objectivec

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

@property(assign, nonatomic) NSInteger interval;
objectivec

信息提示间隔，单位：ms

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

@property(assign, nonatomic) BOOL enableSpectrum;
objectivec

是否开启音频频谱检测。

@property(assign, nonatomic) BOOL enableVad;
objectivec

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

@property(assign, nonatomic) ByteRTCAudioReportMode localMainReportMode;
objectivec

音量回调模式。详见 ByteRTCAudioReportMode。

@property(nonatomic, assign) float smooth;
objectivec

适用于音频属性信息提示的平滑系数。取值范围是 (0.0, 1.0]。

默认值为 1.0，不开启平滑效果；值越小，提示音量平滑效果越明显。如果要开启平滑效果，可以设置为 0.3。

@property(assign, nonatomic) ByteRTCAudioPropertiesMode audioReportMode;
objectivec

rtcEngine:onLocalAudioPropertiesReport: 中包含音频数据的范围。参看 ByteRTCAudioPropertiesMode。
默认仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据。

@property(assign, nonatomic) BOOL enableVoicePitch;
objectivec

是否回调本地用户的人声基频。

@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。

@property(assign, nonatomic) NSInteger voicePitch;
objectivec

本地用户的人声基频，单位为赫兹。

同时满足以下两个条件时，返回的值为本地用户的人声基频：

• 调用 enableAudioPropertiesReport:，并设置参数 enableVoicePitch 的值为 true。
  
• 本地采集的音频中包含本地用户的人声。
  
  其他情况下返回 0。

@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 ByteRTCPosition : NSObject
objectivec

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

@property(nonatomic, assign) float x;
objectivec

x 坐标

@property(nonatomic, assign) float y;
objectivec

y 坐标

@property(nonatomic, assign) float z;
objectivec

z 坐标

@interface ByteRTCOrientation : NSObject
objectivec

方向朝向信息

@property(nonatomic, assign) float x;
objectivec

x 坐标

@property(nonatomic, assign) float y;
objectivec

y 坐标

@property(nonatomic, assign) float z;
objectivec

z 坐标

@interface ByteRTCHumanOrientation : NSObject
objectivec

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

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

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

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

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

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

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

typedef NS_ENUM(NSInteger, ByteRTCMulDimSingScoringMode)
objectivec

K 歌打分维度。

typedef NS_ENUM(NSInteger, ByteRTCAudioAlignmentMode)
objectivec

远端音频流精准对齐模式

@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(NSInteger, ByteRTCAudioFrameSource)
objectivec

音频文件录制内容来源。

typedef NS_ENUM(NSInteger, ByteRTCAudioQuality)
objectivec

音频质量

@interface ByteRTCAudioRecordingConfig : NSObject
objectivec

音频录制配置

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

录制文件路径。一个有读写权限的绝对路径，包含文件名和文件后缀。

注意:
录制文件的格式仅支持 .aac 和 .wav。
录制文件的格式仅支持 .aac 和 .wav。

@property(nonatomic, assign) ByteRTCAudioFrameSource frameSource;
objectivec

录音内容来源，参看 ByteRTCAudioFrameSource。
默认为 ByteRTCAudioFrameSourceTypeMixed = 2。

@property(nonatomic, assign) ByteRTCAudioSampleRate sampleRate;
objectivec

录音采样率。参看 ByteRTCAudioSampleRate。

@property(nonatomic, assign) ByteRTCAudioChannel channel;
objectivec

录音音频声道。参看 ByteRTCAudioChannel。
如果录制时设置的的音频声道数与采集时的音频声道数不同：

• 如果采集的声道数为 1，录制的声道数为 2，那么，录制的音频为经过单声道数据拷贝后的双声道数据，而不是立体声。
  
• 如果采集的声道数为 2，录制的声道数为 1，那么，录制的音频为经过双声道数据混合后的单声道数据。

@property(nonatomic, assign) ByteRTCAudioQuality quality;
objectivec

录音音质。仅在录制文件格式为 .aac 时可以设置。参看 ByteRTCAudioQuality。
采样率为 32kHz 时，不同音质录制文件（时长为 10min）的大小分别是：

• 低音质：1.2MB；
  
• 【默认】中音质：2MB；
  
• 高音质：3.75MB；
  
• 超高音质：7.5MB。

typedef NS_ENUM(NSInteger, ByteRTCAudioRecordingState)
objectivec

录音配置

@interface ByteRTCAudioEnhancementConfig: NSObject
objectivec

蜂窝网络辅助增强应用的媒体模式

@property (assign, nonatomic) BOOL enhanceSignaling;
objectivec

对信令消息，是否启用蜂窝网络辅助增强。默认不启用。

@property (assign, nonatomic) BOOL enhanceAudio;
objectivec

对音频，是否启用蜂窝网络辅助增强。默认不启用。

@interface ByteRTCPositionInfo : NSObject
objectivec

用户在空间音频坐标系里的位置信息。

@property(strong, nonatomic) ByteRTCPosition *_Nonnull position;
objectivec

用户在空间音频坐标系里的位置，需自行建立空间直角坐标系。参看 ByteRTCPosition。

@property(strong, nonatomic) ByteRTCHumanOrientation *_Nonnull orientation;
objectivec

用户在空间音频坐标系里的三维朝向信息。三个向量需要两两垂直。参看 ByteRTCHumanOrientation。

typedef NS_ENUM(NSInteger, ByteRTCReturnStatus)
objectivec

方法调用结果。

typedef NS_ENUM(NSInteger, ByteRTCStreamRemoveReason)
objectivec

房间内远端流移除原因。

typedef NS_ENUM(NSInteger, ByteRTCRoomProfile)
objectivec

房间模式

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

调用 setAudioProfile 改变音频参数配置

typedef NS_ENUM(NSInteger, ByteRTCUserVisibilityChangeError)
objectivec

用户可见性状态改变错误码。

typedef NS_ENUM(NSInteger, ByteRTCDataMessageSourceType)
objectivec

数据消息来源

typedef NS_ENUM(NSInteger, ByteRTCSEICountPerFrame)
objectivec

SEI 发送模式。

typedef NS_ENUM(NSInteger, ByteRTCSubscribeState)
objectivec

订阅媒体流状态

typedef NS_ENUM(NSInteger, ByteRTCPerformanceAlarmReason)
objectivec

性能相关告警的原因

typedef NS_ENUM(NSInteger, ByteRTCPerformanceAlarmMode)
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

本地音频流状态。

typedef NS_ENUM(NSInteger, ByteRTCLocalAudioStreamError)
objectivec

本地音频流状态改变时的错误码。

typedef NS_ENUM(NSInteger, ByteRTCLocalVideoStreamState)
objectivec

本地视频流状态

typedef NS_ENUM(NSInteger, ByteRTCLocalVideoStreamError)
objectivec

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

typedef NS_ENUM(NSInteger, ByteRTCRemoteAudioState)
objectivec

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

typedef NS_ENUM(NSInteger, ByteRTCRemoteAudioStateChangeReason)
objectivec

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

typedef NS_ENUM(NSInteger, ByteRTCRemoteVideoState)
objectivec

远端视频流状态

typedef NS_ENUM(NSInteger, ByteRTCRemoteVideoStateChangeReason)
objectivec

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

typedef NS_ENUM(NSInteger, ByteRTCMediaDeviceType)
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(uint64_t, ByteRTCProblemFeedbackOption)
objectivec

音视频质量反馈问题类型

@interface ByteRTCProblemFeedbackRoomInfo: NSObject
objectivec

通话质量反馈房间信息

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

通话质量反馈的房间ID

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

通话质量反馈的用户ID

@interface ByteRTCProblemFeedbackInfo: NSObject
objectivec

通话质量反馈信息

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

通话质量反馈的文字描述

@property(nonatomic, strong) NSArray<ByteRTCProblemFeedbackRoomInfo *> * _Nullable roomInfo;
objectivec

通话质量反馈的房间信息。参看 ByteRTCProblemFeedbackRoomInfo。

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, ByteRTCVideoSuperResolutionMode)
objectivec

超分模式。

typedef NS_ENUM(NSInteger, ByteRTCVideoDenoiseMode)
objectivec

视频降噪模式。

typedef NS_ENUM(NSInteger, ByteRTCMuteState)
objectivec

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

typedef NS_ENUM(NSInteger, ByteRTCSEIStreamEventType)
objectivec

黑帧视频流状态

typedef NS_ENUM(NSInteger, ByteRTCStreamIndex)
objectivec

流属性

typedef NS_ENUM(NSInteger, ByteRTCAggregationOption)
objectivec

流聚合策略

typedef NS_ENUM(NSInteger, ByteRTCSyncInfoStreamType)
objectivec

媒体流信息同步的流类型

typedef NS_ENUM(NSInteger, ByteRTCColorSpace)
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

音视频回路测试结果

typedef NS_ENUM(NSInteger, ByteRTCBluetoothMode)
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
  

• false：否
  

@property(assign, nonatomic) BOOL enableVideo;
objectivec

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

• true：是
  

• 若使用 SDK 内部采集，此时设备摄像头会自动开启
  
• 若使用自定义采集，此时你需调用 pushExternalVideoFrame: 将采集到的视频推送给 SDK
  

• false：否
  
  视频的发布参数固定为：分辨率 640px × 360px，帧率 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 txCellularKBitrate;
objectivec

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

@property(assign, nonatomic) NSInteger rxCellularKBitrate;
objectivec

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

@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。

@property(assign, nonatomic) ByteRTCVideoDenoiseMode videoDenoiseMode;
objectivec

视频降噪模式。具体参看 ByteRTCVideoDenoiseMode 。

@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。

@property(assign, nonatomic) ByteRTCVideoSuperResolutionMode superResolutionMode;
objectivec

远端视频超分模式，参看 ByteRTCVideoSuperResolutionMode。

@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 totalRtt;
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 audioStats;
objectivec

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

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

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

@property(assign, nonatomic) ByteRTCNetworkQuality txQuality;
objectivec

所属用户的媒体流上行网络质量，详见 ByteRTCNetworkQuality

Deprecated since 3.36 and will be deleted in 3.51, use rtcRoom:onNetworkQuality:remoteQualities: instead

@property(assign, nonatomic) ByteRTCNetworkQuality rxQuality;
objectivec

所属用户的媒体流下行网络质量，详见 ByteRTCNetworkQuality

Deprecated since 3.36 and will be deleted in 3.51, use rtcRoom:onNetworkQuality:remoteQualities: instead

@property(nonatomic, assign) BOOL isScreen;
objectivec

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

@interface ByteRTCRemoteStreamStats : NSObject
objectivec

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

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

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

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

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

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

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

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

@property(assign, nonatomic) ByteRTCNetworkQuality txQuality;
objectivec

所属用户的媒体流上行网络质量，详见 ByteRTCNetworkQuality

Deprecated since 3.36 and will be deleted in 3.51, use rtcRoom:onNetworkQuality:remoteQualities: instead

@property(assign, nonatomic) ByteRTCNetworkQuality rxQuality;
objectivec

所属用户的媒体流下行网络质量，详见 ByteRTCNetworkQuality

Deprecated since 3.36 and will be deleted in 3.51, use rtcRoom:onNetworkQuality:remoteQualities: instead

@property(nonatomic, assign) BOOL isScreen;
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

本地录制参数配置