# CodecMode ```java public enum com.ss.bytertc.engine.VideoStreamDescription.CodecMode ``` 编码器模式（使用软编码或者硬编码） ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | CODEC_MODE_AUTO | 0 | 自动模式 | | CODEC_MODE_HARDWARE | 1 | 硬编码模式 | | CODEC_MODE_SOFTWARE | 2 | 软编码模式 | # MixedStreamAlternateImageFillMode ```java public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAlternateImageFillMode ``` 服务端合流占位图填充模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | FIT | 0 | 占位图跟随用户原始视频帧相同的比例缩放。默认设置。{en} | | FILL | 1 | 占位图不跟随用户原始视频帧相同的比例缩放，保持图片原有比例。{en} | # CapturePreference ```java public enum com.ss.bytertc.engine.video.VideoCaptureConfig.CapturePreference ``` 视频采集模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUTO | 0 | （默认）自动设置采集参数。
SDK 在开启采集时根据服务端下发的采集配置结合编码参数设置最佳采集参数。 | | MANUAL | 1 | 手动设置采集参数，包括采集分辨率、帧率。 | | AUTO_PERFORMANCE | 2 | 采集参数与编码参数一致，即在 [setVideoEncoderConfig](70080#RTCVideo-setvideoencoderconfig) 中设置的参数。 | # Layout ```java public static class com.ss.bytertc.engine.live.LiveTranscoding.Layout ``` 视频流合流整体布局信息。开启转推直播功能后，你可以设置参与合流的每路视频流的预设布局信息和合流背景信息等。 ## 成员函数 | 返回 | 名称 | | --- | --- | | Region [] | [getRegions](#Layout-getregions) | | void | [setRegions](#Layout-setregions) | | String | [getAppData](#Layout-getappdata) | | void | [setAppData](#Layout-setappdata) | | String | [getBackgroundColor](#Layout-getbackgroundcolor) | | void | [setBackgroundColor](#Layout-setbackgroundcolor) | ## 函数说明 ### getRegions ```java Region[] com.ss.bytertc.engine.live.LiveTranscoding.Layout.getRegions() ``` 获取用户布局信息列表。 **返回值** 当前合流的用户布局信息列表。 ### setRegions ```java void com.ss.bytertc.engine.live.LiveTranscoding.Layout.setRegions(Region[] regions) ``` 设置用户布局信息列表。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | regions | Region[] | 用户布局信息列表。为 [Region](#Region) 数据类型的数组。每一个该类型对象为一路单独的视频流的布局信息。
值不合法或未设置时，自动使用默认值。 | ### getAppData ```java String com.ss.bytertc.engine.live.LiveTranscoding.Layout.getAppData() ``` 获取透传的 App 数据。 **返回值** 当前透传的 App 数据。 ### setAppData ```java void com.ss.bytertc.engine.live.LiveTranscoding.Layout.setAppData(String appData) ``` 设置透传的 App 数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | appData | String | 透传的 App 数据，长度不超过 4 KB。 | ### getBackgroundColor ```java String com.ss.bytertc.engine.live.LiveTranscoding.Layout.getBackgroundColor() ``` 获取画布的背景颜色。 **返回值** 当前画布的背景颜色。 ### setBackgroundColor ```java void com.ss.bytertc.engine.live.LiveTranscoding.Layout.setBackgroundColor(String backgroundColor) ``` 设置画布的背景颜色。值不合法或未设置时，自动使用默认值。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | backgroundColor | String | 合流背景颜色，用十六进制颜色码（HEX）表示。例如，#FFFFFF 表示纯白，#000000 表示纯黑。默认值为 #000000。 | # AudioProcessorMethod ```java public enum com.ss.bytertc.engine.data.AudioProcessorMethod ``` 返回给音频处理器的音频类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_FRAME_PROCESSOR_RECORD | 0 | 本地采集的音频。 | | AUDIO_FRAME_PROCESSOR_PLAYBACK | 1 | 远端音频流的混音音频。 | | AUDIO_FRAME_PROCESSOR_REMOTE_USER | 2 | 各个远端音频流。 | | AUDIO_FRAME_PROCESSOR_EAR_MONITOR | 3 | 软件耳返音频。 | | AUDIO_FRAME_PROCESSOR_SCREEN | 4 | 屏幕共享音频。 | # VideoSourceType ```java public enum com.ss.bytertc.engine.data.VideoSourceType ``` 视频输入源类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | VIDEO_SOURCE_TYPE_EXTERNAL | 0 | 自定义采集视频源 | | VIDEO_SOURCE_TYPE_INTERNAL | 1 | 内部采集视频源 | | VIDEO_SOURCE_TYPE_ENCODED_WITH_SIMULCAST | 2 | 自定义编码视频源。
你仅需推送分辨率最大的一路编码后视频流，SDK 将自动转码生成多路小流 | | VIDEO_SOURCE_TYPE_ENCODED_WITHOUT_SIMULCAST | 3 | 自定义编码视频源。
SDK 不会自动生成多路流，你需要自行生成并推送多路流 | # MessageConfig ```java public enum com.ss.bytertc.engine.type.MessageConfig ``` 发送消息的可靠有序性 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | RELIABLE_ORDERED | 0 | 低延时可靠有序消息 | | UNRELIABLE_ORDERED | 1 | 超低延时有序消息 | | UNRELIABLE_UNORDERED | 2 | 超低延时无序消息 | # ProblemFeedbackInfo ```java public class com.ss.bytertc.engine.type.ProblemFeedbackInfo ``` 通话质量反馈信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [problemDesc](#ProblemFeedbackInfo-problemdesc) | | List | [roomInfo](#ProblemFeedbackInfo-roominfo) | ## 成员函数 | 返回 | 名称 | | --- | --- | | ProblemFeedbackInfo | [ProblemFeedbackInfo](#ProblemFeedbackInfo-problemfeedbackinfo-2) | ## 变量说明 ### problemDesc ```java public String com.ss.bytertc.engine.type.ProblemFeedbackInfo.problemDesc ``` 文字描述 ### roomInfo ```java public List com.ss.bytertc.engine.type.ProblemFeedbackInfo.roomInfo ``` 房间信息，参看 [ProblemFeedbackRoomInfo](#ProblemFeedbackRoomInfo)。 ## 函数说明 ### ProblemFeedbackInfo ```java com.ss.bytertc.engine.type.ProblemFeedbackInfo.ProblemFeedbackInfo(String problemDesc) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | problemDesc | String | - | # ExpressionDetectResult ```java public class com.ss.bytertc.engine.video.ExpressionDetectResult ``` 人像属性检测结果 ## 成员变量 | 类型 | 默认值 | 名称 | | --- | --- | --- | | int | 10 | [MAX_COUNT](#ExpressionDetectResult-max_count) | | int | 0 | [detectResult](#ExpressionDetectResult-detectresult) | | int | 0 | [faceCount](#ExpressionDetectResult-facecount) | | ExpressionDetectInfo[] | - | [detectInfo](#ExpressionDetectResult-detectinfo) | ## 变量说明 ### MAX_COUNT ```java public static final int com.ss.bytertc.engine.video.ExpressionDetectResult.MAX_COUNT = 10 ``` 人脸信息存储上限，最多可存储 10 个人脸信息 ### detectResult ```java public int com.ss.bytertc.engine.video.ExpressionDetectResult.detectResult = 0 ``` 特征识别结果 - 0：识别成功 - !0：识别失败 ### faceCount ```java public int com.ss.bytertc.engine.video.ExpressionDetectResult.faceCount = 0 ``` 识别到的人脸数量。 ### detectInfo ```java public ExpressionDetectInfo [] com.ss.bytertc.engine.video.ExpressionDetectResult.detectInfo ``` 特征识别信息。数组的长度和检测到的人脸数量一致。参看 [ExpressionDetectInfo](#ExpressionDetectInfo)。 # MediaDeviceType ```java public class com.ss.bytertc.engine.type.MediaDeviceType ``` 媒体设备类型 ## 成员变量 | 类型 | 默认值 | 名称 | | --- | --- | --- | | int | -1 | [MEDIA_DEVICE_TYPE_AUDIO_UNKNOWN](#MediaDeviceType-media_device_type_audio_unknown) | | int | 0 | [MEDIA_DEVICE_TYPE_AUDIO_RENDER_DEVICE](#MediaDeviceType-media_device_type_audio_render_device) | | int | 1 | [MEDIA_DEVICE_TYPE_AUDIO_CAPTURE_DEVICE](#MediaDeviceType-media_device_type_audio_capture_device) | | int | 3 | [MEDIA_DEVICE_TYPE_VIDEO_CAPTURE_DEVICE](#MediaDeviceType-media_device_type_video_capture_device) | | int | 4 | [MEDIA_DEVICE_TYPE_SCREEN_VIDEO_CAPTURE_DEVICE](#MediaDeviceType-media_device_type_screen_video_capture_device) | | int | 5 | [MEDIA_DEVICE_TYPE_SCREEN_AUDIO_CAPTURE_DEVICE](#MediaDeviceType-media_device_type_screen_audio_capture_device) | ## 变量说明 ### MEDIA_DEVICE_TYPE_AUDIO_UNKNOWN ```java public static final int com.ss.bytertc.engine.type.MediaDeviceType.MEDIA_DEVICE_TYPE_AUDIO_UNKNOWN = -1 ``` 未知设备 ### MEDIA_DEVICE_TYPE_AUDIO_RENDER_DEVICE ```java public static final int com.ss.bytertc.engine.type.MediaDeviceType.MEDIA_DEVICE_TYPE_AUDIO_RENDER_DEVICE = 0 ``` 音频渲染设备 ### MEDIA_DEVICE_TYPE_AUDIO_CAPTURE_DEVICE ```java public static final int com.ss.bytertc.engine.type.MediaDeviceType.MEDIA_DEVICE_TYPE_AUDIO_CAPTURE_DEVICE = 1 ``` 音频采集设备 ### MEDIA_DEVICE_TYPE_VIDEO_CAPTURE_DEVICE ```java public static final int com.ss.bytertc.engine.type.MediaDeviceType.MEDIA_DEVICE_TYPE_VIDEO_CAPTURE_DEVICE = 3 ``` 视频采集设备 ### MEDIA_DEVICE_TYPE_SCREEN_VIDEO_CAPTURE_DEVICE ```java public static final int com.ss.bytertc.engine.type.MediaDeviceType.MEDIA_DEVICE_TYPE_SCREEN_VIDEO_CAPTURE_DEVICE = 4 ``` 屏幕视频设备 ### MEDIA_DEVICE_TYPE_SCREEN_AUDIO_CAPTURE_DEVICE ```java public static final int com.ss.bytertc.engine.type.MediaDeviceType.MEDIA_DEVICE_TYPE_SCREEN_AUDIO_CAPTURE_DEVICE = 5 ``` 屏幕音频设备 # UserInfo ```java public class com.ss.bytertc.engine.UserInfo ``` 用户信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [uid](#UserInfo-uid) | | String | [extraInfo](#UserInfo-extrainfo) | ## 成员函数 | 返回 | 名称 | | --- | --- | | UserInfo | [UserInfo](#UserInfo-userinfo) | ## 变量说明 ### uid ```java public String com.ss.bytertc.engine.UserInfo.uid ``` 用户 ID。该字符串符合正则表达式：`[a-zA-Z0-9_@-.]{1,128}`。你需要自行设置或管理 uid，并保证同一房间内每个 uid 的唯一性。 ### extraInfo ```java public String com.ss.bytertc.engine.UserInfo.extraInfo ``` 用户的额外信息，最大长度为 200 字节。会在 `onUserJoined` 中回调给远端用户。 ## 函数说明 ### UserInfo ```java com.ss.bytertc.engine.UserInfo.UserInfo( String uid, String extraInfo ) ``` 用户信息 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 用户 ID。该字符串符合正则表达式：`[a-zA-Z0-9_@-.]{1,128}`。 | | extraInfo | String | 用户的额外信息，最大长度为 200 字节。会在 `onUserJoined` 中回调给远端用户。 | # ForwardStreamEvent ```java public enum com.ss.bytertc.engine.data.ForwardStreamEventInfo.ForwardStreamEvent ``` 跨房间转发媒体流过程中该目标房间发生的事件 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | FORWARD_STREAM_EVENT_DISCONNECTED | 0 | 本端与服务器网络连接断开，暂停转发。 | | FORWARD_STREAM_EVENT_CONNECTED | 1 | 本端与服务器网络连接恢复，转发服务连接成功。 | | FORWARD_STREAM_EVENT_INTERRUPT | 2 | 转发中断。转发过程中，如果相同 user_id 的用户进入目标房间，转发中断。 | | FORWARD_STREAM_EVENT_DST_ROOM_UPDATED | 3 | 目标房间已更新，由 `updateForwardStreamToRooms` 触发。 | | FORWARD_STREAM_EVENT_UN_EXPECT_API_CALL | 4 | API 调用时序错误。例如，在调用 `startForwardStreamToRooms` 之前调用 `updateForwardStreamToRooms`。 | # SubscribeMediaType ```java public enum com.ss.bytertc.engine.type.SubscribeMediaType ``` 订阅的媒体类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | NONE | 0 | 既不订阅音频，也不订阅视频 | | AUDIO_ONLY | 1 | 只订阅音频，不订阅视频 | | VIDEO_ONLY | 2 | 只订阅视频，不订阅音频 | | AUDIO_AND_VIDEO | 3 | 同时订阅音频和视频 | # ConnectionState ```java public enum com.ss.bytertc.engine.type.ConnectionState ``` SDK 与 RTC 服务器连接状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | CONNECTION_STATE_DISCONNECTED | 1 | 连接断开超过 12s，此时 SDK 会尝试自动重连。 | | CONNECTION_STATE_CONNECTING | 2 | 首次请求建立连接，正在连接中。 | | CONNECTION_STATE_CONNECTED | 3 | 首次连接成功。 | | CONNECTION_STATE_RECONNECTING | 4 | 涵盖了以下情况：

首次连接时，10 秒内未连接成功;

连接成功后，断连 10 秒。自动重连中。

| | CONNECTION_STATE_RECONNECTED | 5 | 连接断开后，重连成功。 | | CONNECTION_STATE_LOST | 6 | 处于 `CONNECTION_STATE_DISCONNECTED` 状态超过 10 秒，且期间重连未成功。SDK 仍将继续尝试重连。 | | CONNECTION_STATE_FAILED | 7 | 连接失败，服务端状态异常。SDK 不会自动重连，请重新进房，或联系技术支持。 | # RecordingType ```java public enum com.ss.bytertc.engine.type.RecordingType ``` 本地录制的媒体类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | RECORD_AUDIO_ONLY | 0 | 只录制音频 | | RECORD_VIDEO_ONLY | 1 | 只录制视频 | | RECORD_VIDEO_AND_AUDIO | 2 | 同时录制音频和视频 | # AudioConfig ```java public static class com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig ``` 音频转码配置参数。值不合法或未设置时，自动使用默认值。 ## 成员函数 | 返回 | 名称 | | --- | --- | | AudioConfig | [setCodec](#AudioConfig-setcodec) | | AudioConfig | [setKBitRate](#AudioConfig-setkbitrate) | | AudioConfig | [setSampleRate](#AudioConfig-setsamplerate) | | AudioConfig | [setChannels](#AudioConfig-setchannels) | | AudioConfig | [setAacProfile](#AudioConfig-setaacprofile) | ## 函数说明 ### setCodec ```java AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.setCodec(AudioCodecType codec) ``` 设置音频编码格式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | codec | AudioCodecType | 音频编码格式，参看 [AudioCodecType](#AudioCodecType)。默认值为 `AAC`。
本参数不支持过程中更新。 | ### setKBitRate ```java AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.setKBitRate(int kBitRate) ``` 设置音频码率。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | kBitRate | int | 音频码率，单位 Kbps。可取范围 [32, 192]，默认值为 64 Kbps。 | ### setSampleRate ```java AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.setSampleRate(int sampleRate) ``` 设置音频采样率。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | sampleRate | int | 音频采样率，单位 Hz。可取 32000 Hz、44100 Hz、48000 Hz，默认值为 48000 Hz。 | ### setChannels ```java AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.setChannels(int channels) ``` 设置声道数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | channels | int | 音频声道数。可取 1（单声道）、2（双声道），默认值为 2。 | ### setAacProfile ```java AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.setAacProfile(AACProfile aacProfile) ``` 设置 AAC 编码规格。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | aacProfile | AACProfile | AAC 规格，参看 [AACProfile](#AACProfile)。默认值为 `AAC_PROFILE_LC("LC")`。 | # MixedStreamPushMode ```java public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamPushMode ``` 服务端合流转推发起模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ON_STREAM | 0 | 无用户发布媒体流时，发起合流任务无效。默认设置。
当有用户发布媒体流时，才能发起合流任务。 | | ON_START_REQUEST | 1 | 无用户发布媒体流时，可以使用占位图发起合流任务。
占位图设置参看 [setAlternateImageURL](#MixedStreamLayoutRegionConfig-setalternateimageurl) 和 [setAlternateImageFillMode](#MixedStreamLayoutRegionConfig-setalternateimagefillmode)。 | # EarMonitorMode ```java public enum com.ss.bytertc.engine.data.EarMonitorMode ``` 是否开启耳返功能。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | EAR_MONITOR_MODE_OFF | 0 | 关闭（默认设置） | | EAR_MONITOR_MODE_ON | 1 | 开启 | # FirstFrameSendState ```java public enum com.ss.bytertc.engine.type.FirstFrameSendState ``` 首帧发送状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | FIRST_FRAME_SEND_STATE_SENDING | 0 | 发送中 | | FIRST_FRAME_SEND_STATE_SENT | 1 | 发送成功 | | FIRST_FRAME_SEND_STAT_END | 2 | 发送失败 | # MixedStreamMediaType ```java public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamMediaType ``` 合流输出内容类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MIXED_STREAM_MEDIA_TYPE_AUDIO_AND_VIDEO | 0 | 输出的混流包含音频和视频 | | MIXED_STREAM_MEDIA_TYPE_AUDIO_ONLY | 1 | 输出的混流只包含音频 | | MIXED_STREAM_MEDIA_TYPE_VIDEO_ONLY | 2 | 输出的混流只包含视频 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [getValue](#MixedStreamMediaType-getvalue) | ## 函数说明 ### getValue ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamMediaType.getValue() ``` 获取合流输出内容类型。 **返回值** 合流输出内容类型 # SubtitleMode ```java public enum com.ss.bytertc.engine.type.SubtitleMode ``` 字幕模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | SUBTITLE_MODE_RECOGINTE | 0 | 识别模式。在此模式下，房间内用户语音会被转为文字。 | | SUBTITLE_MODE_TRANSLATION | 1 | 翻译模式。在此模式下，房间内用户语音会先被转为文字，再被翻译为目标语言。 | # SourceWantedData ```java public class com.ss.bytertc.engine.type.SourceWantedData ``` 性能回退相关数据 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#SourceWantedData-width) | | int | [height](#SourceWantedData-height) | | int | [frameRate](#SourceWantedData-framerate) | ## 变量说明 ### width ```java public int com.ss.bytertc.engine.type.SourceWantedData.width ``` 如果未开启发送性能回退，此值表示推荐的视频输入宽度；如果开启了发送性能回退，此值表示当前推流的最大宽度。 ### height ```java public int com.ss.bytertc.engine.type.SourceWantedData.height ``` 如果未开启发送性能回退，此值表示推荐的视频输入高度；如果开启了发送性能回退，此值表示当前推流的最大高度。 ### frameRate ```java public int com.ss.bytertc.engine.type.SourceWantedData.frameRate ``` 如果未开启发送性能回退，此值表示推荐的视频输入帧率，单位 fps；如果开启了发送性能回退，此值表示当前推流的最大帧率，单位 fps。 # VoiceChangerType ```java public enum com.ss.bytertc.engine.type.VoiceChangerType ``` 变声特效类型。如需更多变声特效类型，联系技术支持。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | VOICE_CHANGER_ORIGINAL | 0 | 原声，不含特效 | | VOICE_CHANGER_GIANT | 1 | 巨人 | | VOICE_CHANGER_CHIPMUNK | 2 | 花栗鼠 | | VOICE_CHANGER_MINIONST | 3 | 小黄人 | | VOICE_CHANGER_VIBRATO | 4 | 颤音 | | VOICE_CHANGER_ROBOT | 5 | 机器人 | # VideoCodecType ```java public enum com.ss.bytertc.engine.VideoEncoderConfig.VideoCodecType ``` 编码模式(H264, ByteVC1) ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | CODEC_TYPE_AUTO | 0 | 其他 | | CODEC_TYPE_H264 | 1 | H264 | | CODEC_TYPE_BYTEVC1 | 2 | ByteVC1 | # EffectBeautyMode ```java public enum com.ss.bytertc.engine.data.EffectBeautyMode ``` 基础美颜模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | WHITE | 0 | 美白。 | | SMOOTH | 1 | 磨皮。 | | SHARPEN | 2 | 锐化。 | | CLEAR | 3 | 清晰，需集成 v4.4.2+ 版本的特效 SDK。 | # Orientation ```java public class com.ss.bytertc.engine.data.Orientation ``` 方向朝向信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [x](#Orientation-x) | | float | [y](#Orientation-y) | | float | [z](#Orientation-z) | ## 变量说明 ### x ```java public float com.ss.bytertc.engine.data.Orientation.x ``` x 坐标 ### y ```java public float com.ss.bytertc.engine.data.Orientation.y ``` y 坐标 ### z ```java public float com.ss.bytertc.engine.data.Orientation.z ``` z 坐标 # MusicHotType ```java public enum com.ss.bytertc.ktv.data.MusicHotType ``` 热榜类别。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | CONTENT_CENTER | 1 << 0 | 火山内容中心热歌榜。 | | PROJECT | 1 << 1 | 项目热歌榜。 | # MixedStreamAudioCodecType ```java public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.MixedStreamAudioCodecType ``` 音频编码格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MIXED_STREAM_AUDIO_CODEC_TYPE_AAC | AAC | AAC 格式。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | String | [getValue](#MixedStreamAudioCodecType-getvalue) | ## 函数说明 ### getValue ```java String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.MixedStreamAudioCodecType.getValue() ``` 获取音频编码格式。 **返回值** 音频编码格式。 # VideoStreamDescription ```java public class com.ss.bytertc.engine.VideoStreamDescription ``` 视频流参数描述 ## 成员变量 | 类型 | 名称 | | --- | --- | | Pair | [videoSize](#VideoStreamDescription-videosize) | | int | [frameRate](#VideoStreamDescription-framerate) | | int | [maxKbps](#VideoStreamDescription-maxkbps) | | int | [minKbps](#VideoStreamDescription-minkbps) | | EncoderPreference | [encodePreference](#VideoStreamDescription-encodepreference) | ## 变量说明 ### videoSize ```java public Pair com.ss.bytertc.engine.VideoStreamDescription.videoSize ``` 视频分辨率 ### frameRate ```java public int com.ss.bytertc.engine.VideoStreamDescription.frameRate ``` 视频帧率 ### maxKbps ```java public int com.ss.bytertc.engine.VideoStreamDescription.maxKbps ``` 最高编码码率（千比特每秒）。建议使用 `-1`，SDK 会自动根据分辨率和帧率适配合适的码率。 ### minKbps ```java public int com.ss.bytertc.engine.VideoStreamDescription.minKbps = 0 ``` ### encodePreference ```java public EncoderPreference com.ss.bytertc.engine.VideoStreamDescription.encodePreference = EncoderPreference.MaintainFramerate ``` 编码策略偏好，详见 [EncoderPreference](#EncoderPreference) # LocalLogLevel ```java public enum com.ss.bytertc.engine.data.LocalLogLevel ``` 本地日志输出等级。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | INFO | 0 | 信息级别。 | | WARNING | 1 | （默认值）警告级别。 | | ERROR | 2 | 错误级别。 | | NONE | 3 | 关闭日志。 | # ForwardStreamState ```java public enum com.ss.bytertc.engine.data.ForwardStreamStateInfo.ForwardStreamState ``` 媒体流跨房间转发状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | FORWARD_STREAM_STATE_IDLE | 0 | 空闲状态

成功调用 `stopForwardStreamToRooms` 后，所有目标房间为空闲状态。

成功调用 `updateForwardStreamToRooms` 减少目标房间后，本次减少的目标房间为空闲状态。

| | FORWARD_STREAM_STATE_SUCCESS | 1 | 开始转发

调用 `startForwardStreamToRooms` 成功向所有房间开始转发媒体流后，返回此状态。

调用 `updateForwardStreamToRooms` 后，成功向新增目标房间开始转发媒体流后，返回此状态。

| | FORWARD_STREAM_STATE_FAILURE | 2 | 转发失败，失败详情参考 [ForwardStreamError](#ForwardStreamError)
调用 `startForwardStreamToRooms` 或 `updateForwardStreamToRooms` 后，如遇转发失败，返回此状态。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [value](#ForwardStreamState-value) | ## 函数说明 ### value ```java int com.ss.bytertc.engine.data.ForwardStreamStateInfo.ForwardStreamState.value() ``` 获取当前值 # TorchState ```java public enum com.ss.bytertc.engine.type.TorchState ``` 相机闪光灯状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TORCH_STATE_OFF | 0 | 关闭 | | TORCH_STATE_ON | 1 | 打开 | # VideoCodecType ```java public enum com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.VideoCodecType ``` 视频编码格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | VIDEO_CODEC_TYPE_H264 | H264 | H.264 格式，默认值。 | | VIDEO_CODEC_TYPE_BYTEVC1 | ByteVC1 | ByteVC1 格式。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | String | [getValue](#VideoCodecType-getvalue) | ## 函数说明 ### getValue ```java String com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.VideoCodecType.getValue() ``` 获取视频编码格式。 **返回值** 视频编码格式。 # RTCASRConfig ```java public class com.ss.bytertc.engine.data.RTCASRConfig ``` 使用自动语音识别服务所需校验信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [userId](#RTCASRConfig-userid) | | String | [accessToken](#RTCASRConfig-accesstoken) | | String | [secretKey](#RTCASRConfig-secretkey) | | ASRAuthorizationType | [authorizationType](#RTCASRConfig-authorizationtype) | | String | [cluster](#RTCASRConfig-cluster) | | String | [appId](#RTCASRConfig-appid) | ## 变量说明 ### userId ```java public String com.ss.bytertc.engine.data.RTCASRConfig.userId ``` 用户 ID ### accessToken ```java public String com.ss.bytertc.engine.data.RTCASRConfig.accessToken ``` 访问令牌 ### secretKey ```java public String com.ss.bytertc.engine.data.RTCASRConfig.secretKey ``` 私钥。Signature 鉴权模式下不能为空，token 鉴权模式下为空。参看[关于鉴权](https://www.volcengine.com/docs/6561/107789) ### authorizationType ```java public ASRAuthorizationType com.ss.bytertc.engine.data.RTCASRConfig.authorizationType ``` 鉴权方式 ### cluster ```java public String com.ss.bytertc.engine.data.RTCASRConfig.cluster ``` 场景信息，参看[业务集群](https://www.volcengine.com/docs/6561/80818#_3-2-2-%E5%8F%91%E9%80%81-full-client-request) ### appId ```java public String com.ss.bytertc.engine.data.RTCASRConfig.appId ``` 应用 ID # RTCASRErrorCode ```java public enum com.ss.bytertc.engine.handler.IRTCASREngineEventHandler.RTCASRErrorCode ``` 语音识别服务错误码。除网络原因导致的错误，语音识别服务内部会自行重试之外，其他错误都会停止服务，此时建议再次调用 `startASR` 重启语音识别功能。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | NETWORK_INTERRUPTED | -1 | 网络连接中断，服务不可用，内部会进行重连 | | ALREADY_STARTED | -2 | 重复调用 `startASR`。开启语音识别服务后，你需要先调用 `stopASR` 停止语音识别服务，才能二次调用 `startASR` 再次开启服务。 | | TOKEN_EMPTY | -3 | 语音识别服务所需 token 为空 | | SIGNATURE_KEY_EMPTY | -4 | Signature 鉴权模式下 secretKey 为空 | | USERID_NULL | -5 | 用户 ID 为空 | | APPID_NULL | -6 | 应用 ID 为空 | | CLUSTER_NULL | -7 | 语音识别服务 cluster 为空 | | OPERATION_DENIED | -8 | 语音识别服务连接失败，该版本没有语音识别功能，请联系 RTC 技术支持。 | # ForwardStreamEventInfo ```java public class com.ss.bytertc.engine.data.ForwardStreamEventInfo ``` 跨房间转发媒体流过程中的不同目标房间发生的事件 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [roomId](#ForwardStreamEventInfo-roomid) | | ForwardStreamEvent | [event](#ForwardStreamEventInfo-event) | ## 变量说明 ### roomId ```java public String com.ss.bytertc.engine.data.ForwardStreamEventInfo.roomId ``` 跨房间转发媒体流过程中的发生该事件的目标房间 ID 空字符串代表所有目标房间 ### event ```java public ForwardStreamEvent com.ss.bytertc.engine.data.ForwardStreamEventInfo.event ``` 跨房间转发媒体流过程中该目标房间发生的事件，参看 [ForwardStreamEvent](#ForwardStreamEvent)。 # RecordingConfig ```java public class com.ss.bytertc.engine.data.RecordingConfig ``` 本地录制参数配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [dirPath](#RecordingConfig-dirpath) | | RecordingFileType | [recordingFileType](#RecordingConfig-recordingfiletype) | ## 变量说明 ### dirPath ```java public String com.ss.bytertc.engine.data.RecordingConfig.dirPath ``` 录制文件保存的绝对路径，需精确到文件夹，文件名由 RTC 自动生成。你需要确保对该路径具有读写权限。 ### recordingFileType ```java public RecordingFileType com.ss.bytertc.engine.data.RecordingConfig.recordingFileType = RecordingFileType.MP4 ``` 录制存储文件格式，参看 [RecordingFileType](#RecordingFileType) # VideoCaptureConfig ```java public class com.ss.bytertc.engine.video.VideoCaptureConfig ``` 视频采集配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | CapturePreference | [capturePreference](#VideoCaptureConfig-capturepreference) | | int | [width](#VideoCaptureConfig-width) | | int | [height](#VideoCaptureConfig-height) | | int | [frameRate](#VideoCaptureConfig-framerate) | ## 变量说明 ### capturePreference ```java public CapturePreference com.ss.bytertc.engine.video.VideoCaptureConfig.capturePreference = CapturePreference.AUTO ``` 视频采集模式，参看 [CapturePreference](#CapturePreference)。 ### width ```java public int com.ss.bytertc.engine.video.VideoCaptureConfig.width ``` 视频采集分辨率的宽度，单位：px。 ### height ```java public int com.ss.bytertc.engine.video.VideoCaptureConfig.height ``` 视频采集分辨率的高度，单位：px。 ### frameRate ```java public int com.ss.bytertc.engine.video.VideoCaptureConfig.frameRate ``` 视频采集帧率，单位：fps。 # HumanOrientation ```java public class com.ss.bytertc.engine.data.HumanOrientation ``` 三维朝向信息，三个向量需要两两垂直。参看 [Orientation](#Orientation)。 ## 成员变量 | 类型 | 名称 | | --- | --- | | Orientation | [forward](#HumanOrientation-forward) | | Orientation | [right](#HumanOrientation-right) | | Orientation | [up](#HumanOrientation-up) | ## 变量说明 ### forward ```java public Orientation com.ss.bytertc.engine.data.HumanOrientation.forward ``` 正前方朝向，默认值为 `{1,0,0}`，即正前方朝向 x 轴正方向 ### right ```java public Orientation com.ss.bytertc.engine.data.HumanOrientation.right ``` 正右方朝向，默认值为 `{0,1,0}`，即右手朝向 y 轴正方向 ### up ```java public Orientation com.ss.bytertc.engine.data.HumanOrientation.up ``` 正上方朝向，默认值为 `{0,0,1}`，即头顶朝向 z 轴正方向 # LocalAudioPropertiesInfo ```java public class com.ss.bytertc.engine.data.LocalAudioPropertiesInfo ``` 本地音频属性信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | StreamIndex | [streamIndex](#LocalAudioPropertiesInfo-streamindex) | | AudioPropertiesInfo | [audioPropertiesInfo](#LocalAudioPropertiesInfo-audiopropertiesinfo) | ## 变量说明 ### streamIndex ```java public StreamIndex com.ss.bytertc.engine.data.LocalAudioPropertiesInfo.streamIndex ``` 流属性，主流或屏幕流。参看 [StreamIndex](#StreamIndex) ### audioPropertiesInfo ```java public AudioPropertiesInfo com.ss.bytertc.engine.data.LocalAudioPropertiesInfo.audioPropertiesInfo ``` 音频属性信息，详见 [AudioPropertiesInfo](#AudioPropertiesInfo)。 # DataParam ```java public static class com.ss.bytertc.engine.live.LiveTranscoding.Region.DataParam ``` 图片合流相关参数。 ## 成员函数 | 返回 | 名称 | | --- | --- | | Region.DataParam | [setImageWidth](#DataParam-setimagewidth) | | Region.DataParam | [setImageHeight](#DataParam-setimageheight) | ## 函数说明 ### setImageWidth ```java Region.DataParam com.ss.bytertc.engine.live.LiveTranscoding.Region.DataParam.setImageWidth(int imageWidth) ``` 设置原始图片的宽度 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageWidth | int | 宽度，单位为 px。 | ### setImageHeight ```java Region.DataParam com.ss.bytertc.engine.live.LiveTranscoding.Region.DataParam.setImageHeight(int imageHeight) ``` 原始图片的高度 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageHeight | int | 高度，单位为 px。 | # ByteRTCStreamMixingEvent ```java public enum com.ss.bytertc.engine.live.ByteRTCStreamMixingEvent ``` 转推直播任务状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | STREAM_MIXING_START | 1 | 请求发起转推直播任务 | | STREAM_MIXING_START_SUCCESS | 2 | 发起转推直播任务成功 | | STREAM_MIXING_START_FAILED | 3 | 发起转推直播任务失败 | | STREAM_MIXING_UPDATE | 4 | 请求更新转推直播任务配置 | | STREAM_MIXING_UPDATE_SUCCESS | 5 | 成功更新转推直播任务配置 | | STREAM_MIXING_UPDATE_FAILED | 6 | 更新转推直播任务配置失败 | | STREAM_MIXING_STOP | 7 | 请求结束转推直播任务 | | STREAM_MIXING_STOP_SUCCESS | 8 | 结束转推直播任务成功 | | STREAM_MIXING_STOP_FAILED | 9 | 结束转推直播任务失败 | | STREAM_MIXING_CHANGE_MIX_TYPE | 10 | 更新转推直播任务配置的请求超时 | | STREAM_MIXING_FIRST_AUDIO_FRAME_BY_CLIENT_MIX | 11 | 得到客户端合流音频首帧 | | STREAM_MIXING_FIRST_VIDEO_FRAME_BY_CLIENT_MIX | 12 | 收到客户端合流视频首帧 | | STREAM_MIXING_UPDATE_TIMEOUT | 13 | 更新转推直播任务配置超时 | | STREAM_MIXING_START_TIMEOUT | 14 | 发起转推直播任务配置超时 | | STREAM_MIXING_REQUEST_PARAM_ERROR | 15 | 合流布局参数错误 | | STREAM_MIXING_MIX_IMAGE_EVENT | 16 | 合流加图片 | # AudioAlignmentMode ```java public enum com.ss.bytertc.engine.data.AudioAlignmentMode ``` 远端音频流精准对齐模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_ALIGNMENT_MODE_OFF | 0 | 不对齐 | | AUDIO_ALIGNMENT_MODE_AUDIOMIXING | 1 | 远端音频流都对齐伴奏进度同步播放 | # FallbackOrRecoverReason ```java public enum com.ss.bytertc.engine.type.FallbackOrRecoverReason ``` 远端订阅流发生回退或恢复的原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | FALLBACK_OR_RECOVER_REASON_UNKNOWN | -1 | 其他原因，非带宽和性能原因引起的回退或恢复。默认值 | | FALLBACK_OR_RECOVER_REASON_SUBSCRIBE_FALLBACK_BY_BANDWIDTH | 0 | 由带宽不足导致的订阅端音视频流回退。 | | FALLBACK_OR_RECOVER_REASON_SUBSCRIBE_FALLBACK_BY_PERFORMANCE | 1 | 由性能不足导致的订阅端音视频流回退。 | | FALLBACK_OR_RECOVER_REASON_SUBSCRIBE_RECOVER_BY_BANDWIDTH | 2 | 由带宽恢复导致的订阅端音视频流恢复。 | | FALLBACK_OR_RECOVER_REASON_SUBSCRIBE_RECOVER_BY_PERFORMANCE | 3 | 由性能恢复导致的订阅端音视频流恢复。 | | FALLBACK_OR_RECOVER_REASON_PUBLISH_FALLBACK_BY_BANDWIDTH | 4 | 由带宽不足导致的发布端音视频流回退。 | | FALLBACK_OR_RECOVER_REASON_PUBLISH_FALLBACK_BY_PERFORMANCE | 5 | 由性能不足导致的发布端音视频流回退。 | | FALLBACK_OR_RECOVER_REASON_PUBLISH_RECOVER_BY_BANDWIDTH | 6 | 由带宽恢复导致的发布端音视频流恢复。 | | FALLBACK_OR_RECOVER_REASON_PUBLISH_RECOVER_BY_PERFORMANCE | 7 | 由性能恢复导致的发布端音视频流恢复。 | # SEIStreamUpdateEvent ```java public enum com.ss.bytertc.engine.type.SEIStreamUpdateEvent ``` 黑帧视频流状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | STREAM_ADD | 0 | 远端用户发布黑帧视频流。
纯语音通话场景下，远端用户调用 [sendSEIMessage](70080#RTCVideo-sendseimessage) 发送 SEI 数据时，SDK 会自动发布一路黑帧视频流，并触发该回调。 | | STREAM_REMOVE | 1 | 远端黑帧视频流移除。该回调的触发时机包括：

远端用户开启摄像头采集，由语音通话切换至视频通话，黑帧视频流停止发布；

远端用户调用 [sendSEIMessage](70080#RTCVideo-sendseimessage) 后 1min 内未有 SEI 数据发送，黑帧视频流停止发布；

远端用户调用 [setVideoSourceType](70080#RTCVideo-setvideosourcetype) 切换至自定义视频采集时，黑帧视频流停止发布。

| # RemoteStreamStats ```java public class com.ss.bytertc.engine.type.RemoteStreamStats ``` 用户订阅的远端音/视频流统计信息以及网络状况，统计周期为 2s 。订阅远端用户发布音/视频流成功后，SDK 会周期性地通过 `onRemoteStreamStats` 通知本地用户订阅的远端音/视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [uid](#RemoteStreamStats-uid) | | RemoteAudioStats | [audioStats](#RemoteStreamStats-audiostats) | | RemoteVideoStats | [videoStats](#RemoteStreamStats-videostats) | | boolean | [isScreen](#RemoteStreamStats-isscreen) | | int | [deprecated] [txQuality](#RemoteStreamStats-txquality) | | int | [deprecated] [rxQuality](#RemoteStreamStats-rxquality) | ## 变量说明 ### uid ```java public String com.ss.bytertc.engine.type.RemoteStreamStats.uid ``` 用户 ID 。音/视频来源的远端用户 ID 。 ### audioStats ```java public RemoteAudioStats com.ss.bytertc.engine.type.RemoteStreamStats.audioStats ``` 远端音频流的统计信息，详见 [RemoteAudioStats](#RemoteAudioStats) ### videoStats ```java public RemoteVideoStats com.ss.bytertc.engine.type.RemoteStreamStats.videoStats ``` 远端视频流的统计信息，详见 [RemoteVideoStats](#RemoteVideoStats) ### isScreen ```java public boolean com.ss.bytertc.engine.type.RemoteStreamStats.isScreen ``` 所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。 ### txQuality ```java public int com.ss.bytertc.engine.type.RemoteStreamStats.txQuality ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onNetworkQuality](70081#IRTCRoomEventHandler-onnetworkquality) instead. 所属用户的媒体流上行网络质量，详见 [NetworkQuality](#NetworkQuality)。 ### rxQuality ```java public int com.ss.bytertc.engine.type.RemoteStreamStats.rxQuality ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onNetworkQuality](70081#IRTCRoomEventHandler-onnetworkquality) instead. 所属用户的媒体流下行网络质量，详见 [NetworkQuality](#NetworkQuality)。 # MediaDeviceWarning ```java public class com.ss.bytertc.engine.type.MediaDeviceWarning ``` 媒体设备警告 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [MEDIA_DEVICE_WARNING_OK](#MediaDeviceWarning-media_device_warning_ok) | | int | [MEDIA_DEVICE_WARNING_OPERATION_DENIED](#MediaDeviceWarning-media_device_warning_operation_denied) | | int | [MEDIA_DEVICE_WARNING_CAPTURE_SILENCE](#MediaDeviceWarning-media_device_warning_capture_silence) | | int | [MEDIA_DEVICE_WARNING_ANDROID_SYS_SILENCE](#MediaDeviceWarning-media_device_warning_android_sys_silence) | | int | [MEDIA_DEVICE_WARNING_ANDROID_SYS_SILENCE_DISAPPEAR](#MediaDeviceWarning-media_device_warning_android_sys_silence_disappear) | | int | [MEDIA_DEVICE_WARNING_DETECT_LEAK_ECHO](#MediaDeviceWarning-media_device_warning_detect_leak_echo) | | int | [MEDIA_DEVICE_WARNING_CAPTURE_DETECT_HOWLING](#MediaDeviceWarning-media_device_warning_capture_detect_howling) | | int | [MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_INVALID_SCENARIO](#MediaDeviceWarning-media_device_warning_set_audio_route_invalid_scenario) | | int | [MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_NOT_EXISTS](#MediaDeviceWarning-media_device_warning_set_audio_route_not_exists) | | int | [MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_FAILED_BY_PRIORITY](#MediaDeviceWarning-media_device_warning_set_audio_route_failed_by_priority) | | int | [MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_NOT_VOIP_MODE](#MediaDeviceWarning-media_device_warning_set_audio_route_not_voip_mode) | | int | [MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_DEVICE_NOT_START](#MediaDeviceWarning-media_device_warning_set_audio_route_device_not_start) | ## 变量说明 ### MEDIA_DEVICE_WARNING_OK ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_OK = 0 ``` 无警告 ### MEDIA_DEVICE_WARNING_OPERATION_DENIED ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_OPERATION_DENIED = 1 ``` 非法设备操作。在使用外部设备时，调用了 SDK 内部设备 API。 ### MEDIA_DEVICE_WARNING_CAPTURE_SILENCE ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_CAPTURE_SILENCE = 2 ``` 采集到的数据为静音帧。 ### MEDIA_DEVICE_WARNING_ANDROID_SYS_SILENCE ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_ANDROID_SYS_SILENCE = 3 ``` Android 特有的静音，系统层面的静音上报 ### MEDIA_DEVICE_WARNING_ANDROID_SYS_SILENCE_DISAPPEAR ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_ANDROID_SYS_SILENCE_DISAPPEAR = 4 ``` Android 特有的静音消失 ### MEDIA_DEVICE_WARNING_DETECT_LEAK_ECHO ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_DETECT_LEAK_ECHO = 11 ``` 通话中出现回声现象。当 [ChannelProfile](#ChannelProfile) 为 `CHANNEL_PROFIEL_MEETING` 和 `CHANNEL_PROFILE_MEETING_ROOM`，且 AEC 关闭时，SDK 自动启动回声检测，如果检测到回声问题，将通过 `onAudioDeviceWarning` 返回本枚举值。 ### MEDIA_DEVICE_WARNING_CAPTURE_DETECT_HOWLING ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_CAPTURE_DETECT_HOWLING = 16 ``` 啸叫。触发该回调的情况如下：1）不支持啸叫抑制的房间模式下，检测到啸叫；2）支持啸叫抑制的房间模式下，检测到未被抑制的啸叫。仅 CHANNEL_PROFILE_COMMUNICATION(0)、CHANNEL_PROFIEL_MEETING(16)、CHANNEL_PROFILE_MEETING_ROOM(17) 三种房间模式支持啸叫抑制。建议提醒用户检查客户端的距离或将麦克风和扬声器调至静音。 ### MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_INVALID_SCENARIO ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_INVALID_SCENARIO = 20 ``` 当前 AudioScenario 不支持更改音频路由，设置音频路由失败 ### MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_NOT_EXISTS ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_NOT_EXISTS = 21 ``` 音频设备不存在，设置音频路由失败 ### MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_FAILED_BY_PRIORITY ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_FAILED_BY_PRIORITY = 22 ``` 音频路由被系统或其他应用占用，设置音频路由失败 ### MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_NOT_VOIP_MODE ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_NOT_VOIP_MODE = 23 ``` 当前非通话模式 AUDIO_SCENARIO_COMMUNICATION(2)，不支持设置音频路由 ### MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_DEVICE_NOT_START ```java public static final int com.ss.bytertc.engine.type.MediaDeviceWarning.MEDIA_DEVICE_WARNING_SET_AUDIO_ROUTE_DEVICE_NOT_START = 24 ``` 音频设备未启动，设置音频路由失败 # RemoteVideoRenderConfig ```java public class com.ss.bytertc.engine.RemoteVideoRenderConfig ``` 远端视频帧渲染设置 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [renderMode](#RemoteVideoRenderConfig-rendermode) | | int | [backgroundColor](#RemoteVideoRenderConfig-backgroundcolor) | | VideoRotation | [renderRotation](#RemoteVideoRenderConfig-renderrotation) | ## 变量说明 ### renderMode ```java public int com.ss.bytertc.engine.RemoteVideoRenderConfig.renderMode ``` 渲染模式。 - 1（`RENDER_MODE_HIDDEN`）：视窗填满优先，默认值。视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长大于等于视窗对应边长。 - 2（`RENDER_MODE_FIT`）：视频帧内容全部显示优先。视频帧等比缩放，直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同，视窗上未被视频帧填满区域将填充 `backgroundColor`。缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长小于等于视窗对应边长。 - 3（`RENDER_MODE_FILL`）：视频帧自适应画布。视频帧非等比缩放，直至画布被填满。在此过程中，视频帧的长宽比例可能会发生变化。 ### backgroundColor ```java public int com.ss.bytertc.engine.RemoteVideoRenderConfig.backgroundColor ``` 用于填充画布空白部分的背景颜色。取值范围是 `[0x00000000, 0xFFFFFFFF]`。默认值是 `0x00000000`。其中，透明度设置无效。 ### renderRotation ```java public VideoRotation com.ss.bytertc.engine.RemoteVideoRenderConfig.renderRotation ``` 视频帧旋转角度。参看 [VideoRotation](#VideoRotation)。默认为 0 度，即不做旋转处理。 # AudioProfileType ```java public enum com.ss.bytertc.engine.type.AudioProfileType ``` 音质档位 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_PROFILE_DEFAULT | 0 | 默认音质
服务器下发或客户端已设置的 [ChannelProfile](#ChannelProfile) 的音质配置 | | AUDIO_PROFILE_FLUENT | 1 | 流畅。
单声道，采样率为 16 kHz，编码码率为 32 Kbps。
流畅优先、低功耗、低流量消耗，适用于大部分游戏场景，如小队语音、组队语音、国战语音等。 | | AUDIO_PROFILE_STANDARD | 2 | 单声道标准音质。
采样率为 24 kHz，编码码率为 48 Kbps。
适用于对音质有一定要求的场景，同时延时、功耗和流量消耗相对适中，适合教育场景和狼人杀等游戏。 | | AUDIO_PROFILE_HD | 3 | 双声道音乐音质
采样率为 48 kHz，编码码率为 128 kbps。
超高音质，同时延时、功耗和流量消耗相对较大，适用于连麦 PK 等音乐场景。
游戏场景不建议使用。 | | AUDIO_PROFILE_STANDARD_STEREO | 4 | 双声道标准音质。采样率为 48 KHz，编码码率最大值为 80 Kbps | | AUDIO_PROFILE_HD_MONO | 5 | 单声道音乐音质。采样率为 48 kHz，编码码率最大值为 64 Kbps | # CameraId ```java public enum com.ss.bytertc.engine.data.CameraId ``` 摄像头类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | CAMERA_ID_FRONT | 0 | 前置摄像头 | | CAMERA_ID_BACK | 1 | 后置摄像头（默认设置） | | CAMERA_ID_INVALID | 3 | 无效值 | # SingScoringRealtimeInfo ```java public class com.ss.bytertc.engine.data.SingScoringRealtimeInfo ``` 实时评分信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [currentPosition](#SingScoringRealtimeInfo-currentposition) | | int | [userPitch](#SingScoringRealtimeInfo-userpitch) | | int | [standardPitch](#SingScoringRealtimeInfo-standardpitch) | | int | [sentenceIndex](#SingScoringRealtimeInfo-sentenceindex) | | int | [sentenceScore](#SingScoringRealtimeInfo-sentencescore) | | int | [totalScore](#SingScoringRealtimeInfo-totalscore) | | int | [averageScore](#SingScoringRealtimeInfo-averagescore) | ## 成员函数 | 返回 | 名称 | | --- | --- | | String | [toString](#SingScoringRealtimeInfo-tostring) | ## 变量说明 ### currentPosition ```java public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.currentPosition ``` 当前播放进度。 ### userPitch ```java public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.userPitch ``` 演唱者的音高。 ### standardPitch ```java public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.standardPitch ``` 标准音高。 ### sentenceIndex ```java public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.sentenceIndex ``` 歌词分句索引。 ### sentenceScore ```java public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.sentenceScore ``` 上一句歌词的评分。 ### totalScore ```java public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.totalScore ``` 当前演唱的累计分数。 ### averageScore ```java public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.averageScore ``` 当前演唱的平均分数。 ## 函数说明 ### toString ```java String com.ss.bytertc.engine.data.SingScoringRealtimeInfo.toString() ``` # CodecMode ```java public enum com.ss.bytertc.engine.VideoEncoderConfig.CodecMode ``` 编码器 Mode(使用软编码或者硬编码) ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | CODEC_MODE_AUTO | 0 | 自动模式 | | CODEC_MODE_HARDWARE | 1 | 硬编码模式 | | CODEC_MODE_SOFTWARE | 2 | 软编码模式 | # RemoteVideoRenderPosition ```java public enum com.ss.bytertc.engine.video.RemoteVideoRenderPosition ``` 远端视频帧回调位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AFTER_POST_PROCESS | 1 | （默认值）后处理后。 | # TranscoderLayoutRegionType ```java public enum com.ss.bytertc.engine.live.LiveTranscoding.TranscoderLayoutRegionType ``` 合流布局区域类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | LAYOUT_REGION_TYPE_VIDEO_STREAM | 0 | 合流布局区域类型为视频。 | | LAYOUT_REGION_TYPE_IMAGE | 1 | 合流布局区域类型为图片。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [getValue](#TranscoderLayoutRegionType-getvalue) | ## 函数说明 ### getValue ```java int com.ss.bytertc.engine.live.LiveTranscoding.TranscoderLayoutRegionType.getValue() ``` 获取合流布局区域类型。 **返回值** 合流布局区域类型。 # AudioEffectPlayerConfig ```java public class com.ss.bytertc.engine.data.AudioEffectPlayerConfig ``` 混音配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | AudioMixingType | [type](#AudioEffectPlayerConfig-type) | | int | [playCount](#AudioEffectPlayerConfig-playcount) | | int | [startPos](#AudioEffectPlayerConfig-startpos) | | int | [pitch](#AudioEffectPlayerConfig-pitch) | ## 变量说明 ### type ```java public AudioMixingType com.ss.bytertc.engine.data.AudioEffectPlayerConfig.type = AudioMixingType.AUDIO_MIXING_TYPE_PLAYOUT_AND_PUBLISH ``` 混音播放类型，详见 [AudioMixingType](#AudioMixingType) ### playCount ```java public int com.ss.bytertc.engine.data.AudioEffectPlayerConfig.playCount = 1 ``` 混音播放次数 - play_count <= 0: 无限循环 - play_count == 1: 播放一次（默认） - play_count \> 1: 播放 play_count 次 ### startPos ```java public int com.ss.bytertc.engine.data.AudioEffectPlayerConfig.startPos = 0 ``` 混音起始位置。默认值为 0，单位为毫秒。 ### pitch ```java public int com.ss.bytertc.engine.data.AudioEffectPlayerConfig.pitch = 0 ``` 与音乐文件原始音调相比的升高/降低值，取值范围为 `[-12，12]`，默认值为 0。每相邻两个值的音高距离相差半音，正值表示升调，负值表示降调。 # MixedStreamLayoutRegionImageWaterMarkConfig ```java public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamLayoutRegionImageWaterMarkConfig ``` 图片合流相关参数。 ## 成员函数 | 返回 | 名称 | | --- | --- | | MixedStreamLayoutRegionImageWaterMarkConfig | [setImageHeight](#MixedStreamLayoutRegionImageWaterMarkConfig-setimageheight) | | int | [getImageHeight](#MixedStreamLayoutRegionImageWaterMarkConfig-getimageheight) | | MixedStreamLayoutRegionImageWaterMarkConfig | [setImageWidth](#MixedStreamLayoutRegionImageWaterMarkConfig-setimagewidth) | | int | [getImageWidth](#MixedStreamLayoutRegionImageWaterMarkConfig-getimagewidth) | ## 函数说明 ### setImageHeight ```java MixedStreamLayoutRegionImageWaterMarkConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamLayoutRegionImageWaterMarkConfig.setImageHeight(int imageHeight) ``` 设置原始图片的高度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageHeight | int | 原始图片高度，单位为 px。 | ### getImageHeight ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamLayoutRegionImageWaterMarkConfig.getImageHeight() ``` 获取原始图片的高度。 ### setImageWidth ```java MixedStreamLayoutRegionImageWaterMarkConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamLayoutRegionImageWaterMarkConfig.setImageWidth(int imageWidth) ``` 设置原始图片的宽度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageWidth | int | 原始图片宽度，单位为 px。 | ### getImageWidth ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamLayoutRegionImageWaterMarkConfig.getImageWidth() ``` 获取原始图片的宽度。 # LocalVideoStreamError ```java public enum com.ss.bytertc.engine.type.LocalVideoStreamError ``` 本地视频状态改变时的错误码 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | LOCAL_VIDEO_STREAM_ERROR_OK | 0 | 状态正常（本地视频状态改变正常时默认返回值） | | LOCAL_VIDEO_STREAM_ERROR_FAILURE | 1 | 本地视频流发布失败 | | LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION | 2 | 没有权限启动本地视频采集设备 | | LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY | 3 | 本地视频采集设备已被占用 | | LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND | 4 | 本地视频采集设备不存在或已移除 | | LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE | 5 | 本地视频采集失败，建议检查采集设备是否正常工作 | | LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE | 6 | 本地视频编码失败 | | LOCAL_VIDEO_STREAM_ERROR_DEVICE_DISCONNECTED | 7 | 通话过程中本地视频采集设备被其他程序抢占，导致设备连接中断 | # NetworkQualityStats ```java public class com.ss.bytertc.engine.type.NetworkQualityStats ``` 上行/下行网络质量 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [uid](#NetworkQualityStats-uid) | | double | [fractionLost](#NetworkQualityStats-fractionlost) | | int | [rtt](#NetworkQualityStats-rtt) | | int | [totalBandwidth](#NetworkQualityStats-totalbandwidth) | | int | [txQuality](#NetworkQualityStats-txquality) | | int | [rxQuality](#NetworkQualityStats-rxquality) | ## 成员函数 | 返回 | 名称 | | --- | --- | | String | [toString](#NetworkQualityStats-tostring) | ## 变量说明 ### uid ```java public String com.ss.bytertc.engine.type.NetworkQualityStats.uid ``` 用户 id ### fractionLost ```java public double com.ss.bytertc.engine.type.NetworkQualityStats.fractionLost ``` 本端的上行/下行的丢包率，范围 [0.0,1.0] 当 `uid` 为本地用户时，代表发布流的上行丢包率。当 `uid` 为远端用户时，代表接收所有订阅流的下行丢包率。 ### rtt ```java public int com.ss.bytertc.engine.type.NetworkQualityStats.rtt ``` 当 `uid` 为本地用户时有效，客户端到服务端的往返延时（RTT），单位：ms ### totalBandwidth ```java public int com.ss.bytertc.engine.type.NetworkQualityStats.totalBandwidth ``` 本端的音视频 RTP 包 2 秒内的平均传输速率，单位：bps 当 `uid` 为本地用户时，代表发送速率。当 `uid` 为远端用户时，代表所有订阅流的接收速率。 ### txQuality ```java public int com.ss.bytertc.engine.type.NetworkQualityStats.txQuality ``` 上行网络质量分。分数越高网络质量越差，详见 [NetworkQuality](#NetworkQuality)。 ### rxQuality ```java public int com.ss.bytertc.engine.type.NetworkQualityStats.rxQuality ``` 下行网络质量分。分数越高网络质量越差，详见 [NetworkQuality](#NetworkQuality)。 ## 函数说明 ### toString ```java String com.ss.bytertc.engine.type.NetworkQualityStats.toString() ``` # UserVisibilityChangeError ```java public enum com.ss.bytertc.engine.type.UserVisibilityChangeError ``` 用户可见性状态改变错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | OK | 0 | 成功。 | | UNKNOWN | 1 | 未知错误。 | | TOO_MANY_VISIBLE_USER | 2 | 房间内可见用户达到上限。 | # PublishFallbackOption ```java public enum com.ss.bytertc.engine.type.PublishFallbackOption ``` 发布端音视频流回退选项 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | DISABLE | 0 | 上行网络不佳或设备性能不足时，不对音视频流作回退处理。默认设置。 | | SIMULCAST_SMALL_VIDEO_ONLY | 1 | 上行网络不佳或设备性能不足时，发布的视频流会从大流到小流依次降级，直到与当前网络性能匹配，具体降级规则参看[性能回退](https://www.volcengine.com/docs/6348/70137)文档。 | ## 静态函数 | 返回 | 名称 | | --- | --- | | static PublishFallbackOption | [fromId](#PublishFallbackOption-fromid) | ## 函数说明 ### fromId ```java static PublishFallbackOption com.ss.bytertc.engine.type.PublishFallbackOption.fromId(int id) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | id | int | - | # LocalAudioStreamError ```java public enum com.ss.bytertc.engine.data.LocalAudioStreamError ``` 本地音频流状态改变时的错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | LOCAL_AUDIO_STREAM_ERROR_OK | 0 | 本地音频状态正常 | | LOCAL_AUDIO_STREAM_ERROR_FAILURE | 1 | 本地音频出错原因未知 | | LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION | 2 | 没有权限启动本地音频录制设备 | | LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE | 4 | 本地音频录制失败，建议你检查录制设备是否正常工作 | | LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE | 5 | 本地音频编码失败 | | LOCAL_AUDIO_STREAM_ERROR_NO_RECORDING_DEVICE | 6 | 没有可用的音频录制设备 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [value](#LocalAudioStreamError-value) | ## 函数说明 ### value ```java int com.ss.bytertc.engine.data.LocalAudioStreamError.value() ``` 获取当前值 **返回值** 当前值 # SubtitleMessage ```java public class com.ss.bytertc.engine.type.SubtitleMessage ``` 字幕具体内容。 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [userId](#SubtitleMessage-userid) | | String | [text](#SubtitleMessage-text) | | String | [language](#SubtitleMessage-language) | | SubtitleMode | [mode](#SubtitleMessage-mode) | | int | [sequence](#SubtitleMessage-sequence) | | boolean | [definite](#SubtitleMessage-definite) | ## 静态函数 | 返回 | 名称 | | --- | --- | | static SubtitleMessage | [create](#SubtitleMessage-create) | ## 变量说明 ### userId ```java public String com.ss.bytertc.engine.type.SubtitleMessage.userId ``` 说话者的用户 ID。 ### text ```java public String com.ss.bytertc.engine.type.SubtitleMessage.text ``` 字幕文本, 采用 UTF-8 编码。 ### language ```java public String com.ss.bytertc.engine.type.SubtitleMessage.language ``` 字幕语种，根据字幕模式为原文或译文对应的语种。 ### mode ```java public SubtitleMode com.ss.bytertc.engine.type.SubtitleMessage.mode ``` 字幕模式，参看 [SubtitleMode](#SubtitleMode)。 ### sequence ```java public int com.ss.bytertc.engine.type.SubtitleMessage.sequence ``` 字幕文本序列号，同一发言人的完整发言和不完整发言会按递增顺序单独分别编号。 ### definite ```java public boolean com.ss.bytertc.engine.type.SubtitleMessage.definite ``` 语音识别出的文本是否为一段完整的一句话。 True 代表是, False 代表不是。 ## 函数说明 ### create ```java static SubtitleMessage com.ss.bytertc.engine.type.SubtitleMessage.create( String userId, String text, String language, int mode, int sequence, boolean definite ) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | userId | String | - | | text | String | - | | language | String | - | | mode | int | - | | sequence | int | - | | definite | boolean | - | # RecordingInfo ```java public class com.ss.bytertc.engine.data.RecordingInfo ``` 本地录制的详细信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [filePath](#RecordingInfo-filepath) | | VideoCodecType | [videoCodecType](#RecordingInfo-videocodectype) | | int | [width](#RecordingInfo-width) | | int | [height](#RecordingInfo-height) | ## 变量说明 ### filePath ```java public String com.ss.bytertc.engine.data.RecordingInfo.filePath ``` 录制文件的绝对路径，包含文件名和文件后缀 ### videoCodecType ```java public VideoCodecType com.ss.bytertc.engine.data.RecordingInfo.videoCodecType ``` 录制文件的视频编码类型，参看 [VideoCodecType](#VideoCodecType)。 ### width ```java public int com.ss.bytertc.engine.data.RecordingInfo.width ``` 录制视频的宽，单位：像素。纯音频录制请忽略该字段 ### height ```java public int com.ss.bytertc.engine.data.RecordingInfo.height ``` 录制视频的高，单位：像素。纯音频录制请忽略该字段 # AudioMixingConfig ```java public class com.ss.bytertc.engine.data.AudioMixingConfig ``` 混音配置 ## 成员变量 | 类型 | 默认值 | 名称 | | --- | --- | --- | | AudioMixingType | - | [type](#AudioMixingConfig-type) | | int | - | [playCount](#AudioMixingConfig-playcount) | | int | - | [position](#AudioMixingConfig-position) | | long | - | [callbackOnProgressInterval](#AudioMixingConfig-callbackonprogressinterval) | | boolean | false | [syncProgressToRecordFrame](#AudioMixingConfig-syncprogresstorecordframe) | ## 变量说明 ### type ```java public AudioMixingType com.ss.bytertc.engine.data.AudioMixingConfig.type ``` 混音播放类型，详见 [AudioMixingType](#AudioMixingType) ### playCount ```java public int com.ss.bytertc.engine.data.AudioMixingConfig.playCount ``` 混音播放次数 - play_count <= 0: 无限循环 - play_count == 1: 播放一次（默认） - play_count \> 1: 播放 play_count 次 ### position ```java public int com.ss.bytertc.engine.data.AudioMixingConfig.position ``` 混音时音频文件播放进度条位置，参数为整数，单位为毫秒 ### callbackOnProgressInterval ```java public long com.ss.bytertc.engine.data.AudioMixingConfig.callbackOnProgressInterval ``` 设置音频文件播放进度回调的时间间隔，参数为大于 0 的 10 的倍数，单位为毫秒，设置后 SDK 将按照设置的值触发 `onAudioMixingPlayingProgress` 回调，默认不回调。 - 当传入的值不能被 10 整除时，则默认向上取整 10，如设为 52ms 时会默认调整为 60ms。 - 当传入的值小于等于 0 时，不会触发进度回调。 ### syncProgressToRecordFrame ```java public boolean com.ss.bytertc.engine.data.AudioMixingConfig.syncProgressToRecordFrame = false ``` 在采集音频数据时，附带本地混音文件播放进度的时间戳。启用此功能会提升远端人声和音频文件混音播放时的同步效果。 - 仅在单个音频文件混音时使用有效。 - `true` 时开启此功能，`false` 时关闭此功能，默认为关闭。 # SyncInfoStreamType ```java public enum com.ss.bytertc.engine.data.StreamSycnInfoConfig.SyncInfoStreamType ``` 媒体流信息同步的流类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | SYNC_INFO_STREAM_TYPE_AUDIO | 0 | 音频流 | # MixedStreamAudioProfile ```java public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioProfile ``` AAC 编码规格。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MIXED_STREAM_AUDIO_PROFILE_LC | LC | AAC-LC 规格，默认值。 | | MIXED_STREAM_AUDIO_PROFILE_HEV1 | HEv1 | HE-AAC v1 规格。 | | MIXED_STREAM_AUDIO_PROFILE_HEV2 | HEv2 | HE-AAC v2 规格。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | String | [getValue](#MixedStreamAudioProfile-getvalue) | ## 函数说明 ### getValue ```java String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioProfile.getValue() ``` 获取 AAC 编码规格。 **返回值** AAC 编码规格。 # RTCRoomStats ```java public class com.ss.bytertc.engine.type.RTCRoomStats ``` 通话相关的统计信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [totalDuration](#RTCRoomStats-totalduration) | | long | [txBytes](#RTCRoomStats-txbytes) | | long | [rxBytes](#RTCRoomStats-rxbytes) | | int | [txKBitRate](#RTCRoomStats-txkbitrate) | | int | [rxKBitRate](#RTCRoomStats-rxkbitrate) | | int | [txAudioKBitRate](#RTCRoomStats-txaudiokbitrate) | | int | [rxAudioKBitRate](#RTCRoomStats-rxaudiokbitrate) | | int | [txVideoKBitRate](#RTCRoomStats-txvideokbitrate) | | int | [rxVideoKBitRate](#RTCRoomStats-rxvideokbitrate) | | int | [txScreenKBitRate](#RTCRoomStats-txscreenkbitrate) | | int | [rxScreenKBitRate](#RTCRoomStats-rxscreenkbitrate) | | int | [users](#RTCRoomStats-users) | | double | [cpuTotalUsage](#RTCRoomStats-cputotalusage) | | double | [cpuAppUsage](#RTCRoomStats-cpuappusage) | | double | [txLostrate](#RTCRoomStats-txlostrate) | | double | [rxLostrate](#RTCRoomStats-rxlostrate) | | int | [rtt](#RTCRoomStats-rtt) | | int | [txCellularKBitrate](#RTCRoomStats-txcellularkbitrate) | | int | [rxCellularKBitrate](#RTCRoomStats-rxcellularkbitrate) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [reset](#RTCRoomStats-reset) | ## 变量说明 ### totalDuration ```java public int com.ss.bytertc.engine.type.RTCRoomStats.totalDuration ``` 本地用户在本次通话中的参与时长，单位为 s ### txBytes ```java public long com.ss.bytertc.engine.type.RTCRoomStats.txBytes ``` 本地用户的总发送字节数 (bytes)，累计值 ### rxBytes ```java public long com.ss.bytertc.engine.type.RTCRoomStats.rxBytes ``` 本地用户的总接收字节数 (bytes)，累计值 ### txKBitRate ```java public int com.ss.bytertc.engine.type.RTCRoomStats.txKBitRate ``` 发送码率（kbps），获取该数据时的瞬时值 ### rxKBitRate ```java public int com.ss.bytertc.engine.type.RTCRoomStats.rxKBitRate ``` 接收码率（kbps），获取该数据时的瞬时值 ### txAudioKBitRate ```java public int com.ss.bytertc.engine.type.RTCRoomStats.txAudioKBitRate ``` 音频包的发送码率（kbps），获取该数据时的瞬时值 ### rxAudioKBitRate ```java public int com.ss.bytertc.engine.type.RTCRoomStats.rxAudioKBitRate ``` 音频接收码率（kbps），获取该数据时的瞬时值 ### txVideoKBitRate ```java public int com.ss.bytertc.engine.type.RTCRoomStats.txVideoKBitRate ``` 视频发送码率（kbps），获取该数据时的瞬时值 ### rxVideoKBitRate ```java public int com.ss.bytertc.engine.type.RTCRoomStats.rxVideoKBitRate ``` 视频接收码率（kbps），获取该数据时的瞬时值 ### txScreenKBitRate ```java public int com.ss.bytertc.engine.type.RTCRoomStats.txScreenKBitRate ``` 屏幕发送码率（kbps），获取该数据时的瞬时值 ### rxScreenKBitRate ```java public int com.ss.bytertc.engine.type.RTCRoomStats.rxScreenKBitRate ``` 屏幕接收码率（kbps），获取该数据时的瞬时值 ### users ```java public int com.ss.bytertc.engine.type.RTCRoomStats.users ``` 当前房间内的可见用户人数。 ### cpuTotalUsage ```java public double com.ss.bytertc.engine.type.RTCRoomStats.cpuTotalUsage ``` 当前系统的 CPU 使用率 (%) ### cpuAppUsage ```java public double com.ss.bytertc.engine.type.RTCRoomStats.cpuAppUsage ``` 当前应用的 CPU 使用率 (%) ### txLostrate ```java public double com.ss.bytertc.engine.type.RTCRoomStats.txLostrate ``` 当前应用的上行丢包率，取值范围为 [0, 1] ### rxLostrate ```java public double com.ss.bytertc.engine.type.RTCRoomStats.rxLostrate ``` 当前应用的下行丢包率，取值范围为 [0, 1] ### rtt ```java public int com.ss.bytertc.engine.type.RTCRoomStats.rtt ``` 客户端到服务端数据传输的往返时延（单位 ms） ### txCellularKBitrate ```java public int com.ss.bytertc.engine.type.RTCRoomStats.txCellularKBitrate ``` 蜂窝路径发送的码率 (kbps)，为获取该数据时的瞬时值 ### rxCellularKBitrate ```java public int com.ss.bytertc.engine.type.RTCRoomStats.rxCellularKBitrate ``` 蜂窝路径接收码率 (kbps)，为获取该数据时的瞬时值 ## 函数说明 ### reset ```java void com.ss.bytertc.engine.type.RTCRoomStats.reset() ``` 重置所有的 [RTCRoomStats](#RTCRoomStats) 成员变量的值，重新开始统计。 # AudioTrackType ```java public enum com.ss.bytertc.ktv.data.AudioTrackType ``` 原唱伴唱类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ORIGINAL | 1 | 播放原唱。 | | ACCOMPANY | 2 | 播放伴唱。 | # ProblemFeedbackRoomInfo ```java public class com.ss.bytertc.engine.type.ProblemFeedbackRoomInfo ``` 通话质量反馈中的房间信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [roomId](#ProblemFeedbackRoomInfo-roomid) | | String | [userId](#ProblemFeedbackRoomInfo-userid) | ## 变量说明 ### roomId ```java public String com.ss.bytertc.engine.type.ProblemFeedbackRoomInfo.roomId ``` 房间 ID ### userId ```java public String com.ss.bytertc.engine.type.ProblemFeedbackRoomInfo.userId ``` 用户 ID # AudioSourceType ```java public enum com.ss.bytertc.engine.data.AudioSourceType ``` 音频输入源类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_SOURCE_TYPE_EXTERNAL | 0 | 自定义采集音频源 | | AUDIO_SOURCE_TYPE_INTERNAL | 1 | RTC SDK 内部采集音频源 | # PerformanceAlarmMode ```java public enum com.ss.bytertc.engine.type.PerformanceAlarmMode ``` 性能回退的模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | NORMAL | 0 | 未开启发布性能回退 | | SIMULCAST | 1 | 已开启发布性能回退 | # RecordingErrorCode ```java public enum com.ss.bytertc.engine.type.RecordingErrorCode ``` 本地录制的错误码 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | RECORDING_ERROR_CODE_OK | 0 | 录制正常。 | | RECORDING_ERROR_CODE_NO_PERMISSION | -1 | 没有存储路径写权限。确认 App 可以对保存录制文件的文件夹进行读写访问。确认当前用户已经发布媒体流。 | | RECORDING_ERROR_CODE_NOT_SUPPORT | -2 | 当前版本 SDK 不支持本地录制功能。建议下载最新版本的 SDK。 | | RECORDING_ERROR_CODE_NO_OTHER | -3 | 其他异常。 | # EchoTestResult ```java public enum com.ss.bytertc.engine.type.EchoTestResult ``` 音视频回路测试结果 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ECHO_TEST_SUCCESS | 0 | 接收到采集的音视频的回放，通话回路检测成功 | | ECHO_TEST_TIMEOUT | 1 | 测试超过 60s 仍未完成，已自动停止 | | ECHO_TEST_INTERVAL_SHORT | 2 | 上一次测试结束和下一次测试开始之间的时间间隔少于 5s | | ECHO_TEST_AUDIO_DEVICE_ERROR | 3 | 音频采集异常 | | ECHO_TEST_VIDEO_DEVICE_ERROR | 4 | 视频采集异常 | | ECHO_TEST_AUDIO_RECEIVE_ERROR | 5 | 音频接收异常 | | ECHO_TEST_VIDEO_RECEIVE_ERROR | 6 | 视频接收异常 | | ECHO_TEST_INTERNAL_ERROR | 7 | 内部错误，不可恢复 | # NetworkTimeInfo ```java public class com.ss.bytertc.engine.NetworkTimeInfo ``` 网络时间信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | long | [timestamp](#NetworkTimeInfo-timestamp) | ## 变量说明 ### timestamp ```java public long com.ss.bytertc.engine.NetworkTimeInfo.timestamp ``` 网络时间，单位：ms # RemoteMirrorType ```java public enum com.ss.bytertc.engine.data.RemoteMirrorType ``` 远端流的镜像类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | NONE | 0 | （默认值）远端视频渲染无镜像效果。 | | RENDER | 1 | 远端视频渲染有镜像效果。 | # SubscribeState ```java public enum com.ss.bytertc.engine.SubscribeState ``` 订阅媒体流状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | SUBSCRIBE_STATE_SUCCESS | 0 | 订阅/取消订阅流成功 | | SUBSCRIBE_STATE_FAILED_NOT_IN_ROOM | 1 | 订阅/取消订阅流失败，本地用户未在房间中 | | SUBSCRIBE_STATE_FAILED_STREAM_NOT_FOUND | 2 | 订阅/取消订阅流失败，房间内未找到指定的音视频流 | | SUBSCRIBE_STATE_FAILED_SIGNAL | 4 | 订阅/取消订阅流失败，信令错误，请重试 | # VirtualBackgroundSource ```java public class com.ss.bytertc.engine.data.VirtualBackgroundSource ``` 背景贴纸对象。 ## 成员变量 | 类型 | 名称 | | --- | --- | | VirtualBackgroundSourceType | [sourceType](#VirtualBackgroundSource-sourcetype) | | int | [sourceColor](#VirtualBackgroundSource-sourcecolor) | | String | [sourcePath](#VirtualBackgroundSource-sourcepath) | ## 变量说明 ### sourceType ```java public VirtualBackgroundSourceType com.ss.bytertc.engine.data.VirtualBackgroundSource.sourceType ``` 虚拟背景类型，详见 [VirtualBackgroundSourceType](#VirtualBackgroundSourceType)。 ### sourceColor ```java public int com.ss.bytertc.engine.data.VirtualBackgroundSource.sourceColor ``` 纯色背景使用的颜色。格式为 0xAARRGGBB 。 ### sourcePath ```java public String com.ss.bytertc.engine.data.VirtualBackgroundSource.sourcePath ``` 本地背景图片的绝对路径。 - 支持的格式为 jpg、jpeg、png。 - 图片分辨率超过 1080P 时，图片会被等比缩放至和视频一致。 - 图片和视频宽高比一致时，图片会被直接缩放至和视频一致。 - 图片和视频长宽比不一致时，为保证图片内容不变形，图片按短边缩放至与视频帧一致，使图片填满视频帧，对多出的高或宽进行剪裁。 - 自定义图片带有局部透明效果时，透明部分由黑色代替。 # MixedStreamClientMixConfig ```java public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixConfig ``` 客户端合流参数。 ## 成员函数 | 返回 | 名称 | | --- | --- | | MixedStreamClientMixConfig | [setVideoFormat](#MixedStreamClientMixConfig-setvideoformat) | | MixedStreamClientMixVideoFormat | [getVideoFormat](#MixedStreamClientMixConfig-getvideoformat) | | MixedStreamClientMixConfig | [setUseAudioMixer](#MixedStreamClientMixConfig-setuseaudiomixer) | | boolean | [getUseAudioMixer](#MixedStreamClientMixConfig-getuseaudiomixer) | ## 函数说明 ### setVideoFormat ```java MixedStreamClientMixConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixConfig.setVideoFormat(MixedStreamClientMixVideoFormat videoFormat) ``` 设置客户端合流回调视频格式。设置为系统不支持的格式时，自动回调系统默认格式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoFormat | MixedStreamClientMixVideoFormat | 客户端合流回调视频格式，参看 [MixedStreamClientMixVideoFormat](#MixedStreamClientMixVideoFormat)。 | ### getVideoFormat ```java MixedStreamClientMixVideoFormat com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixConfig.getVideoFormat() ``` 获取客户端合流回调视频格式。 ### setUseAudioMixer ```java MixedStreamClientMixConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixConfig.setUseAudioMixer(boolean useAudioMixer) ``` 设置客户端合流是否使用混音。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | useAudioMixer | boolean | 是否使用混音，默认为 true。 | **返回值** 参看 [MixedStreamClientMixConfig](#MixedStreamClientMixConfig)。 ### getUseAudioMixer ```java boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixConfig.getUseAudioMixer() ``` 获取客户端合流是否使用混音的设置。 # PublicStreaming ```java class com.ss.bytertc.engine.publicstream.PublicStreaming ``` 公共流参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [ACTION_START](#PublicStreaming-action_start) | | String | [ACTION_CHANGED](#PublicStreaming-action_changed) | | String | [ACTION_STOPPED](#PublicStreaming-action_stopped) | ## 静态函数 | 返回 | 名称 | | --- | --- | | static PublicStreaming | [getDefualtPublicStreaming](#PublicStreaming-getdefualtpublicstreaming) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setRoomId](#PublicStreaming-setroomid) | | void | [setAction](#PublicStreaming-setaction) | | void | [setVideo](#PublicStreaming-setvideo) | | void | [setLayout](#PublicStreaming-setlayout) | | VideoConfig | [getVideo](#PublicStreaming-getvideo) | | Layout | [getLayout](#PublicStreaming-getlayout) | ## 变量说明 ### ACTION_START ```java public static final String com.ss.bytertc.engine.publicstream.PublicStreaming.ACTION_START = "started" ``` 设置公共流发布动作参数：开启公共流推流功能。 ### ACTION_CHANGED ```java public static final String com.ss.bytertc.engine.publicstream.PublicStreaming.ACTION_CHANGED = "layoutChanged" ``` 设置公共流发布动作参数：更新视频公共流布局。 ### ACTION_STOPPED ```java public static final String com.ss.bytertc.engine.publicstream.PublicStreaming.ACTION_STOPPED = "stopped" ``` 设置公共流发布动作参数：停止公共流推流功能。 ## 函数说明 ### getDefualtPublicStreaming ```java static PublicStreaming com.ss.bytertc.engine.publicstream.PublicStreaming.getDefualtPublicStreaming() ``` 获取默认的公共流配置属性。 **返回值** 默认的推公共流转码配置属性。详见 [PublicStreaming](#PublicStreaming) 数据类型。 ### setRoomId ```java void com.ss.bytertc.engine.publicstream.PublicStreaming.setRoomId(String roomId) ``` 设置 roomId。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomId | String | 房间 ID | ### setAction ```java void com.ss.bytertc.engine.publicstream.PublicStreaming.setAction(String action) ``` 设置公共流发布动作参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | action | String | 公共流发布动作。可选取值如下：

ACTION_START: 开启发布
ACTION_CHANGED: 更新公共流布局
ACTION_STOPPED: 停止发布

| ### setVideo ```java void com.ss.bytertc.engine.publicstream.PublicStreaming.setVideo(VideoConfig video) ``` 设置公共流视频参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | video | VideoConfig | 公共流视频参数，必填。详见 [VideoConfig](#videoconfig-2) 数据类型。 | **注意** 建议先调用 [getDefualtPublicStreaming](#PublicStreaming-getdefualtpublicstreaming) 获取包含默认参数的数据结构体。 ### setLayout ```java void com.ss.bytertc.engine.publicstream.PublicStreaming.setLayout(Layout layout) ``` 设置公共流整体布局信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | layout | Layout | 公共流整体布局参数，必填。详见 [Layout](#layout-2) 数据类型。 | ### getVideo ```java VideoConfig com.ss.bytertc.engine.publicstream.PublicStreaming.getVideo() ``` 获取公共流视频编码参数。 **返回值** 公共流视频参数。详见 [VideoConfig](#videoconfig-2) 数据类型。 ### getLayout ```java Layout com.ss.bytertc.engine.publicstream.PublicStreaming.getLayout() ``` 获取公共流整体布局信息。 **返回值** 当前公共流整体布局。详见 Layout 数据类型。 # StreamIndex ```java public enum com.ss.bytertc.engine.data.StreamIndex ``` 流属性 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | STREAM_INDEX_MAIN | 0 | 主流。包括：

由摄像头/麦克风通过内部采集机制，采集到的视频/音频;

通过自定义采集，采集到的视频/音频。

| | STREAM_INDEX_SCREEN | 1 | 屏幕流。屏幕共享时共享的视频流，或来自声卡的本地播放音频流。 | # RemoteAudioStateChangeReason ```java public enum com.ss.bytertc.engine.data.RemoteAudioStateChangeReason ``` 远端音频流状态改变的原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | REMOTE_AUDIO_STATE_CHANGE_REASON_INTERNAL | 0 | 内部原因 | | REMOTE_AUDIO_STATE_CHANGE_REASON_NETWORK_CONGESTION | 1 | 网络阻塞 | | REMOTE_AUDIO_STATE_CHANGE_REASON_NETWORK_RECOVERY | 2 | 网络恢复正常 | | REMOTE_AUDIO_STATE_CHANGE_REASON_LOCAL_MUTED | 3 | 本地用户停止接收远端音频流 | | REMOTE_AUDIO_STATE_CHANGE_REASON_LOCAL_UNMUTED | 4 | 本地用户恢复接收远端音频流 | | REMOTE_AUDIO_STATE_CHANGE_REASON_REMOTE_MUTED | 5 | 远端用户停止发送音频流 | | REMOTE_AUDIO_STATE_CHANGE_REASON_REMOTE_UNMUTED | 6 | 远端用户恢复发送音频流 | | REMOTE_AUDIO_STATE_CHANGE_REASON_REMOTE_OFFLINE | 7 | 远端用户离开房间 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [value](#RemoteAudioStateChangeReason-value) | ## 函数说明 ### value ```java int com.ss.bytertc.engine.data.RemoteAudioStateChangeReason.value() ``` 获取当前值 **返回值** 当前值 # PlayerError ```java public enum com.ss.bytertc.engine.data.PlayerError ``` 播放错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | OK | 0 | 正常 | | FORMAT_NOT_SUPPORT | 1 | 不支持此类型 | | INVALID_PATH | 2 | 无效的播放路径 | | INVALID_STATE | 3 | 未满足前序接口调用的要求。请查看具体接口文档。 | | INVALID_POSITION | 4 | 设置播放位置出错。 | | INVALID_VOLUME | 5 | 音量参数不合法。 | | INVALID_PITCH | 6 | 音调参数设置不合法。 | | INVALID_AUDIO_TRACK_INDEX | 7 | 音轨参数设置不合法。 | | INVALID_PLAYBACK_SPEED | 8 | 播放速度参数设置不合法 | | INVALID_EFFECT_ID | 9 | 音效 ID 异常。还未加载或播放文件，就调用其他 API。 | # ReturnStatus ```java public enum com.ss.bytertc.engine.data.ReturnStatus ``` 方法调用结果。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | RETURN_STATUS_SUCCESS | 0 | 成功。 | | RETURN_STATUS_FAILURE | -1 | 失败。 | | RETURN_STATUS_PARAMETER_ERR | -2 | 参数错误。确认传入的参数类型，数值不超过边界等。 | | RETURN_STATUS_WRONG_STATE | -3 | 接口状态错误。确认当前的调用时机符合接口要求等。 | | RETURN_STATUS_HAS_IN_ROOM | -4 | 失败，用户已在房间内。 | | RETURN_STATUS_HAS_IN_LOGIN | -5 | 失败，用户已登录。 | | RETURN_STATUS_HAS_IN_ECHO_TEST | -6 | 失败，用户已经在进行通话回路测试中。 | | RETURN_STATUS_NEITHER_VIDEO_NOR_AUDIO | -7 | 失败，音视频均未采集。 | | RETURN_STATUS_ROOMID_IN_USE | -8 | 失败，该 roomId 已被使用。 | | RETURN_STATUS_SCREEN_NOT_SUPPORT | -9 | 失败，屏幕流不支持。 | | RETURN_STATUS_NOT_SUPPORT | -10 | 失败，不支持该操作。 | | RETURN_STATUS_RESOURCE_OVERFLOW | -11 | 失败，资源已占用。 | | RETURN_STATUS_AUDIO_NO_FRAME | -101 | 失败，没有音频帧。 | | RETURN_STATUS_AUDIO_NOT_IMPLEMENTED | -102 | 失败，未实现。 | | RETURN_STATUS_AUDIO_NO_PERMISSION | -103 | 失败，采集设备无麦克风权限，尝试初始化设备失败。 | | RETURN_STATUS_AUDIO_DEVICE_NOT_EXISTS | -104 | 失败，设备不存在。当前没有设备或设备被移除时返回该值。 | | RETURN_STATUS_AUDIO_DEVICE_FORMAT_NOT_SUPPORT | -105 | 失败，设备音频格式不支持。 | | RETURN_STATUS_AUDIO_DEVICE_NO_DEVICE | -106 | 失败，系统无可用设备。 | | RETURN_STATUS_AUDIO_DEVICE_CAN_NOT_USE | -107 | 失败，当前设备不可用，需更换设备。 | | RETURN_STATUS_AUDIO_DEVICE_INIT_FAILED | -108 | 系统错误，设备初始化失败。 | | RETURN_STATUS_AUDIO_DEVICE_START_FAILED | -109 | 系统错误，设备开启失败。 | | RETURN_STATUS_NATIVE_IN_VALID | -201 | 失败。底层未初始化，engine 无效。 | | RETURN_STATUS_VIDEO_TIMESTAMP_WARNING | -202 | 警告。推送视频帧到 RTC SDK 时，相邻视频帧的时间戳差异应当和推帧操作的间隔相同。如果不同，会收到此警告。 | # VideoCodecType ```java public enum com.ss.bytertc.engine.VideoStreamDescription.VideoCodecType ``` 编码模式（H264, ByteVC1） ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | CODEC_TYPE_AUTO | 0 | 自动选择编码模式 | | CODEC_TYPE_H264 | 1 | H264 | | CODEC_TYPE_BYTEVC1 | 2 | ByteVC1 | # ScreenVideoEncoderConfig ```java public class com.ss.bytertc.engine.ScreenVideoEncoderConfig ``` 屏幕流编码配置。参考 [屏幕共享](https://www.volcengine.com/docs/6348/124176)。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#ScreenVideoEncoderConfig-width) | | int | [height](#ScreenVideoEncoderConfig-height) | | int | [frameRate](#ScreenVideoEncoderConfig-framerate) | | int | [maxBitrate](#ScreenVideoEncoderConfig-maxbitrate) | | int | [minBitrate](#ScreenVideoEncoderConfig-minbitrate) | | EncoderPreference | [encodePreference](#ScreenVideoEncoderConfig-encodepreference) | ## 变量说明 ### width ```java public int com.ss.bytertc.engine.ScreenVideoEncoderConfig.width ``` 屏幕帧最大宽度，单位：px。 ### height ```java public int com.ss.bytertc.engine.ScreenVideoEncoderConfig.height ``` 屏幕帧最大高度，单位：px。 ### frameRate ```java public int com.ss.bytertc.engine.ScreenVideoEncoderConfig.frameRate ``` 屏幕流编码帧率，单位：fps。建议和采集帧率保持一致。 ### maxBitrate ```java public int com.ss.bytertc.engine.ScreenVideoEncoderConfig.maxBitrate = -1 ``` 最大编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。设为 -1 即适配码率模式，系统将根据输入的分辨率和帧率自动计算适用的码率。设为 0 则不对视频流进行编码发送。 3.44 及以上版本，内部采集时默认值为 -1，3.44 以前版本无默认值，需手动设置。 ### minBitrate ```java public int com.ss.bytertc.engine.ScreenVideoEncoderConfig.minBitrate = 0 ``` 最小编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。最小编码码率必须小于或等于最大编码，否则不对视频流进行编码发送。 ### encodePreference ```java public EncoderPreference com.ss.bytertc.engine.ScreenVideoEncoderConfig.encodePreference = EncoderPreference.MaintainFramerate ``` 屏幕流编码模式。默认为流畅模式。参看 [EncoderPreference](#EncoderPreference)。 # MediaPlayerConfig ```java public class com.ss.bytertc.engine.data.MediaPlayerConfig ``` 混音配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | AudioMixingType | [type](#MediaPlayerConfig-type) | | int | [playCount](#MediaPlayerConfig-playcount) | | int | [startPos](#MediaPlayerConfig-startpos) | | long | [callbackOnProgressInterval](#MediaPlayerConfig-callbackonprogressinterval) | | boolean | [syncProgressToRecordFrame](#MediaPlayerConfig-syncprogresstorecordframe) | | boolean | [autoPlay](#MediaPlayerConfig-autoplay) | ## 变量说明 ### type ```java public AudioMixingType com.ss.bytertc.engine.data.MediaPlayerConfig.type = AudioMixingType.AUDIO_MIXING_TYPE_PLAYOUT_AND_PUBLISH ``` 混音播放类型，详见 [AudioMixingType](#AudioMixingType) ### playCount ```java public int com.ss.bytertc.engine.data.MediaPlayerConfig.playCount = 1 ``` 混音播放次数 - play_count <= 0: 无限循环 - play_count == 1: 播放一次（默认） - play_count \> 1: 播放 play_count 次 ### startPos ```java public int com.ss.bytertc.engine.data.MediaPlayerConfig.startPos = 0 ``` 混音起始位置。默认值为 0，单位为毫秒。 ### callbackOnProgressInterval ```java public long com.ss.bytertc.engine.data.MediaPlayerConfig.callbackOnProgressInterval = 0 ``` 设置音频文件混音时，收到 [onMediaPlayerPlayingProgress](70081#IMediaPlayerEventHandler-onmediaplayerplayingprogress) 的间隔。单位毫秒。 - interval \> 0 时，触发回调。实际间隔为 10 的倍数。如果输入数值不能被 10 整除，将自动向上取整。例如传入 `52`，实际间隔为 60 ms。 - interval <= 0 时，不会触发回调。 ### syncProgressToRecordFrame ```java public boolean com.ss.bytertc.engine.data.MediaPlayerConfig.syncProgressToRecordFrame = false ``` 在采集音频数据时，附带本地混音文件播放进度的时间戳。启用此功能会提升远端人声和音频文件混音播放时的同步效果。 - 仅在单个音频文件混音时使用有效。 - `true` 时开启此功能，`false` 时关闭此功能，默认为关闭。 ### autoPlay ```java public boolean com.ss.bytertc.engine.data.MediaPlayerConfig.autoPlay = true ``` 是否自动播放。如果不自动播放，调用 [start](70080#IMediaPlayer-start) 播放音乐文件。 # VideoPictureType ```java public enum com.ss.bytertc.engine.data.VideoPictureType ``` 编码帧类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | VIDEO_PICTURE_TYPE_UNKNOWN | 0 | 未知类型 | | VIDEO_PICTURE_TYPE_I | 1 | I 帧，关键帧，编解码不需要参考其他视频帧 | | VIDEO_PICTURE_TYPE_P | 2 | P 帧，向前参考帧，编解码需要参考前一帧视频帧 | | VIDEO_PICTURE_TYPE_B | 3 | B 帧，前后参考帧，编解码需要参考前后两帧视频帧 | # ColorSpace ```java public enum com.ss.bytertc.engine.data.ColorSpace ``` 视频帧色彩空间 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | UNKNOWN | 0 | 色彩空间未知 | | BT601_LIMITED_RANGE | 1 | BT.601 数字编码标准，色彩空间[16-235] | | BT601_FULL_RANGE | 2 | BT.601 数字编码标准，颜色空间[0-255] | | BT709_LIMITED_RANGE | 3 | BT.7091 数字编码标准，颜色空间[16-235] | | BT709_FULL_RANGE | 4 | BT.7091 数字编码标准，颜色空间[0-255] | # AudioPropertiesInfo ```java public class com.ss.bytertc.engine.data.AudioPropertiesInfo ``` 音频属性信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [linearVolume](#AudioPropertiesInfo-linearvolume) | | int | [nonlinearVolume](#AudioPropertiesInfo-nonlinearvolume) | | float[] | [spectrum](#AudioPropertiesInfo-spectrum) | | int | [vad](#AudioPropertiesInfo-vad) | | double | [voicePitch](#AudioPropertiesInfo-voicepitch) | ## 变量说明 ### linearVolume ```java public int com.ss.bytertc.engine.data.AudioPropertiesInfo.linearVolume ``` 线性音量，与原始音量呈线性关系，数值越大，音量越大。取值范围是：[0,255]。 - \[0, 25]: 近似无声 - \[26, 75]: 低音量 - \[76, 204]: 中音量 - \[205, 255]: 高音量 ### nonlinearVolume ```java public int com.ss.bytertc.engine.data.AudioPropertiesInfo.nonlinearVolume ``` 非线性音量。由原始音量的对数值转化而来，因此在中低音量时更灵敏，可以用作 Active Speaker（房间内最活跃用户）的识别。取值范围是：[-127，0]，单位 dB。 - \[-127, -60]: 近似无声 - \[-59, -40]: 低音量 - \[-39, -20]: 中音量 - \[-19, 0]: 高音量 ### spectrum ```java public float [] com.ss.bytertc.engine.data.AudioPropertiesInfo.spectrum = new float[SPECTRUM_SIZE] ``` 频谱数组 ### vad ```java public int com.ss.bytertc.engine.data.AudioPropertiesInfo.vad ``` 人声检测（VAD）结果 - 1: 检测到人声。 - 0: 未检测到人声。 - -1: 未开启 VAD。 ### voicePitch ```java public double com.ss.bytertc.engine.data.AudioPropertiesInfo.voicePitch = 0 ``` 本地用户的人声基频，单位为赫兹。同时满足以下两个条件时，返回的值为本地用户的人声基频： - 调用 [enableAudioPropertiesReport](70080#RTCVideo-enableaudiopropertiesreport)，并设置参数 enableVoicePitch 的值为 `true`。 - 本地采集的音频中包含本地用户的人声。其他情况下返回 `0`。 # RemoteVideoState ```java public enum com.ss.bytertc.engine.type.RemoteVideoState ``` 远端视频流状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | REMOTE_VIDEO_STATE_STOPPED | 0 | 远端视频流默认初始状态
在以下时机回调该状态：

本地用户停止接收远端视频流，对应错误码 [RemoteVideoStateChangeReason](#RemoteVideoStateChangeReason) 中的 REMOTE_VIDEO_STATE_CHANGE_REASON_LOCAL_MUTED。

远端用户停止发送视频流，对应错误码 [RemoteVideoStateChangeReason](#RemoteVideoStateChangeReason) 中的 REMOTE_VIDEO_STATE_CHANGE_REASON_REMOTE_MUTED。

远端用户离开房间，对应错误码 [RemoteVideoStateChangeReason](#RemoteVideoStateChangeReason) 中的 REMOTE_VIDEO_STATE_CHANGE_REASON_REMOTE_OFFLINE。

成功解码远端视频首帧，对应错误码 [RemoteVideoStateChangeReason](#RemoteVideoStateChangeReason) 中的 REMOTE_VIDEO_STATE_CHANGE_REASON_LOCAL_UNMUTED。

网络由阻塞恢复正常，对应错误码 [RemoteVideoStateChangeReason](#RemoteVideoStateChangeReason) 中的 REMOTE_VIDEO_STATE_CHANGE_REASON_NETWORK_RECOVERY。

本地用户恢复接收远端视频流，对应错误码 [RemoteVideoStateChangeReason](#RemoteVideoStateChangeReason) 中的 REMOTE_VIDEO_STATE_CHANGE_REASON_LOCAL_UNMUTED。

远端用户恢复发送视频流，对应错误码 [RemoteVideoStateChangeReason](#RemoteVideoStateChangeReason) 中的 REMOTE_VIDEO_STATE_CHANGE_REASON_NETWORK_CONGESTION。

| | REMOTE_VIDEO_STATE_FROZEN | 3 | 远端视频流卡顿
网络阻塞、丢包率大于 40%时回调该状态，对应错误码 [RemoteVideoStateChangeReason](#RemoteVideoStateChangeReason) 中的 REMOTE_VIDEO_REASON_NETWORK_CONGESTION 。 | # VideoEncoderConfiguration ```java public class com.ss.bytertc.engine.video.VideoEncoderConfiguration ``` 视频编码配置。参考 [设置视频发布参数](https://www.volcengine.com/docs/6348/70122) ## 成员变量 | 类型 | 名称 | | --- | --- | | VideoDimensions | [dimensions](#VideoEncoderConfiguration-dimensions) | | FrameRate | [frameRate](#VideoEncoderConfiguration-framerate) | | int | [kBitrate](#VideoEncoderConfiguration-kbitrate) | | int | [kMinBitrate](#VideoEncoderConfiguration-kminbitrate) | | OrientationMode | [orientationMode](#VideoEncoderConfiguration-orientationmode) | ## 变量说明 ### dimensions ```java public VideoDimensions com.ss.bytertc.engine.video.VideoEncoderConfiguration.dimensions ``` 视频编码像素 ### frameRate ```java public FrameRate com.ss.bytertc.engine.video.VideoEncoderConfiguration.frameRate ``` 视频编码帧率 ### kBitrate ```java public int com.ss.bytertc.engine.video.VideoEncoderConfiguration.kBitrate ``` 视频编码码率 ### kMinBitrate ```java public int com.ss.bytertc.engine.video.VideoEncoderConfiguration.kMinBitrate ``` ### orientationMode ```java public OrientationMode com.ss.bytertc.engine.video.VideoEncoderConfiguration.orientationMode ``` 视频编码方向模式 # PixelFormat ```java public interface com.ss.bytertc.engine.video.IVideoSink.PixelFormat ``` 视频帧数据格式 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [Original](#PixelFormat-original) | | int | [I420](#PixelFormat-i420) | | int | [RGBA](#PixelFormat-rgba) | ## 变量说明 ### Original ```java public int com.ss.bytertc.engine.video.IVideoSink.PixelFormat.Original = 0 ``` 原始视频帧格式 ### I420 ```java public int com.ss.bytertc.engine.video.IVideoSink.PixelFormat.I420 = 1 ``` I420 数据格式 ### RGBA ```java public int com.ss.bytertc.engine.video.IVideoSink.PixelFormat.RGBA = 5 ``` RGBA 格式, 一个像素占据 32 位, 字节序为 A8 B8 G8 R8 # HardwareEchoDetectionResult ```java public enum com.ss.bytertc.engine.type.HardwareEchoDetectionResult ``` 通话前回声检测结果 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | HARDWARE_ECHO_RESULT_CANCELED | 0 | 主动调用 `stopHardwareEchoDetection` 结束流程时，未有回声检测结果。 | | HARDWARE_ECHO_RESULT_UNKNOWN | 1 | 未检测出结果。建议重试，如果仍然失败请联系技术支持协助排查。 | | HARDWARE_ECHO_RESULT_NORMAL | 2 | 无回声 | | HARDWARE_ECHO_RESULT_POOR | 3 | 有回声。可通过 UI 建议用户使用耳机设备入会。 | # SubscribeVideoConfig ```java public class com.ss.bytertc.engine.SubscribeVideoConfig ``` 视频订阅配置信息 ## 成员函数 | 返回 | 名称 | | --- | --- | | SubscribeVideoConfig | [SubscribeVideoConfig](#SubscribeVideoConfig-subscribevideoconfig) | ## 函数说明 ### SubscribeVideoConfig ```java com.ss.bytertc.engine.SubscribeVideoConfig.SubscribeVideoConfig( int videoIndex, int priority ) ``` 视频订阅配置信息 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoIndex | int | 订阅的视频流分辨率下标。
通过此参数指定希望订阅的流。在此之前，远端用户已经通过调用 [setVideoEncoderConfig](70080#RTCVideo-setvideoencoderconfig) 方法，启动发布多路不同分辨率的视频流。编号 `0` 至 `3`代表流质量从高至低。
默认值为 0，即订阅第一路流。
如果不想更改之前的设置，可以输入 -1。 | | priority | int | 远端用户优先级，参看 [RemoteUserPriority](#RemoteUserPriority)，默认值为 0。 | # RecordingState ```java public enum com.ss.bytertc.engine.type.RecordingState ``` 本地录制的状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | RECORDING_STATE_ERROE | 0 | 录制异常 | | RECORDING_STATE_PROCESSING | 1 | 录制进行中 | | RECORDING_STATE_SUCCESS | 2 | 录制文件保存成功，调用 `stopFileRecording` 结束录制之后才会收到该状态码。 | # NetworkDetectionLinkType ```java public enum com.ss.bytertc.engine.type.NetworkDetectionLinkType ``` 通话前探测链接的类型。 `onNetworkDetectionResult` 回调的参数类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | UP | 0 | 上行网络探测 | | DOWN | 1 | 下行网络探测 | # RTCStream ```java public class com.ss.bytertc.engine.RTCStream ``` 流属性。 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [userId](#RTCStream-userid) | | boolean | [isScreen](#RTCStream-isscreen) | | boolean | [hasVideo](#RTCStream-hasvideo) | | boolean | [hasAudio](#RTCStream-hasaudio) | | List | [videoStreamDescriptions](#RTCStream-videostreamdescriptions) | ## 变量说明 ### userId ```java public String com.ss.bytertc.engine.RTCStream.userId ``` 发布此流的用户 ID 。 ### isScreen ```java public boolean com.ss.bytertc.engine.RTCStream.isScreen ``` 此流是否为共享屏幕流。 ### hasVideo ```java public boolean com.ss.bytertc.engine.RTCStream.hasVideo ``` 此流是否包括视频流。 ### hasAudio ```java public boolean com.ss.bytertc.engine.RTCStream.hasAudio ``` 流是否包括音频流。 ### videoStreamDescriptions ```java public List com.ss.bytertc.engine.RTCStream.videoStreamDescriptions ``` 视频流的属性。当远端用户调用 [setVideoEncoderConfig](70080#RTCVideo-setvideoencoderconfig) 方法发布多个配置的视频流时，此处会包含该用户发布的所有视频流的属性信息。参看 [VideoStreamDescription](#VideoStreamDescription)。 # ByteWatermark ```java public class com.ss.bytertc.engine.video.ByteWatermark ``` 水印图片相对视频流的位置和大小。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [x](#ByteWatermark-x) | | float | [y](#ByteWatermark-y) | | float | [width](#ByteWatermark-width) | | float | [height](#ByteWatermark-height) | ## 变量说明 ### x ```java public float com.ss.bytertc.engine.video.ByteWatermark.x ``` 水印图片相对视频流左上角的横向偏移与视频流宽度的比值，取值范围为 [0,1)。 ### y ```java public float com.ss.bytertc.engine.video.ByteWatermark.y ``` 水印图片相对视频流左上角的纵向偏移与视频流高度的比值，取值范围为 [0,1)。 ### width ```java public float com.ss.bytertc.engine.video.ByteWatermark.width ``` 水印图片宽度与视频流宽度的比值，取值范围 [0,1)。 ### height ```java public float com.ss.bytertc.engine.video.ByteWatermark.height ``` 水印图片高度与视频流高度的比值，取值范围为 [0,1)。 # AudioDeviceType ```java public enum com.ss.bytertc.engine.type.AudioDeviceType ``` 音频设备类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_DEVICE_TYPE_UNKNOWN | -1 | 未知设备 | | AUDIO_DEVICE_TYPE_RENDER_DEVICE | 0 | 音频渲染设备 | | AUDIO_DEVICE_TYPE_CAPTURE_DEVICE | 1 | 音频采集设备类型 | | AUDIO_DEVICE_TYPE_SCREEN_CAPTURE_DEVICE | 2 | 屏幕流音频设备 | # SetRoomExtraInfoResult ```java public enum com.ss.bytertc.engine.type.SetRoomExtraInfoResult ``` 设置房间附加消息结果。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | SUCCESS | 0 | 设置房间附加信息成功 | | NOT_JOIN_ROOM | -1 | 设置失败，尚未加入房间 | | KEY_IS_NULL | -2 | 设置失败，key 指针为空 | | VALUE_IS_NULL | -3 | 设置失败，value 指针为空 | | UNKNOW | -99 | 设置失败，未知错误 | | KEY_IS_EMPTY | -400 | 设置失败，key 长度为 0 | | TOO_OFTEN | -406 | 调用 `setRoomExtraInfo` 过于频繁，建议不超过 10 次/秒。 | | SILENT_USER | -412 | 设置失败，用户已调用 `setUserVisibility` 将自身设为隐身状态。 | | KEY_TOO_LONG | -413 | 设置失败，Key 长度超过 10 字节 | | VALUE_TOO_LONG | -414 | 设置失败，value 长度超过 128 字节 | | SERVER_ERROR | -500 | 设置失败，服务器错误 | # LocalProxyState ```java public enum com.ss.bytertc.engine.type.LocalProxyState ``` 本地代理连接状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | INITED | 0 | TCP 代理服务器连接成功。 | | CONNECTED | 1 | 本地代理连接成功。 | | ERROR | 2 | 本地代理连接出现错误。 | # AVSyncState ```java public enum com.ss.bytertc.engine.data.AVSyncState ``` 音视频同步状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AV_SYNC_STATE_STREAM_SYNC_BEGIN | 0 | 音视频开始同步 | | AV_SYNC_STATE_AUDIO_STREAM_REMOVE | 1 | 音视频同步过程中音频移除，但不影响当前的同步关系 | | AV_SYNC_STATE_VIDEO_STREAM_REMOVE | 2 | 音视频同步过程中视频移除，但不影响当前的同步关系 | # RTCRoomConfig ```java public class com.ss.bytertc.engine.RTCRoomConfig ``` 房间参数配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | ChannelProfile | [profile](#RTCRoomConfig-profile) | | boolean | [isAutoPublish](#RTCRoomConfig-isautopublish) | | boolean | [isAutoSubscribeAudio](#RTCRoomConfig-isautosubscribeaudio) | | boolean | [isAutoSubscribeVideo](#RTCRoomConfig-isautosubscribevideo) | | RemoteVideoConfig | [remoteVideoConfig](#RTCRoomConfig-remotevideoconfig) | ## 变量说明 ### profile ```java public ChannelProfile com.ss.bytertc.engine.RTCRoomConfig.profile ``` 房间模式，参看 [ChannelProfile](#ChannelProfile)，默认为 `CHANNEL_PROFILE_COMMUNICATION`，进房后不可更改。 ### isAutoPublish ```java public boolean com.ss.bytertc.engine.RTCRoomConfig.isAutoPublish ``` 是否自动发布音视频流，默认为自动发布。创建和加入多房间时，只能将其中一个房间设置为自动发布。若每个房间均不做设置，则默认在第一个加入的房间内自动发布流。若调用 [setUserVisibility](70080#RTCRoom-setuservisibility) 将自身可见性设为 false，无论是默认的自动发布流还是手动设置的自动发布流都不会进行发布，你需要将自身可见性设为 true 后方可发布。 ### isAutoSubscribeAudio ```java public boolean com.ss.bytertc.engine.RTCRoomConfig.isAutoSubscribeAudio ``` 是否自动订阅音频流，默认为自动订阅。包含主流和屏幕流。 ### isAutoSubscribeVideo ```java public boolean com.ss.bytertc.engine.RTCRoomConfig.isAutoSubscribeVideo ``` 是否自动订阅视频流，默认为自动订阅。包含主流和屏幕流。 ### remoteVideoConfig ```java public RemoteVideoConfig com.ss.bytertc.engine.RTCRoomConfig.remoteVideoConfig = null ``` 远端视频流参数，参看 [RemoteVideoConfig](#remotevideoconfig-2)。 # SVCLayer ```java public enum com.ss.bytertc.engine.SubscribeConfig.SVCLayer ``` 时域分层订阅层级 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | DEFAULT | 0 | 不指定分层(默认值） | | BASE | 1 | T0 层 | | MAIN | 2 | T0+T1 层 | | HIGH | 3 | T0+T1+T2 层 | # Rectangle ```java public class com.ss.bytertc.engine.video.Rectangle ``` 矩形区域 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [x](#Rectangle-x) | | int | [y](#Rectangle-y) | | int | [width](#Rectangle-width) | | int | [height](#Rectangle-height) | ## 成员函数 | 返回 | 名称 | | --- | --- | | Rectangle | [Rectangle](#Rectangle-rectangle) | | String | [toString](#Rectangle-tostring) | ## 变量说明 ### x ```java public int com.ss.bytertc.engine.video.Rectangle.x = 0 ``` 矩形区域左上角的 x 坐标 ### y ```java public int com.ss.bytertc.engine.video.Rectangle.y = 0 ``` 矩形区域左上角的 y 坐标 ### width ```java public int com.ss.bytertc.engine.video.Rectangle.width = 0 ``` 矩形宽度(px) ### height ```java public int com.ss.bytertc.engine.video.Rectangle.height = 0 ``` 矩形高度(px) ## 函数说明 ### Rectangle ```java com.ss.bytertc.engine.video.Rectangle.Rectangle( int x, int y, int w, int h ) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | x | int | - | | y | int | - | | w | int | - | | h | int | - | ### toString ```java String com.ss.bytertc.engine.video.Rectangle.toString() ``` # MixedStreamClientMixVideoFormat ```java public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixVideoFormat ``` 客户端合流回调视频格式。设置为系统不支持的格式时，自动回调系统默认格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MIXED_STREAM_CLIENT_MIX_VIDEO_FORMAT_YUV_I420 | 0 | YUV I420。Android、Windows 默认回调格式。支持系统：Android、Windows。 | | MIXED_STREAM_CLIENT_MIX_VIDEO_FORMAT_TEXTURE_2D | 1 | OpenGL GL_TEXTURE_2D 格式纹理。支持系统：安卓。 | | MIXED_STREAM_CLIENT_MIX_VIDEO_FORMAT_CVPIXEL_BUFFER_BGRA | 2 | CVPixelBuffer BGRA。iOS 默认回调格式。支持系统: iOS。 | | MIXED_STREAM_CLIENT_MIX_VIDEO_FORMAT_YUV_NV12 | 3 | YUV NV12。macOS 默认回调格式。支持系统: macOS。{en} | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [getValue](#MixedStreamClientMixVideoFormat-getvalue) | ## 函数说明 ### getValue ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixVideoFormat.getValue() ``` 获取合流输出内容类型。 **返回值** 合流输出内容类型 # VideoRotationMode ```java public enum com.ss.bytertc.engine.data.VideoRotationMode ``` 视频旋转模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | FOLLOW_APP | 0 | App 方向 | | FOLLOW_GSENSOR | 1 | 重力方向 | # PlayerState ```java public enum com.ss.bytertc.engine.data.PlayerState ``` 播放状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | IDLE | 0 | 播放未启动 | | PRELOADED | 1 | 已加载 | | OPENED | 2 | 已打开 | | PLAYING | 3 | 正在播放 | | PAUSED | 4 | 播放已暂停 | | STOPPED | 5 | 播放已停止 | | FAILED | 6 | 播放失败 | | FINISHED | 7 | 播放已结束 | # MixedStreamVideoType ```java public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamVideoType ``` region 中流的类型属性 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MIXED_STREAM_VIDEO_TYPE_MAIN | 0 | 主流。包括：

由摄像头/麦克风通过内部采集机制，采集到的流

通过自定义采集，采集到的流。

| | MIXED_STREAM_VIDEO_TYPE_SCREEN | 1 | 屏幕流。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [getValue](#MixedStreamVideoType-getvalue) | ## 函数说明 ### getValue ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamVideoType.getValue() ``` # MixedStreamLayoutRegionConfig ```java public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig ``` 单个图片或视频流在合流中的布局信息。开启转推直播功能后，在多路视频流合流时，你可以设置其中一路视频流在合流中的预设布局信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | MixedStreamLayoutRegionConfig | [setRoomID](#MixedStreamLayoutRegionConfig-setroomid) | | String | [getRoomID](#MixedStreamLayoutRegionConfig-getroomid) | | MixedStreamLayoutRegionConfig | [setUserID](#MixedStreamLayoutRegionConfig-setuserid) | | String | [getUserID](#MixedStreamLayoutRegionConfig-getuserid) | | MixedStreamLayoutRegionConfig | [setLocationX](#MixedStreamLayoutRegionConfig-setlocationx) | | int | [getLocationX](#MixedStreamLayoutRegionConfig-getlocationx) | | MixedStreamLayoutRegionConfig | [setLocationY](#MixedStreamLayoutRegionConfig-setlocationy) | | int | [getLocationY](#MixedStreamLayoutRegionConfig-getlocationy) | | MixedStreamLayoutRegionConfig | [setWidth](#MixedStreamLayoutRegionConfig-setwidth) | | int | [getWidth](#MixedStreamLayoutRegionConfig-getwidth) | | MixedStreamLayoutRegionConfig | [setHeight](#MixedStreamLayoutRegionConfig-setheight) | | double | [getHeight](#MixedStreamLayoutRegionConfig-getheight) | | MixedStreamLayoutRegionConfig | [setZOrder](#MixedStreamLayoutRegionConfig-setzorder) | | int | [getZOrder](#MixedStreamLayoutRegionConfig-getzorder) | | MixedStreamLayoutRegionConfig | [setAlpha](#MixedStreamLayoutRegionConfig-setalpha) | | double | [getAlpha](#MixedStreamLayoutRegionConfig-getalpha) | | MixedStreamLayoutRegionConfig | [setCornerRadius](#MixedStreamLayoutRegionConfig-setcornerradius) | | double | [getCornerRadius](#MixedStreamLayoutRegionConfig-getcornerradius) | | MixedStreamLayoutRegionConfig | [setMediaType](#MixedStreamLayoutRegionConfig-setmediatype) | | MixedStreamMediaType | [getMediaType](#MixedStreamLayoutRegionConfig-getmediatype) | | MixedStreamLayoutRegionConfig | [setRegionContentType](#MixedStreamLayoutRegionConfig-setregioncontenttype) | | MixedStreamLayoutRegionType | [getRegionContentType](#MixedStreamLayoutRegionConfig-getregioncontenttype) | | MixedStreamLayoutRegionConfig | [setRenderMode](#MixedStreamLayoutRegionConfig-setrendermode) | | MixedStreamRenderMode | [getRenderMode](#MixedStreamLayoutRegionConfig-getrendermode) | | boolean | [getIsLocalUser](#MixedStreamLayoutRegionConfig-getislocaluser) | | MixedStreamLayoutRegionConfig | [setIsLocalUser](#MixedStreamLayoutRegionConfig-setislocaluser) | | MixedStreamLayoutRegionConfig | [setStreamType](#MixedStreamLayoutRegionConfig-setstreamtype) | | MixedStreamVideoType | [getStreamType](#MixedStreamLayoutRegionConfig-getstreamtype) | | MixedStreamLayoutRegionConfig | [setImageWaterMark](#MixedStreamLayoutRegionConfig-setimagewatermark) | | byte[] | [getImageWaterMark](#MixedStreamLayoutRegionConfig-getimagewatermark) | | MixedStreamLayoutRegionConfig | [setImageWaterMarkConfig](#MixedStreamLayoutRegionConfig-setimagewatermarkconfig) | | MixedStreamLayoutRegionImageWaterMarkConfig | [getImageWaterMarkConfig](#MixedStreamLayoutRegionConfig-getimagewatermarkconfig) | | MixedStreamLayoutRegionConfig | [setAlternateImageFillMode](#MixedStreamLayoutRegionConfig-setalternateimagefillmode) | | MixedStreamAlternateImageFillMode | [getAlternateImageFillMode](#MixedStreamLayoutRegionConfig-getalternateimagefillmode) | | MixedStreamLayoutRegionConfig | [setAlternateImageURL](#MixedStreamLayoutRegionConfig-setalternateimageurl) | | String | [getAlternateImageURL](#MixedStreamLayoutRegionConfig-getalternateimageurl) | | MixedStreamLayoutRegionConfig | [setSpatialPosition](#MixedStreamLayoutRegionConfig-setspatialposition) | | Position | [getSpatialPosition](#MixedStreamLayoutRegionConfig-getspatialposition) | | MixedStreamLayoutRegionConfig | [setApplySpatialAudio](#MixedStreamLayoutRegionConfig-setapplyspatialaudio) | | boolean | [getApplySpatialAudio](#MixedStreamLayoutRegionConfig-getapplyspatialaudio) | ## 函数说明 ### setRoomID ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setRoomID(String roomID) ``` 设置视频流发布用户的房间 ID。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomID | String | 房间 ID。必填。 | ### getRoomID ```java String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getRoomID() ``` 获取视频流发布用户的房间 ID。 ### setUserID ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setUserID(String userID) ``` 设置视频流发布用户的用户 ID。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | userID | String | 用户 ID。 | ### getUserID ```java String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getUserID() ``` 获取视频流发布用户的用户 ID。 ### setLocationX ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setLocationX(int locationX) ``` > Available since 3.57 设置单个用户画面左上角在整个画布坐标系中的 X 坐标（pixel），即以画布左上角为原点，用户画面左上角相对于原点的横向位移。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | locationX | int | 用户画面左上角的横坐标。取值范围为 [0, 整体画布宽度)。默认值为 0。 | ### getLocationX ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getLocationX() ``` > Available since 3.57 获取单个用户画面左上角的横坐标。 ### setLocationY ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setLocationY(int locationY) ``` > Available since 3.57 设置单个用户画面左上角在整个画布坐标系中的 Y 坐标（pixel），即以画布左上角为原点，用户画面左上角相对于原点的纵向位移。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | locationY | int | 用户画面左上角的纵坐标。取值范围为 [0, 整体画布高度)。默认值为 0。 | ### getLocationY ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getLocationY() ``` > Available since 3.57 获取单个用户画面左上角的纵坐标。 ### setWidth ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setWidth(int width) ``` > Available since 3.57 设置单个用户画面的宽度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | int | 用户画面宽度。取值范围为 [0, 整体画布宽度]，默认值为 360。 | ### getWidth ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getWidth() ``` > Available since 3.57 获取单个用户画面的宽度。 ### setHeight ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setHeight(int height) ``` > Available since 3.57 设置单个用户画面的高度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | height | int | 用户画面高度。取值范围为 [0, 整体画布高度]，默认值为 640。 | ### getHeight ```java double com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getHeight() ``` > Available since 3.57 获取单个用户画面的高度。 ### setZOrder ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setZOrder(int zOrder) ``` 设置用户视频布局在画布中的层级。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | zOrder | int | 用户视频布局在画布中的层级。取值范围为 [0 - 100]，0 为底层，值越大越上层。默认值为 0。 | ### getZOrder ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getZOrder() ``` 获取用户视频布局在画布中的层级。 ### setAlpha ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setAlpha(double alpha) ``` （仅服务端合流支持设置）设置透明度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | alpha | double | 透明度，可选范围为 (0.0, 1.0]，0.0 为全透明。默认值为 1.0。 | ### getAlpha ```java double com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getAlpha() ``` 获取透明度。 ### setCornerRadius ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setCornerRadius(double cornerRadius) ``` （仅服务端合流支持设置）设置圆角半径。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | cornerRadius | double | 圆角半径相对画布宽度的比例。默认值为 `0.0`。 | **注意** 做范围判定时，首先根据画布的宽高，将 `width`，`height`，和 `radius` 分别转换为像素值：`width_px`，`height_px`，和 `radius_px`。然后判定是否满足 `radius_px < min(width_px/2, height_px/2)`：若满足，则设置成功；若不满足，则将 `radius_px` 设定为 `min(width_px/2, height_px/2)`，然后将 `radius` 设定为 `radius_px` 相对画布宽度的比例值。 ### getCornerRadius ```java double com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getCornerRadius() ``` 获取圆角半径。 **返回值** cornerRadius 圆角半径相对画布宽度的比例。默认值为 `0.0`。 **注意** 做范围判定时，首先根据画布的宽高，将 `width`，`height`，和 `radius` 分别转换为像素值：`width_px`，`height_px`，和 `radius_px`。然后判定是否满足 `radius_px < min(width_px/2, height_px/2)`：若满足，则设置成功；若不满足，则将 `radius_px` 设定为 `min(width_px/2, height_px/2)`，然后将 `radius` 设定为 `radius_px` 相对画布宽度的比例值。 ### setMediaType ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setMediaType(MixedStreamMediaType mediaType) ``` （仅服务端合流支持设置）设置合流内容类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mediaType | MixedStreamMediaType | 合流内容控制。默认值为 `MIXED_STREAM_MEDIA_TYPE_AUDIO_AND_VIDEO(0)`，参看 [MixedStreamMediaType](#MixedStreamMediaType)。 | ### getMediaType ```java MixedStreamMediaType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getMediaType() ``` 获取合流内容类型。 ### setRegionContentType ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setRegionContentType(MixedStreamLayoutRegionType regionContentType) ``` 设置合流布局区域类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | regionContentType | MixedStreamLayoutRegionType | 合流布局区域类型，详见 [MixedStreamLayoutRegionType](#MixedStreamLayoutRegionType)。 | ### getRegionContentType ```java MixedStreamLayoutRegionType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getRegionContentType() ``` 获取合流布局区域类型。 ### setRenderMode ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setRenderMode(MixedStreamRenderMode renderMode) ``` 设置图片或视频流渲染的缩放模式。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | renderMode | MixedStreamRenderMode | 图片或视频流的缩放模式，参看 [MixedStreamRenderMode](#MixedStreamRenderMode)。默认值为 1。 | ### getRenderMode ```java MixedStreamRenderMode com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getRenderMode() ``` 获取图片或视频流渲染的缩放模式。 ### getIsLocalUser ```java boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getIsLocalUser() ``` 是否本地用户。 **返回值** - true：是本地用户。 - false：不是本地用户。 ### setIsLocalUser ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setIsLocalUser(boolean islocalUser) ``` 设置是否是本地用户。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | islocalUser | boolean | 标识是否是本地用户

true: 是
false: 否

| ### setStreamType ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setStreamType(MixedStreamVideoType streamType) ``` 设置 region 中的流类型是主流还是屏幕流。仅服务端合流支持合屏幕流。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamType | MixedStreamVideoType | 流类型，参看 [MixedStreamVideoType](#MixedStreamVideoType)。 | ### getStreamType ```java MixedStreamVideoType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getStreamType() ``` 获取 region 中的流类型。 ### setImageWaterMark ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setImageWaterMark(byte[] imageWaterMark) ``` 设置图片合流区域类型对应的数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageWaterMark | byte[] | 图片合流布局区域类型对应的数据。类型为图片时传入图片 RGBA 数据，当类型为视频流时传空。 | ### getImageWaterMark ```java byte[] com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getImageWaterMark() ``` 获取图片合流区域类型对应的数据。 ### setImageWaterMarkConfig ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setImageWaterMarkConfig(MixedStreamLayoutRegionImageWaterMarkConfig imageWaterMarkConfig) ``` 设置图片合流布局区域数据的对应参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageWaterMarkConfig | MixedStreamLayoutRegionImageWaterMarkConfig | 合流布局区域数据的对应参数。当类型为视频流时传空，类型为图片时传入对应图片的参数，参看 [MixedStreamLayoutRegionImageWaterMarkConfig](#MixedStreamLayoutRegionConfig-MixedStreamLayoutRegionImageWaterMarkConfig)。 | ### getImageWaterMarkConfig ```java MixedStreamLayoutRegionImageWaterMarkConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getImageWaterMarkConfig() ``` 获取图片合流布局区域数据的对应参数。 ### setAlternateImageFillMode ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setAlternateImageFillMode(MixedStreamAlternateImageFillMode alternateImageFillMode) ``` > Available since 3.57 设置占位图的填充模式。该方法用来控制当用户停止发布视频流，画面恢复为占位图后，此时占位图的填充模式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | alternateImageFillMode | MixedStreamAlternateImageFillMode | 占位图的填充模式。参看 [MixedStreamAlternateImageFillMode](#MixedStreamAlternateImageFillMode)。 | ### getAlternateImageFillMode ```java MixedStreamAlternateImageFillMode com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getAlternateImageFillMode() ``` > Available since 3.57 获取占位图的填充模式设置。 ### setAlternateImageURL ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setAlternateImageURL(String alternateImageUrl) ``` > Available since 3.57 设置占位图的 URL，长度小于 1024 字符. **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | alternateImageUrl | String | url | ### getAlternateImageURL ```java String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getAlternateImageURL() ``` > Available since 3.57 获取占位图的 URL。 ### setSpatialPosition ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setSpatialPosition(Position spatialPosition) ``` 设置当前 region 空间音频位置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | spatialPosition | Position | 当前 region 的空间音频位置。 | ### getSpatialPosition ```java Position com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getSpatialPosition() ``` 获取当前 region 空间音频位置。 ### setApplySpatialAudio ```java MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setApplySpatialAudio(boolean applySpatialAudio) ``` 设置某用户是否应用空间音频效果。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | applySpatialAudio | boolean | 该用户是否应用空间音频效果：

true：启用（默认值）
false：禁用

| ### getApplySpatialAudio ```java boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getApplySpatialAudio() ``` 获取某用户是否应用空间音频效果的设置。 # AudioScenarioType ```java public enum com.ss.bytertc.engine.type.AudioScenarioType ``` 音频场景类型。选择音频场景后，SDK 会根据操作系统和开麦、闭麦状态，应用通话音量或媒体音量。参看[通话音量与媒体音量](https://www.volcengine.com/docs/6348/651068)了解更多相关信息。你可以调用 `setAudioScenario` 设置音频场景。如果以下音频场景类型无法满足你的业务需要，请联系技术支持人员。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_SCENARIO_MUSIC | 0 | （默认）音乐场景。
此场景适用于对音乐表现力有要求的场景，如音乐直播等。
注意：在此场景下，使用蓝牙耳麦时，会通过手机自带麦克风采集音频。因此，不适用“通话时手机放在包里”等类似场景。使用 `AUDIO_SCENARIO_HIGHQUALITY_COMMUNICATION` 可以不受此限制。
此外，使用扬声器时，开关麦可能发生音量突变。
不同音频设备，开麦和闭麦状态下的使用的音量类型：

	闭麦	开麦
内置扬声器	媒体音量	通话音量
内置听筒	通话音量	通话音量
有线耳机/ USB 耳机/ 外置声卡	媒体音量	媒体音量
蓝牙耳机	媒体音量	媒体音量

| | AUDIO_SCENARIO_HIGHQUALITY_COMMUNICATION | 1 | 高质量通话场景。兼顾外放/蓝牙耳机时的音频体验。
此场景适用于对音乐表现力有要求，但又希望能够使用蓝牙耳麦进行音频采集的场景。
注意：在此场景下，使用内置扬声器/听筒时，开关麦可能发生音量突变。使用 `AUDIO_SCENARIO_HIGHQUALITY_CHAT` 可以避免此种情况。
不同音频设备，开麦和闭麦状态下的使用的音量类型：

	闭麦	开麦
内置扬声器	媒体音量	通话音量
内置听筒	通话音量	通话音量
有线耳机/ USB 耳机/ 外置声卡	媒体音量	媒体音量
蓝牙耳机	通话音量	通话音量

| | AUDIO_SCENARIO_COMMUNICATION | 2 | 纯通话音量场景。
可以最大程度地消除回声，使通话清晰度达到最优。此场景下，无论客户端音频采集播放设备和采集播放状态，全程使用通话音量，不会有音量突变的听感。
适用于需要频繁上下麦的通话或会议场景。
但是，此场景会压低使用媒体音量进行播放的其他音频的音量，且音质会变差。 | | AUDIO_SCENARIO_MEDIA | 3 | 媒体场景。
当设备是内置听筒时，使用通话音量。其余情况使用媒体音量。
注意：在此场景下，使用蓝牙耳麦时，会通过手机自带麦克风采集音频。因此，不适用“通话时手机放在包里”等类似场景。
外放通话时，可能出现回声和啸叫，请联系技术支持人员。 | | AUDIO_SCENARIO_GAME_STREAMING | 4 | 游戏媒体场景。
若外放通话且无游戏音效消除优化时音质不理想，请联系技术支持人员。
不同音频设备，开麦和闭麦状态下的使用的音量类型：

	闭麦	开麦
内置扬声器	媒体音量	媒体音量
听筒	通话音量	通话音量
有线耳机/ USB 耳机/ 外置声卡	媒体音量	媒体音量
蓝牙耳机	通话音量	通话音量

| | AUDIO_SCENARIO_HIGHQUALITY_CHAT | 5 | 高质量畅聊场景。
此场景和 `AUDIO_SCENARIO_HIGHQUALITY_COMMUNICATION` 高度类似，唯一的差异在于：此场景下，在使用设备自带的麦克风和扬声器进行通话时，开关麦始终采用通话音量，不会引起音量类型突变。
不同音频设备，开麦和闭麦状态下的使用的音量类型：

	闭麦	开麦
内置扬声器	通话音量	通话音量
听筒	通话音量	通话音量
有线耳机/ USB 耳机/ 外置声卡	媒体音量	媒体音量
蓝牙耳机	通话音量	通话音量

| # AudioPropertiesMode ```java public enum com.ss.bytertc.engine.data.AudioPropertiesMode ``` [onLocalAudioPropertiesReport](70081#IRTCVideoEventHandler-onlocalaudiopropertiesreport) 中包含的音频信息的范围。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_PROPERTIES_MODE_MICROPHONE | 0 | 仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据。 | | AUDIO_PROPERTIES_MODE_AUDIOMIXING | 1 | 包含以下信息：

本地麦克风采集的音频数据和本地屏幕音频采集数据；

本地混音的音频数据。

| # ASRAuthorizationType ```java public enum com.ss.bytertc.engine.data.RTCASRConfig.ASRAuthorizationType ``` 语音识别服务鉴权方式，详情请咨询语音识别服务相关人员 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ASR_AUTHORIZATION_TYPE_TOKEN | 0 | Token 鉴权 | | ASR_AUTHORIZATION_TYPE_SIGNATURE | 1 | Signature 鉴权 | # VoiceEqualizationBandFrequency ```java public enum com.ss.bytertc.engine.type.VoiceEqualizationBandFrequency ``` 音频均衡效果。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | VOICE_EQUALIZATION_BAND_FREQUENCY_31 | 0 | 中心频率为 31Hz 的频带。 | | VOICE_EQUALIZATION_BAND_FREQUENCY_62 | 1 | 中心频率为 62Hz 的频带。 | | VOICE_EQUALIZATION_BAND_FREQUENCY_125 | 2 | 中心频率为 125Hz 的频带。 | | VOICE_EQUALIZATION_BAND_FREQUENCY_250 | 3 | 中心频率为 250Hz 的频带。 | | VOICE_EQUALIZATION_BAND_FREQUENCY_500 | 4 | 中心频率为 500Hz 的频带。 | | VOICE_EQUALIZATION_BAND_FREQUENCY_1K | 5 | 中心频率为 1kHz 的频带。 | | VOICE_EQUALIZATION_BAND_FREQUENCY_2K | 6 | 中心频率为 2kHz 的频带。 | | VOICE_EQUALIZATION_BAND_FREQUENCY_4K | 7 | 中心频率为 4kHz 的频带。 | | VOICE_EQUALIZATION_BAND_FREQUENCY_8K | 8 | 中心频率为 8kHz 的频带。 | | VOICE_EQUALIZATION_BAND_FREQUENCY_16K | 9 | 中心频率为 16kHz 的频带。 | # SysStats ```java public class com.ss.bytertc.engine.SysStats ``` CPU 和内存统计信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [cpuCores](#SysStats-cpucores) | | double | [cpuAppUsage](#SysStats-cpuappusage) | | double | [cpuTotalUsage](#SysStats-cputotalusage) | | double | [memoryUsage](#SysStats-memoryusage) | | long | [fullMemory](#SysStats-fullmemory) | | long | [totalMemoryUsage](#SysStats-totalmemoryusage) | | long | [freeMemory](#SysStats-freememory) | | double | [memoryRatio](#SysStats-memoryratio) | | double | [totalMemoryRatio](#SysStats-totalmemoryratio) | ## 变量说明 ### cpuCores ```java public int com.ss.bytertc.engine.SysStats.cpuCores ``` 设备的 CPU 核数 ### cpuAppUsage ```java public double com.ss.bytertc.engine.SysStats.cpuAppUsage ``` 应用的 CPU 使用率，取值范围为 [0, 1]。 ### cpuTotalUsage ```java public double com.ss.bytertc.engine.SysStats.cpuTotalUsage ``` 系统的 CPU 使用率，取值范围为 [0, 1]。 ### memoryUsage ```java public double com.ss.bytertc.engine.SysStats.memoryUsage ``` 应用的内存占用大小（单位 MB） ### fullMemory ```java public long com.ss.bytertc.engine.SysStats.fullMemory ``` 设备的内存大小单位：MB ### totalMemoryUsage ```java public long com.ss.bytertc.engine.SysStats.totalMemoryUsage ``` 系统已使用内存 MB ### freeMemory ```java public long com.ss.bytertc.engine.SysStats.freeMemory ``` 系统当前空闲内存（MB） ### memoryRatio ```java public double com.ss.bytertc.engine.SysStats.memoryRatio ``` 当前应用的内存使用率（单位 %） ### totalMemoryRatio ```java public double com.ss.bytertc.engine.SysStats.totalMemoryRatio ``` 系统内存使用率（单位 %） # VideoContentType ```java public enum com.ss.bytertc.engine.data.VideoContentType ``` 视频内容类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | NORMAL_FRAME | 0 | 普通视频 | | BLACK_FRAME | 1 | 黑帧视频 | # SubscribeConfig ```java public class com.ss.bytertc.engine.SubscribeConfig ``` 选择订阅配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | boolean | [isScreen](#SubscribeConfig-isscreen) | | boolean | [subVideo](#SubscribeConfig-subvideo) | | boolean | [subAudio](#SubscribeConfig-subaudio) | | int | [videoIndex](#SubscribeConfig-videoindex) | | int | [subWidth](#SubscribeConfig-subwidth) | | int | [subHeight](#SubscribeConfig-subheight) | | int | [framerate](#SubscribeConfig-framerate) | ## 变量说明 ### isScreen ```java public boolean com.ss.bytertc.engine.SubscribeConfig.isScreen ``` 是否是屏幕流 ### subVideo ```java public boolean com.ss.bytertc.engine.SubscribeConfig.subVideo ``` 是否订阅视频 ### subAudio ```java public boolean com.ss.bytertc.engine.SubscribeConfig.subAudio ``` 是否订阅音频 ### videoIndex ```java public int com.ss.bytertc.engine.SubscribeConfig.videoIndex ``` 订阅的视频流分辨率下标。用户可以在一路流中发布多个不同分辨率的视频。因此订阅流时，需要指定订阅的具体分辨率。此参数即用于指定需订阅的分辨率的下标，默认值为 0 。 ### subWidth ```java public int com.ss.bytertc.engine.SubscribeConfig.subWidth = 0 ``` 视频宽度，单位：px ### subHeight ```java public int com.ss.bytertc.engine.SubscribeConfig.subHeight = 0 ``` 视频高度，单位：px ### framerate ```java public int com.ss.bytertc.engine.SubscribeConfig.framerate = 0 ``` 期望订阅的最高帧率，单位：fps，默认值为 0，设为大于 0 的值时开始生效。如果发布端发布帧率 > 订阅端订阅的帧率，下行媒体服务器 SVC 丢帧，订阅端收到通过此接口设置的帧率；如果发布端发布帧率 < 订阅端订阅的帧率，则订阅端只能收到发布的帧率仅码流支持 SVC 分级编码特性时方可生效。 # EchoTestConfig ```java public class com.ss.bytertc.engine.data.EchoTestConfig ``` 音视频回路测试参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | View | [view](#EchoTestConfig-view) | | String | [uid](#EchoTestConfig-uid) | | String | [roomId](#EchoTestConfig-roomid) | | String | [token](#EchoTestConfig-token) | | boolean | [enableAudio](#EchoTestConfig-enableaudio) | | boolean | [enableVideo](#EchoTestConfig-enablevideo) | | int | [audioReportInterval](#EchoTestConfig-audioreportinterval) | ## 成员函数 | 返回 | 名称 | | --- | --- | | View | [getEchoRenderView](#EchoTestConfig-getechorenderview) | | String | [getEchoUid](#EchoTestConfig-getechouid) | | String | [getEchoRoomId](#EchoTestConfig-getechoroomid) | | String | [getEchoToken](#EchoTestConfig-getechotoken) | | boolean | [getEchoEnabledAudio](#EchoTestConfig-getechoenabledaudio) | | boolean | [getEchoEnabledVideo](#EchoTestConfig-getechoenabledvideo) | | int | [getAudioReportInterval](#EchoTestConfig-getaudioreportinterval) | ## 变量说明 ### view ```java public View com.ss.bytertc.engine.data.EchoTestConfig.view ``` 用于渲染接收到的视频的视图 ### uid ```java public String com.ss.bytertc.engine.data.EchoTestConfig.uid ``` 进行音视频通话回路测试的用户 ID ### roomId ```java public String com.ss.bytertc.engine.data.EchoTestConfig.roomId ``` 测试用户加入的房间 ID ### token ```java public String com.ss.bytertc.engine.data.EchoTestConfig.token ``` 对用户进房时进行鉴权验证的动态密钥，用于保证音视频通话回路测试的安全性。 ### enableAudio ```java public boolean com.ss.bytertc.engine.data.EchoTestConfig.enableAudio ``` 是否检测音频。检测设备为系统默认音频设备。 - true：是 - 若使用 SDK 内部采集，此时设备麦克风会自动开启，并在 audioReportInterval 值大于 0 时触发 `onLocalAudioPropertiesReport` 回调，你可以根据该回调判断麦克风的工作状态 - 若使用自定义采集，此时你需调用 [pushExternalAudioFrame](70080#RTCVideo-pushexternalaudioframe) 将采集到的音频推送给 SDK - false：否 ### enableVideo ```java public boolean com.ss.bytertc.engine.data.EchoTestConfig.enableVideo ``` 是否检测视频。PC 端默认检测列表中第一个视频设备。 - true：是 - 若使用 SDK 内部采集，此时设备摄像头会自动开启 - 若使用自定义采集，此时你需调用 [pushExternalVideoFrame](70080#RTCVideo-pushexternalvideoframe) 将采集到的视频推送给 SDK - false：否 **注意** 视频的发布参数固定为：分辨率 640px × 360px，帧率 15fps。 ### audioReportInterval ```java public int com.ss.bytertc.engine.data.EchoTestConfig.audioReportInterval ``` 音量信息提示间隔，单位：ms，默认为 100ms - `<= 0`: 关闭信息提示 - `(0,100]`: 开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms - `> 100`: 开启信息提示，并将信息提示间隔设置为此值 ## 函数说明 ### getEchoRenderView ```java View com.ss.bytertc.engine.data.EchoTestConfig.getEchoRenderView() ``` ### getEchoUid ```java String com.ss.bytertc.engine.data.EchoTestConfig.getEchoUid() ``` ### getEchoRoomId ```java String com.ss.bytertc.engine.data.EchoTestConfig.getEchoRoomId() ``` ### getEchoToken ```java String com.ss.bytertc.engine.data.EchoTestConfig.getEchoToken() ``` ### getEchoEnabledAudio ```java boolean com.ss.bytertc.engine.data.EchoTestConfig.getEchoEnabledAudio() ``` ### getEchoEnabledVideo ```java boolean com.ss.bytertc.engine.data.EchoTestConfig.getEchoEnabledVideo() ``` ### getAudioReportInterval ```java int com.ss.bytertc.engine.data.EchoTestConfig.getAudioReportInterval() ``` # AudioSampleRate ```java public enum com.ss.bytertc.engine.data.AudioSampleRate ``` 音频采样率，单位为 Hz。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_SAMPLE_RATE_AUTO | -1 | 默认设置。48000Hz。 | | AUDIO_SAMPLE_RATE_8000 | 8000 | 8000Hz | | AUDIO_SAMPLE_RATE_16000 | 16000 | 16000Hz | | AUDIO_SAMPLE_RATE_32000 | 32000 | 32000Hz | | AUDIO_SAMPLE_RATE_44100 | 44100 | 44100Hz | | AUDIO_SAMPLE_RATE_48000 | 48000 | 48000Hz | # MusicInfo ```java public class com.ss.bytertc.ktv.data.MusicInfo ``` 歌曲数据。 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [musicId](#MusicInfo-musicid) | | String | [musicName](#MusicInfo-musicname) | | String | [singer](#MusicInfo-singer) | | String | [vendorId](#MusicInfo-vendorid) | | String | [vendorName](#MusicInfo-vendorname) | | long | [updateTimestamp](#MusicInfo-updatetimestamp) | | String | [posterUrl](#MusicInfo-posterurl) | | LyricStatus | [lyricStatus](#MusicInfo-lyricstatus) | | int | [duration](#MusicInfo-duration) | | boolean | [enableScore](#MusicInfo-enablescore) | | int | [climaxStartTime](#MusicInfo-climaxstarttime) | | int | [climaxEndTime](#MusicInfo-climaxendtime) | ## 变量说明 ### musicId ```java public String com.ss.bytertc.ktv.data.MusicInfo.musicId ``` 音乐 ID。 ### musicName ```java public String com.ss.bytertc.ktv.data.MusicInfo.musicName ``` 音乐名称。 ### singer ```java public String com.ss.bytertc.ktv.data.MusicInfo.singer ``` 歌手。 ### vendorId ```java public String com.ss.bytertc.ktv.data.MusicInfo.vendorId ``` 版权商 ID。 ### vendorName ```java public String com.ss.bytertc.ktv.data.MusicInfo.vendorName ``` 版权商名称。 ### updateTimestamp ```java public long com.ss.bytertc.ktv.data.MusicInfo.updateTimestamp ``` 最新更新时间戳，单位为毫秒。 ### posterUrl ```java public String com.ss.bytertc.ktv.data.MusicInfo.posterUrl ``` 封面地址。 ### lyricStatus ```java public LyricStatus com.ss.bytertc.ktv.data.MusicInfo.lyricStatus ``` 歌词格式类型，参看 [LyricStatus](#LyricStatus)。 ### duration ```java public int com.ss.bytertc.ktv.data.MusicInfo.duration ``` 歌曲长度，单位为毫秒。 ### enableScore ```java public boolean com.ss.bytertc.ktv.data.MusicInfo.enableScore ``` 歌曲是否支持打分。 ### climaxStartTime ```java public int com.ss.bytertc.ktv.data.MusicInfo.climaxStartTime ``` 歌曲高潮片段开始时间，单位为毫秒。 ### climaxEndTime ```java public int com.ss.bytertc.ktv.data.MusicInfo.climaxEndTime ``` 歌曲高潮片段停止时间，单位为毫秒。 # MixedStreamVideoCodecType ```java public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.MixedStreamVideoCodecType ``` 视频编码格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MIXED_STREAM_VIDEO_CODEC_TYPE_H264 | H264 | H.264 格式，默认值。 | | MIXED_STREAM_VIDEO_CODEC_TYPE_BYTEVC1 | ByteVC1 | ByteVC1 格式。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | String | [getValue](#MixedStreamVideoCodecType-getvalue) | ## 函数说明 ### getValue ```java String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.MixedStreamVideoCodecType.getValue() ``` 获取视频编码格式。 **返回值** 视频编码格式。 # MuteState ```java public enum com.ss.bytertc.engine.data.MuteState ``` 音视频流的发送/播放状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MUTE_STATE_OFF | 0 | 发送 | | MUTE_STATE_ON | 1 | 停止发送 | # ByteRTCStreamMixingType ```java public enum com.ss.bytertc.engine.live.ByteRTCStreamMixingType ``` 合流类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | STREAM_MIXING_BY_SERVER | 0 | 服务端合流。 | | STREAM_MIXING_BY_CLIENT | 1 | 保留字段，无意义 | ## 成员函数 | 返回 | 名称 | | --- | --- | | ByteRTCStreamMixingType | [ByteRTCStreamMixingType](#ByteRTCStreamMixingType-bytertcstreammixingtype) | ## 函数说明 ### ByteRTCStreamMixingType ```java com.ss.bytertc.engine.live.ByteRTCStreamMixingType.ByteRTCStreamMixingType(int value) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | value | int | - | # MediaDeviceError ```java public class com.ss.bytertc.engine.type.MediaDeviceError ``` 媒体设备错误类型 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [MEDIA_DEVICE_ERROR_OK](#MediaDeviceError-media_device_error_ok) | | int | [MEDIA_DEVICE_ERROR_NOPERMISSION](#MediaDeviceError-media_device_error_nopermission) | | int | [MEDIA_DEVICE_ERROR_DEVICEBUSY](#MediaDeviceError-media_device_error_devicebusy) | | int | [MEDIA_DEVICE_ERROR_DEVICEFAILURE](#MediaDeviceError-media_device_error_devicefailure) | | int | [MEDIA_DEVICE_ERROR_DEVICENOTFOUND](#MediaDeviceError-media_device_error_devicenotfound) | | int | [MEDIA_DEVICE_ERROR_DEVICEDISCONNECTED](#MediaDeviceError-media_device_error_devicedisconnected) | | int | [MEDIA_DEVICE_ERROR_DEVICENOCALLBACK](#MediaDeviceError-media_device_error_devicenocallback) | | int | [MEDIA_DEVICE_ERROR_UNSUPPORTFORMAT](#MediaDeviceError-media_device_error_unsupportformat) | ## 变量说明 ### MEDIA_DEVICE_ERROR_OK ```java public static final int com.ss.bytertc.engine.type.MediaDeviceError.MEDIA_DEVICE_ERROR_OK = 0 ``` 媒体设备正常 ### MEDIA_DEVICE_ERROR_NOPERMISSION ```java public static final int com.ss.bytertc.engine.type.MediaDeviceError.MEDIA_DEVICE_ERROR_NOPERMISSION = 1 ``` 没有权限启动媒体设备 ### MEDIA_DEVICE_ERROR_DEVICEBUSY ```java public static final int com.ss.bytertc.engine.type.MediaDeviceError.MEDIA_DEVICE_ERROR_DEVICEBUSY = 2 ``` 媒体设备已经在使用中 ### MEDIA_DEVICE_ERROR_DEVICEFAILURE ```java public static final int com.ss.bytertc.engine.type.MediaDeviceError.MEDIA_DEVICE_ERROR_DEVICEFAILURE = 3 ``` 媒体设备错误 ### MEDIA_DEVICE_ERROR_DEVICENOTFOUND ```java public static final int com.ss.bytertc.engine.type.MediaDeviceError.MEDIA_DEVICE_ERROR_DEVICENOTFOUND = 4 ``` 未找到指定的媒体设备 ### MEDIA_DEVICE_ERROR_DEVICEDISCONNECTED ```java public static final int com.ss.bytertc.engine.type.MediaDeviceError.MEDIA_DEVICE_ERROR_DEVICEDISCONNECTED = 5 ``` 媒体设备被移除 ### MEDIA_DEVICE_ERROR_DEVICENOCALLBACK ```java public static final int com.ss.bytertc.engine.type.MediaDeviceError.MEDIA_DEVICE_ERROR_DEVICENOCALLBACK = 6 ``` 无采集数据。当媒体设备的预期行为是正常采集，但没有收到采集数据时，将收到该错误。 ### MEDIA_DEVICE_ERROR_UNSUPPORTFORMAT ```java public static final int com.ss.bytertc.engine.type.MediaDeviceError.MEDIA_DEVICE_ERROR_UNSUPPORTFORMAT = 7 ``` 设备采样率不支持 # CpuBufferVideoFrameBuilder ```java public class com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder ``` 构建 CpuBuffer 的视频帧 ## 成员函数 | 返回 | 名称 | | --- | --- | | CpuBufferVideoFrameBuilder | [setTimeStampUs](#CpuBufferVideoFrameBuilder-settimestampus) | | CpuBufferVideoFrameBuilder | [setWidth](#CpuBufferVideoFrameBuilder-setwidth) | | CpuBufferVideoFrameBuilder | [setHeight](#CpuBufferVideoFrameBuilder-setheight) | | CpuBufferVideoFrameBuilder | [setRotation](#CpuBufferVideoFrameBuilder-setrotation) | | CpuBufferVideoFrameBuilder | [setColorSpace](#CpuBufferVideoFrameBuilder-setcolorspace) | | CpuBufferVideoFrameBuilder | [setPlaneData](#CpuBufferVideoFrameBuilder-setplanedata) | | CpuBufferVideoFrameBuilder | [setPlaneStride](#CpuBufferVideoFrameBuilder-setplanestride) | | CpuBufferVideoFrameBuilder | [setExternalDataInfo](#CpuBufferVideoFrameBuilder-setexternaldatainfo) | | CpuBufferVideoFrameBuilder | [setSupplementaryInfo](#CpuBufferVideoFrameBuilder-setsupplementaryinfo) | | CpuBufferVideoFrameBuilder | [setReleaseCallback](#CpuBufferVideoFrameBuilder-setreleasecallback) | | VideoFrame | [build](#CpuBufferVideoFrameBuilder-build) | ## 函数说明 ### setTimeStampUs ```java CpuBufferVideoFrameBuilder com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder.setTimeStampUs(long timeStampUs) ``` 设置视频帧的时间戳 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | timeStampUs | long | 视频帧时间戳 | ### setWidth ```java CpuBufferVideoFrameBuilder com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder.setWidth(int width) ``` 设置视频帧宽度 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | int | 视频帧宽度，单位：像素 | ### setHeight ```java CpuBufferVideoFrameBuilder com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder.setHeight(int height) ``` 设置视频帧高度 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | height | int | 视频帧高度，单位：像素 | ### setRotation ```java CpuBufferVideoFrameBuilder com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder.setRotation(VideoRotation rotation) ``` 设置视频帧旋转角度 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | rotation | VideoRotation | 视频帧旋转角度，参看 [VideoRotation](#VideoRotation) | ### setColorSpace ```java CpuBufferVideoFrameBuilder com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder.setColorSpace(ColorSpace colorSpace) ``` 设置视频帧色彩空间 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | colorSpace | ColorSpace | 视频帧色彩空间，参看 [ColorSpace](#ColorSpace) | ### setPlaneData ```java CpuBufferVideoFrameBuilder com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder.setPlaneData( int planeIndex, ByteBuffer buffer ) ``` 设置像素平面数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | planeIndex | int | 像素平面数据索引 | | buffer | ByteBuffer | plane 要设置的 ByteBuffer，如果设置的是一个 DirectBuffer，则不会发生拷贝，如果不是，则会发生一次拷贝 | ### setPlaneStride ```java CpuBufferVideoFrameBuilder com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder.setPlaneStride( int planeIndex, int stride ) ``` 设置指定像素平面的跨距 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | planeIndex | int | 像素平面数据索引 | | stride | int | 当前像素平面的跨度 | ### setExternalDataInfo ```java CpuBufferVideoFrameBuilder com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder.setExternalDataInfo(ByteBuffer externalDataInfo) ``` 设置 SEI 数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | externalDataInfo | ByteBuffer | SEI 数据，如果设置的是一个 DirectBuffer，则不会发生拷贝，如果不是，则会发生一次拷贝 | ### setSupplementaryInfo ```java CpuBufferVideoFrameBuilder com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder.setSupplementaryInfo(ByteBuffer supplementaryInfo) ``` 设置补充数据指针 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | supplementaryInfo | ByteBuffer | 补充数据指针，如果设置的是一个 DirectBuffer，则不会发生拷贝，如果不是，则会发生一次拷贝 | ### setReleaseCallback ```java CpuBufferVideoFrameBuilder com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder.setReleaseCallback(Runnable releaseCallback) ``` 设置视频帧的释放回调，当视频帧的引用计数归 0 时，会执行 releaseCallback **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | releaseCallback | Runnable | 视频帧的释放回调 | ### build ```java VideoFrame com.ss.bytertc.engine.video.builder.CpuBufferVideoFrameBuilder.build() ``` 获取到创建好的视频帧 **返回值** 创建好的视频帧，参看 [VideoFrame](#VideoFrame) # AudioFrameSource ```java public enum com.ss.bytertc.engine.data.AudioFrameSource ``` 音频文件录制内容来源。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_FRAME_SOURCE_MIC | 0 | 本地麦克风采集的音频数据。 | | AUDIO_FRAME_SOURCE_PLAYBACK | 1 | 远端所有用户混音后的数据 | | AUDIO_FRAME_SOURCE_MIXED | 2 | 本地麦克风和所有远端用户音频流的混音后的数据 | # StreamRemoveReason ```java public enum com.ss.bytertc.engine.type.StreamRemoveReason ``` 房间内远端流移除原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | STREAM_REMOVE_REASON_UNPUBLISH | 0 | 远端用户停止发布流。 | | STREAM_REMOVE_REASON_PUBLISH_FAILED | 1 | 远端用户发布流失败。 | | STREAM_REMOVE_REASON_KEEP_LIVE_FAILED | 2 | 媒体服务器 10s 没收到客户端的媒体数据。 | | STREAM_REMOVE_REASON_CLIENT_DISCONNECTED | 3 | 远端用户断网。 | | STREAM_REMOVE_REASON_REPUBLISH | 4 | 远端用户重新发布流。 | | STREAM_REMOVE_REASON_OTHER | 5 | 其他原因。 | | STREAM_REMOVE_REASON_PUBLISH_PRIVILEGE_TOKEN_EXPIRED | 6 | 远端用户 Token 发布权限过期。 | # ForwardStreamError ```java public enum com.ss.bytertc.engine.data.ForwardStreamStateInfo.ForwardStreamError ``` 媒体流跨房间转发过程中抛出的错误码 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | FORWARD_STREAM_ERROR_OK | 0 | 正常 | | FORWARD_STREAM_ERROR_INVALID_ARGUMENT | 1201 | 参数异常 | | FORWARD_STREAM_ERROR_INVALID_TOKEN | 1202 | token 错误 | | FORWARD_STREAM_ERROR_RESPONSE | 1203 | 服务端异常 | | FORWARD_STREAM_ERROR_REMOTE_KICKED | 1204 | 目标房间有相同 user id 的用户加入，转发中断 | | FORWARD_STREAM_ERROR_NOT_SUPPORT | 1205 | 服务端不支持转发功能 | # NetworkDetectionStopReason ```java public enum com.ss.bytertc.engine.type.NetworkDetectionStopReason ``` 通话前探测的停止原因。 `onNetworkDetectionStopped` 回调的参数类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | USER | 0 | 用户主动停止 | | TIMEOUT | 1 | 探测超过三分钟 | | CONNECTION_LOST | 2 | 探测网络连接断开。
当超过 12s 没有收到回复，SDK 将断开网络连接，并且不再尝试重连。 | | STREAMING | 3 | 本地开始推拉流，停止探测 | | INNER_ERR | 4 | 网络探测失败，内部异常 | # ReceiveRange ```java public class com.ss.bytertc.engine.data.ReceiveRange ``` 本地用户能收听到、且具有衰减效果的音频接收范围 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [min](#ReceiveRange-min) | | int | [max](#ReceiveRange-max) | ## 变量说明 ### min ```java public int com.ss.bytertc.engine.data.ReceiveRange.min ``` 能够接收语音、并且具有衰减效果的最小距离值，该值须 ≥ 0，但 ≤ max。小于该值的范围内没有范围语音效果，即收听到的音频音量相同。 ### max ```java public int com.ss.bytertc.engine.data.ReceiveRange.max ``` 能够收听语音的最大距离值，该值须 \> 0 且 ≥ min。当收听者和声源距离处于 [min, max) 之间时，收听到的音量根据距离呈衰减效果。超出该值范围的音频将无法收听到。 # NetworkQuality ```java public class com.ss.bytertc.engine.type.NetworkQuality ``` 所属用户的媒体流网络质量。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [NETWORK_QUALITY_UNKNOWN](#NetworkQuality-network_quality_unknown) | | int | [NETWORK_QUALITY_EXCELLENT](#NetworkQuality-network_quality_excellent) | | int | [NETWORK_QUALITY_GOOD](#NetworkQuality-network_quality_good) | | int | [NETWORK_QUALITY_POOR](#NetworkQuality-network_quality_poor) | | int | [NETWORK_QUALITY_BAD](#NetworkQuality-network_quality_bad) | | int | [NETWORK_QUALITY_VERY_BAD](#NetworkQuality-network_quality_very_bad) | | int | [NETWORK_QUALITY_DOWN](#NetworkQuality-network_quality_down) | ## 变量说明 ### NETWORK_QUALITY_UNKNOWN ```java public static final int com.ss.bytertc.engine.type.NetworkQuality.NETWORK_QUALITY_UNKNOWN = 0 ``` 媒体流网络质量未知。 ### NETWORK_QUALITY_EXCELLENT ```java public static final int com.ss.bytertc.engine.type.NetworkQuality.NETWORK_QUALITY_EXCELLENT = 1 ``` 媒体流网络质量极好。 ### NETWORK_QUALITY_GOOD ```java public static final int com.ss.bytertc.engine.type.NetworkQuality.NETWORK_QUALITY_GOOD = 2 ``` 媒体流网络质量好。 ### NETWORK_QUALITY_POOR ```java public static final int com.ss.bytertc.engine.type.NetworkQuality.NETWORK_QUALITY_POOR = 3 ``` 媒体流网络质量较差但不影响沟通。 ### NETWORK_QUALITY_BAD ```java public static final int com.ss.bytertc.engine.type.NetworkQuality.NETWORK_QUALITY_BAD = 4 ``` 媒体流网络质量差沟通不顺畅。 ### NETWORK_QUALITY_VERY_BAD ```java public static final int com.ss.bytertc.engine.type.NetworkQuality.NETWORK_QUALITY_VERY_BAD = 5 ``` 媒体流网络质量非常差。 ### NETWORK_QUALITY_DOWN ```java public static final int com.ss.bytertc.engine.type.NetworkQuality.NETWORK_QUALITY_DOWN = 6 ``` 网络连接断开，无法通话。网络可能由于 12s 内无应答、开启飞行模式、拔掉网线等原因断开。更多网络状态信息参见 [连接状态提示](https://www.volcengine.com/docs/6348/95376)。 # ZoomConfigType ```java public enum com.ss.bytertc.engine.data.ZoomConfigType ``` 数码变焦参数类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ZOOM_FOCUS_OFFSET | 0 | 设置缩放系数 | | ZOOM_MOVE_OFFSET | 1 | 设置移动步长 | # StreamSycnInfoConfig ```java public class com.ss.bytertc.engine.data.StreamSycnInfoConfig ``` 媒体流信息同步的相关配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | StreamIndex | [streamIndex](#StreamSycnInfoConfig-streamindex) | | int | [repeatCount](#StreamSycnInfoConfig-repeatcount) | | SyncInfoStreamType | [streamType](#StreamSycnInfoConfig-streamtype) | ## 变量说明 ### streamIndex ```java public StreamIndex com.ss.bytertc.engine.data.StreamSycnInfoConfig.streamIndex ``` 流属性，主流或屏幕流。见枚举类 [StreamIndex](#StreamIndex) - `STREAM_INDEX_MAIN(0)`: 主流 - `STREAM_INDEX_SCREEN(1)`: 屏幕流 ### repeatCount ```java public int com.ss.bytertc.engine.data.StreamSycnInfoConfig.repeatCount ``` 信息发送的重复次数。取值范围是 [0,25]，建议设置为 [3,5] ### streamType ```java public SyncInfoStreamType com.ss.bytertc.engine.data.StreamSycnInfoConfig.streamType ``` 媒体流信息同步的流类型，见 [SyncInfoStreamType](#SyncInfoStreamType) # LocalVideoStats ```java public class com.ss.bytertc.engine.type.LocalVideoStats ``` 本地视频流统计信息，统计周期为 2s 。本地用户发布视频流成功后，SDK 会周期性地通过 `onLocalStreamStats` 通知用户发布的视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [sentKBitrate](#LocalVideoStats-sentkbitrate) | | int | [inputFrameRate](#LocalVideoStats-inputframerate) | | int | [sentFrameRate](#LocalVideoStats-sentframerate) | | int | [encoderOutputFrameRate](#LocalVideoStats-encoderoutputframerate) | | int | [rendererOutputFrameRate](#LocalVideoStats-rendereroutputframerate) | | int | [statsInterval](#LocalVideoStats-statsinterval) | | float | [videoLossRate](#LocalVideoStats-videolossrate) | | int | [rtt](#LocalVideoStats-rtt) | | int | [encodedBitrate](#LocalVideoStats-encodedbitrate) | | int | [encodedFrameWidth](#LocalVideoStats-encodedframewidth) | | int | [encodedFrameHeight](#LocalVideoStats-encodedframeheight) | | int | [encodedFrameCount](#LocalVideoStats-encodedframecount) | | int | [codecType](#LocalVideoStats-codectype) | | boolean | [isScreen](#LocalVideoStats-isscreen) | | int | [jitter](#LocalVideoStats-jitter) | ## 变量说明 ### sentKBitrate ```java public float com.ss.bytertc.engine.type.LocalVideoStats.sentKBitrate ``` 发送码率。此次统计周期内实际发送的分辨率最大的视频流的发送码率，单位为 Kbps ### inputFrameRate ```java public int com.ss.bytertc.engine.type.LocalVideoStats.inputFrameRate ``` 采集帧率。此次统计周期内的视频采集帧率，单位为 fps 。 ### sentFrameRate ```java public int com.ss.bytertc.engine.type.LocalVideoStats.sentFrameRate ``` 发送帧率。此次统计周期内实际发送的分辨率最大的视频流的视频发送帧率，单位为 fps 。 ### encoderOutputFrameRate ```java public int com.ss.bytertc.engine.type.LocalVideoStats.encoderOutputFrameRate ``` 编码器输出帧率。当前编码器在此次统计周期内实际发送的分辨率最大的视频流的输出帧率，单位为 fps 。 ### rendererOutputFrameRate ```java public int com.ss.bytertc.engine.type.LocalVideoStats.rendererOutputFrameRate ``` 本地渲染帧率。此次统计周期内的本地视频渲染帧率，单位为 fps 。 ### statsInterval ```java public int com.ss.bytertc.engine.type.LocalVideoStats.statsInterval ``` 统计间隔，单位为 ms 。此字段用于设置回调的统计周期，默认设置为 2s 。 ### videoLossRate ```java public float com.ss.bytertc.engine.type.LocalVideoStats.videoLossRate ``` 视频丢包率。此次统计周期内的视频上行丢包率，取值范围： [0，1] 。 ### rtt ```java public int com.ss.bytertc.engine.type.LocalVideoStats.rtt ``` 往返时延，单位为 ms 。 ### encodedBitrate ```java public int com.ss.bytertc.engine.type.LocalVideoStats.encodedBitrate ``` 视频编码码率。此次统计周期内的实际发送的分辨率最大的视频流视频编码码率，单位为 Kbps 。 ### encodedFrameWidth ```java public int com.ss.bytertc.engine.type.LocalVideoStats.encodedFrameWidth ``` 实际发送的分辨率最大的视频流的视频编码宽度，单位为 px 。 ### encodedFrameHeight ```java public int com.ss.bytertc.engine.type.LocalVideoStats.encodedFrameHeight ``` 实际发送的分辨率最大的视频流的视频编码高度，单位为 px 。 ### encodedFrameCount ```java public int com.ss.bytertc.engine.type.LocalVideoStats.encodedFrameCount ``` 此次统计周期内实际发送的分辨率最大的视频流的发送的视频帧总数。 ### codecType ```java public int com.ss.bytertc.engine.type.LocalVideoStats.codecType ``` 视频的编码类型，具体参考 [VideoCodecType](#VideoCodecType)。 ### isScreen ```java public boolean com.ss.bytertc.engine.type.LocalVideoStats.isScreen ``` 所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。 ### jitter ```java public int com.ss.bytertc.engine.type.LocalVideoStats.jitter ``` 视频上行网络抖动，单位为 ms 。 # AudioRecordingState ```java public enum com.ss.bytertc.engine.type.AudioRecordingState ``` 录音配置 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_RECORDING_STATE_ERROR | 0 | 录制异常 | | AUDIO_RECORDING_STATE_PROCESSING | 1 | 录制进行中 | | AUDIO_RECORDING_STATE_SUCCESS | 2 | 已结束录制，并且录制文件保存成功。 | # MulDimSingScoringMode ```java public enum com.ss.bytertc.engine.data.MulDimSingScoringMode ``` K 歌打分维度。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MUL_DIM_SING_SCORING_MODE_NOTE | 0 | 按照音高进行评分。 | # AudioPlaybackDevice ```java public enum com.ss.bytertc.engine.data.AudioPlaybackDevice ``` 音频播放设备音频设备变化时 SDK 通过 `onAudioPlaybackDeviceChanged` 回调当前音频播放设备。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_PLAYBACK_DEVICE_HEADSET | 1 | 有线耳机 | | AUDIO_PLAYBACK_DEVICE_EARPIECE | 2 | 听筒 | | AUDIO_PLAYBACK_DEVICE_SPEAKERPHONE | 3 | 扬声器 | | AUDIO_PLAYBACK_DEVICE_HEADSET_BLUETOOTH | 4 | 蓝牙耳机 | | AUDIO_PLAYBACK_DEVICE_HEADSET_USB | 5 | USB 设备 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [value](#AudioPlaybackDevice-value) | ## 函数说明 ### value ```java int com.ss.bytertc.engine.data.AudioPlaybackDevice.value() ``` 获取当前值 **返回值** 当前值 # ForwardStreamInfo ```java public class com.ss.bytertc.engine.data.ForwardStreamInfo ``` 媒体流跨房间转发的目标房间的相关信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [roomId](#ForwardStreamInfo-roomid) | | String | [token](#ForwardStreamInfo-token) | ## 变量说明 ### roomId ```java public String com.ss.bytertc.engine.data.ForwardStreamInfo.roomId ``` 跨房间转发媒体流过程中目标房间 ID ### token ```java public String com.ss.bytertc.engine.data.ForwardStreamInfo.token ``` 使用转发目标房间 RoomID 和 UserID 生成的 Token。测试时可使用控制台生成临时 Token，正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token。如果 Token 无效，转发失败。 # VideoPreprocessorConfig ```java public class com.ss.bytertc.engine.video.VideoPreprocessorConfig ``` 视频处理配置参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | VideoPixelFormat | [requiredPixelFormat](#VideoPreprocessorConfig-requiredpixelformat) | ## 变量说明 ### requiredPixelFormat ```java public VideoPixelFormat com.ss.bytertc.engine.video.VideoPreprocessorConfig.requiredPixelFormat = VideoPixelFormat.UNKNOWN ``` 设置请求的像素格式，参看 [VideoPixelFormat](#VideoPixelFormat)。当前仅支持 `I420`、`TEXTURE_2D` 和 `UNKNOWN` 格式。 # LocalProxyConfiguration ```java public class com.ss.bytertc.engine.type.LocalProxyConfiguration ``` 本地代理配置详细信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | LocalProxyType | [localProxyType](#LocalProxyConfiguration-localproxytype) | | String | [localProxyIp](#LocalProxyConfiguration-localproxyip) | | int | [localProxyPort](#LocalProxyConfiguration-localproxyport) | | String | [localProxyUsername](#LocalProxyConfiguration-localproxyusername) | | String | [localProxyPassword](#LocalProxyConfiguration-localproxypassword) | ## 变量说明 ### localProxyType ```java public LocalProxyType com.ss.bytertc.engine.type.LocalProxyConfiguration.localProxyType ``` 本地代理类型，参看 [LocalProxyType](#localproxytype-2)。 ### localProxyIp ```java public String com.ss.bytertc.engine.type.LocalProxyConfiguration.localProxyIp ``` 本地代理服务器 IP。 ### localProxyPort ```java public int com.ss.bytertc.engine.type.LocalProxyConfiguration.localProxyPort ``` 本地代理服务器端口。 ### localProxyUsername ```java public String com.ss.bytertc.engine.type.LocalProxyConfiguration.localProxyUsername ``` 本地代理用户名。 ### localProxyPassword ```java public String com.ss.bytertc.engine.type.LocalProxyConfiguration.localProxyPassword ``` 本地代理密码。 # AudioFrame ```java public class com.ss.bytertc.engine.utils.AudioFrame ``` PCM 音频帧 ## 成员变量 | 类型 | 名称 | | --- | --- | | byte[] | [buffer](#AudioFrame-buffer) | | int | [samples](#AudioFrame-samples) | | AudioSampleRate | [sampleRate](#AudioFrame-samplerate) | | AudioChannel | [channel](#AudioFrame-channel) | ## 变量说明 ### buffer ```java public byte [] com.ss.bytertc.engine.utils.AudioFrame.buffer ``` PCM 数据 ### samples ```java public int com.ss.bytertc.engine.utils.AudioFrame.samples ``` 采样点个数 ### sampleRate ```java public AudioSampleRate com.ss.bytertc.engine.utils.AudioFrame.sampleRate ``` 采样率，参看 [AudioSampleRate](#AudioSampleRate)。 ### channel ```java public AudioChannel com.ss.bytertc.engine.utils.AudioFrame.channel ``` 音频声道，参看 [AudioChannel](#AudioChannel)。 # AudioDumpStatus ```java public enum com.ss.bytertc.engine.type.AudioDumpStatus ``` 音频 dump 状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_DUMP_START_FAILURE | 0 | 音频 dump 启动失败 | | AUDIO_DUMP_START_SUCCESS | 1 | 音频 dump 启动成功 | | AUDIO_DUMP_STOP_FAILURE | 2 | 音频 dump 停止失败 | | AUDIO_DUMP_STOP_SUCCESS | 3 | 音频 dump 停止成功 | | AUDIO_DUMP_RUNNING_FAILURE | 4 | 音频 dump 运行失败 | | AUDIO_DUMP_RUNNING_SUCCESS | 5 | 音频 dump 运行成功 | # EncoderPreference ```java public enum com.ss.bytertc.engine.VideoEncoderConfig.EncoderPreference ``` 编码策略偏好。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | DISABLED | 0 | 无偏好。不降低帧率和分辨率。 | | MAINTAIN_FRAMERATE | 1 | （默认值）帧率优先。分辨率不变。 | | MAINTAIN_QUALITY | 2 | 分辨率优先。 | | BALANCE | 3 | 平衡帧率与分辨率。 | # DownloadResult ```java public class com.ss.bytertc.ktv.data.DownloadResult ``` 歌曲下载信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [musicId](#DownloadResult-musicid) | | DownloadFileType | [fileType](#DownloadResult-filetype) | | String | [filePath](#DownloadResult-filepath) | ## 变量说明 ### musicId ```java public String com.ss.bytertc.ktv.data.DownloadResult.musicId ``` 音乐 ID。 ### fileType ```java public DownloadFileType com.ss.bytertc.ktv.data.DownloadResult.fileType ``` 下载文件类型，参看 [DownloadFileType](#DownloadFileType)。 ### filePath ```java public String com.ss.bytertc.ktv.data.DownloadResult.filePath ``` 文件存放路径。 # ProblemFeedbackOption ```java public enum com.ss.bytertc.engine.type.ProblemFeedbackOption ``` 音视频质量反馈问题类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | NONE | 0 | 没有问题 | | OTHER_MESSAGE | 1L | 其他问题 | | DISCONNECTED | 1L << 1 | 连接失败 | | EAR_BACK_DELAY | 1L << 2 | 耳返延迟大 | | LOCAL_NOISE | 1L << 10 | 本端有杂音 | | LOCAL_AUDIO_LAGGING | 1L << 11 | 本端声音卡顿 | | LOCAL_NO_AUDIO | 1L << 12 | 本端无声音 | | LOCAL_AUDIO_STRENGTH | 1L << 13 | 本端声音大/小 | | LOCAL_ECHO | 1L << 14 | 本端有回声 | | LOCAL_VIDEO_FUZZY | 1L << 24 | 本端视频模糊 | | LOCAL_NOT_SYNC | 1L << 25 | 本端音视频不同步 | | LOCAL_VIDEO_LAGGING | 1L << 26 | 本端视频卡顿 | | LOCAL_NO_VIDEO | 1L << 27 | 本端无画面 | | REMOTE_NOISE | 1L << 37 | 远端有杂音 | | REMOTE_AUDIO_LAGGING | 1L << 38 | 远端声音卡顿 | | REMOTE_NO_AUDIO | 1L << 39 | 远端无声音 | | REMOTE_AUDIO_STRENGTH | 1L << 40 | 远端声音大/小 | | REMOTE_ECHO | 1L << 41 | 远端有回声 | | REMOTE_VIDEO_FUZZY | 1L << 51 | 远端视频模糊 | | REMOTE_NOT_SYNC | 1L << 52 | 远端音视频不同步 | | REMOTE_VIDEO_LAGGING | 1L << 53 | 远端视频卡顿 | | REMOTE_NO_VIDEO | 1L << 54 | 远端无画面 | # VideoConfig ```java static class com.ss.bytertc.engine.publicstream.PublicStreaming.VideoConfig ``` 公共流的视频编码参数 ## 成员函数 | 返回 | 名称 | | --- | --- | | VideoConfig | [setFps](#VideoConfig-setfps-2) | | VideoConfig | [setKBitRate](#VideoConfig-setkbitrate-2) | | VideoConfig | [setWidth](#VideoConfig-setwidth-2) | | VideoConfig | [setHeight](#VideoConfig-setheight-2) | ## 函数说明 ### setFps ```java VideoConfig com.ss.bytertc.engine.publicstream.PublicStreaming.VideoConfig.setFps(int fps) ``` 设置公共流视频帧率。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | fps | int | 公共流视频帧率。必填
范围：[1, 60]
默认值：30 fps | **返回值** 公共流视频参数。详见 [VideoConfig](#videoconfig-2) 数据类型。 ### setKBitRate ```java VideoConfig com.ss.bytertc.engine.publicstream.PublicStreaming.VideoConfig.setKBitRate(int kBitRate) ``` 设置公共流视频码率 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | kBitRate | int | 视频码率，必填
范围：[1,10000000]
单位为 bps，默认值为 500 。 | **返回值** 公共流视频参数。详见 [VideoConfig](#videoconfig-2) 数据类型。 ### setWidth ```java VideoConfig com.ss.bytertc.engine.publicstream.PublicStreaming.VideoConfig.setWidth(int width) ``` 设置公共流视频宽度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | int | 公共流视频宽度，必填。单位为 px，范围为 [16, 1920]，必须是偶数。默认值为 360 px。 | **返回值** 公共流视频参数。详见 [VideoConfig](#videoconfig-2) 数据类型。 ### setHeight ```java VideoConfig com.ss.bytertc.engine.publicstream.PublicStreaming.VideoConfig.setHeight(int height) ``` 设置公共流视频高度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | height | int | 公共流视频高度，必填。单位为 px，范围为 [16, 1280]，必须是偶数。默认值为 640。 | **返回值** 公共流视频参数。详见 [VideoConfig](#videoconfig-2) 数据类型。 # Region ```java public static class com.ss.bytertc.engine.live.LiveTranscoding.Region ``` 单个图片或视频流在合流中的布局信息。开启转推直播功能后，在多路视频流合流时，你可以设置其中一路视频流在合流中的预设布局信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | Region | [uid](#Region-uid) | | Region | [roomId](#Region-roomid) | | Region | [zorder](#Region-zorder) | | Region | [alpha](#Region-alpha) | | Region | [setCornerRadius](#Region-setcornerradius) | | Region | [contentControl](#Region-contentcontrol) | | Region | [renderMode](#Region-rendermode) | | Region | [position](#Region-position) | | Region | [size](#Region-size) | | boolean | [isScreenStream](#Region-isscreenstream) | | Region | [setScreenStream](#Region-setscreenstream) | | boolean | [isLocalUser](#Region-islocaluser) | | Region | [setLocalUser](#Region-setlocaluser) | | Region | [type](#Region-type) | | Region | [data](#Region-data) | | Region | [dataParam](#Region-dataparam) | | Region | [spatialPosition](#Region-spatialposition) | | Region | [applySpatialAudio](#Region-applyspatialaudio) | ## 函数说明 ### uid ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.uid(String uid) ``` 设置视频流发布用户的用户 ID。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 用户 ID。 | ### roomId ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.roomId(String roomId) ``` 设置视频流发布用户的房间 ID。必填。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomId | String | 房间 ID。 | ### zorder ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.zorder(int zorder) ``` 设置用户视频布局在画布中的层级。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | zorder | int | 用户视频布局在画布中的层级。取值范围为 [0 - 100]，0 为底层，值越大越上层。默认值为 0。 | ### alpha ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.alpha(double alpha) ``` （仅服务端合流支持设置）设置透明度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | alpha | double | 透明度，可选范围为 (0.0, 1.0]，0.0 为全透明。默认值为 1.0。 | ### setCornerRadius ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.setCornerRadius(double radius) ``` （仅服务端合流支持设置）设置圆角半径。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | radius | double | 圆角半径相对画布宽度的比例。默认值为 `0.0`。 | **注意** 做范围判定时，首先根据画布的宽高，将 `width`，`height`，和 `radius` 分别转换为像素值：`width_px`，`height_px`，和 `radius_px`。然后判定是否满足 `radius_px < min(width_px/2, height_px/2)`：若满足，则设置成功；若不满足，则将 `radius_px` 设定为 `min(width_px/2, height_px/2)`，然后将 `radius` 设定为 `radius_px` 相对画布宽度的比例值。 ### contentControl ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.contentControl(TranscoderContentControlType contentControl) ``` （仅服务端合流支持设置）设置合流内容类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | contentControl | TranscoderContentControlType | 合流内容控制。默认值为 `TranscoderContentControlType.HAS_AUDIO_AND_VIDEO`，参看 [TranscoderContentControlType](#TranscoderContentControlType)。 | ### renderMode ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.renderMode(TranscoderRenderMode renderMode) ``` 设置图片或视频流渲染的缩放模式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | renderMode | TranscoderRenderMode | 图片或视频流的缩放模式，参看 [TranscoderRenderMode](#TranscoderRenderMode)。默认值为 1。 | ### position ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.position( double x, double y ) ``` 设置用户视频布局的相对位置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | x | double | 视频流对应区域左上角的横坐标相对整体画面的归一化比例，取值的范围为 [0.0, 1.0)。默认值为 0.0。 | | y | double | 视频流对应区域左上角的纵坐标相对整体画面的归一化比例，取值的范围为 [0.0, 1.0)。默认值为 0.0。 | ### size ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.size( double width, double height ) ``` 设置用户视频相对大小。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | double | 视频流对应区域宽度相对整体画面的归一化比例，取值的范围为 [0.0, 1.0]。默认值为 1.0。 | | height | double | 视频流对应区域高度相对整体画面的归一化比例，取值的范围为 [0.0, 1.0]。默认值为 1.0。 | ### isScreenStream ```java boolean com.ss.bytertc.engine.live.LiveTranscoding.Region.isScreenStream() ``` 是否是屏幕流。 **返回值** - true：是屏幕流。 - false：不是屏幕流。 ### setScreenStream ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.setScreenStream(boolean screenStream) ``` （仅服务端合流支持合屏幕流）设置是否是屏幕流。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | screenStream | boolean | 标识是否是屏幕流 | ### isLocalUser ```java boolean com.ss.bytertc.engine.live.LiveTranscoding.Region.isLocalUser() ``` 是否本地用户。 **返回值** - true：是本地用户。 - false：不是本地用户。 ### setLocalUser ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.setLocalUser(boolean localUser) ``` 设置是否是本地用户。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | localUser | boolean | 标识是否是本地用户 | ### type ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.type(TranscoderLayoutRegionType type) ``` 设置合流布局区域类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | TranscoderLayoutRegionType | 合流布局区域类型，详见 [TranscoderLayoutRegionType](#TranscoderLayoutRegionType)。 | ### data ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.data(byte[] data) ``` 设置图片合流区域类型对应的数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | byte[] | 图片合流布局区域类型对应的数据。类型为图片时传入图片 RGBA 数据，当类型为视频流时传空。 | ### dataParam ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.dataParam(Region.DataParam dataParam) ``` 设置合流布局区域数据的对应参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | dataParam | Region.DataParam | 合流布局区域数据的对应参数。当类型为视频流时传空，类型为图片时传入对应图片的参数，参看 [DataParam](#Region-dataparam)。 | ### spatialPosition ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.spatialPosition( float x, float y, float z ) ``` 设置当前 region 空间音频位置 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | x | float | x 坐标 | | y | float | y 坐标 | | z | float | z 坐标 | ### applySpatialAudio ```java Region com.ss.bytertc.engine.live.LiveTranscoding.Region.applySpatialAudio(boolean applySpatialAudio) ``` 设置某用户是否应用空间音频效果。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | applySpatialAudio | boolean | 该用户是否应用空间音频效果：

true：启用（默认值）
false：禁用

| # UserOnlineStatus ```java public class com.ss.bytertc.engine.type.UserOnlineStatus ``` 用户在线状态 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [USER_ONLINE_STATUS_OFFLINE](#UserOnlineStatus-user_online_status_offline) | | int | [USER_ONLINE_STATUS_ONLINE](#UserOnlineStatus-user_online_status_online) | | int | [USER_ONLINE_STATUS_UNREACHABLE](#UserOnlineStatus-user_online_status_unreachable) | ## 变量说明 ### USER_ONLINE_STATUS_OFFLINE ```java public static final int com.ss.bytertc.engine.type.UserOnlineStatus.USER_ONLINE_STATUS_OFFLINE = 0 ``` 对端用户离线对端用户已经调用 `logout`，或者没有调用 `login` 进行登录 ### USER_ONLINE_STATUS_ONLINE ```java public static final int com.ss.bytertc.engine.type.UserOnlineStatus.USER_ONLINE_STATUS_ONLINE = 1 ``` 对端用户在线对端用户调用 `login` 登录，并且连接状态正常。 ### USER_ONLINE_STATUS_UNREACHABLE ```java public static final int com.ss.bytertc.engine.type.UserOnlineStatus.USER_ONLINE_STATUS_UNREACHABLE = 2 ``` 无法获取对端用户在线状态发生级联错误、对端用户在线状态异常时返回 # VideoDecoderConfig ```java public enum com.ss.bytertc.engine.video.VideoDecoderConfig ``` 视频解码方式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | VIDEO_DECODER_CONFIG_RAW | 0 | 开启 SDK 内部解码，只回调解码后的数据。回调为 [onFrame](#IVideoSink-onframe)。 | | VIDEO_DECODER_CONFIG_ENCODE | 1 | 开启自定义解码，只回调解码前数据。回调为 [onRemoteEncodedVideoFrame](70081#IRemoteEncodedVideoFrameObserver-onremoteencodedvideoframe)。 | | VIDEO_DECODER_CONFIG_BOTH | 2 | 开启 SDK 内部解码，同时回调解码前和解码后的数据 [。onFrame](#IVideoSink-onframe) 和 [onRemoteEncodedVideoFrame](70081#IRemoteEncodedVideoFrameObserver-onremoteencodedvideoframe)。 | # EncoderPreference ```java public enum com.ss.bytertc.engine.VideoStreamDescription.EncoderPreference ``` 编码策略偏好。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | Disabled | 0 | 无偏好。不降低帧率和分辨率。 | | MaintainFramerate | 1 | 帧率优先。 | | MaintainQuality | 2 | 分辨率优先。 | | Balance | 3 | 平衡帧率与分辨率。 | # PositionInfo ```java public class com.ss.bytertc.engine.data.PositionInfo ``` 用户在空间音频坐标系里的位置信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | Position | [position](#PositionInfo-position) | | HumanOrientation | [orientation](#PositionInfo-orientation) | ## 变量说明 ### position ```java public Position com.ss.bytertc.engine.data.PositionInfo.position ``` 用户在空间音频坐标系里的位置，需自行建立空间直角坐标系。参看 [Position](#Position)。 ### orientation ```java public HumanOrientation com.ss.bytertc.engine.data.PositionInfo.orientation ``` 用户在空间音频坐标系里的三维朝向信息。三个向量需要两两垂直。参看 [HumanOrientation](#HumanOrientation)。 # LocalStreamStats ```java public class com.ss.bytertc.engine.type.LocalStreamStats ``` 本地音/视频流统计信息，统计周期为 2s 。本地用户发布音/视频流成功后，SDK 会周期性地通过 `onLocalStreamStats` 通知本地用户发布的音/视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | LocalAudioStats | [audioStats](#LocalStreamStats-audiostats) | | LocalVideoStats | [videoStats](#LocalStreamStats-videostats) | | boolean | [isScreen](#LocalStreamStats-isscreen) | | int | [deprecated] [txQuality](#LocalStreamStats-txquality) | | int | [deprecated] [rxQuality](#LocalStreamStats-rxquality) | ## 变量说明 ### audioStats ```java public LocalAudioStats com.ss.bytertc.engine.type.LocalStreamStats.audioStats ``` 本地设备发送音频流的统计信息，详见 [LocalAudioStats](#LocalAudioStats)。 ### videoStats ```java public LocalVideoStats com.ss.bytertc.engine.type.LocalStreamStats.videoStats ``` 本地设备发送视频流的统计信息，详见 [LocalVideoStats](#LocalVideoStats)。 ### isScreen ```java public boolean com.ss.bytertc.engine.type.LocalStreamStats.isScreen ``` 所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。 ### txQuality ```java public int com.ss.bytertc.engine.type.LocalStreamStats.txQuality ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onNetworkQuality](70081#IRTCRoomEventHandler-onnetworkquality) instead. 本地媒体上行网络质量，详见 [NetworkQuality](#NetworkQuality)。 ### rxQuality ```java public int com.ss.bytertc.engine.type.LocalStreamStats.rxQuality ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onNetworkQuality](70081#IRTCRoomEventHandler-onnetworkquality) instead. 本地媒体下行网络质量，详见 [NetworkQuality](#NetworkQuality)。 # VoiceEqualizationConfig ```java public class com.ss.bytertc.engine.type.VoiceEqualizationConfig ``` 语音均衡效果。 ## 成员变量 | 类型 | 名称 | | --- | --- | | VoiceEqualizationBandFrequency | [frequency](#VoiceEqualizationConfig-frequency) | | int | [gain](#VoiceEqualizationConfig-gain) | ## 变量说明 ### frequency ```java public VoiceEqualizationBandFrequency com.ss.bytertc.engine.type.VoiceEqualizationConfig.frequency ``` 频带。参看 [VoiceEqualizationBandFrequency](#VoiceEqualizationBandFrequency)。 ### gain ```java public int com.ss.bytertc.engine.type.VoiceEqualizationConfig.gain ``` 频带增益（dB）。取值范围是 `[-15, 15]`。 # VideoFrameType ```java public enum com.ss.bytertc.engine.data.VideoFrameType ``` 视频帧的类型，用于标识视频帧是 CPUBuffer 还是 TextureBuffer ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | RAW_MEMORY | 0 | CPU Buffer | | GL_TEXTURE | 2 | GL Texture | # TranscoderContentControlType ```java public enum com.ss.bytertc.engine.live.LiveTranscoding.TranscoderContentControlType ``` 合流输出内容类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | HAS_AUDIO_AND_VIDEO | 0 | 输出的混流包含音频和视频 | | HAS_AUDIO_ONLY | 1 | 输出的混流只包含音频 | | HAS_VIDEO_ONLY | 2 | 输出的混流只包含视频 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [getValue](#TranscoderContentControlType-getvalue) | ## 函数说明 ### getValue ```java int com.ss.bytertc.engine.live.LiveTranscoding.TranscoderContentControlType.getValue() ``` 获取合流输出内容类型。 **返回值** 合流输出内容类型 # ChannelProfile ```java public enum com.ss.bytertc.engine.type.ChannelProfile ``` 房间模式根据所需场景，选择合适的房间模式，应用不同的音视频算法、视频参数和网络配置调用 `setAudioProfile` 改变音频参数配置 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | CHANNEL_PROFILE_COMMUNICATION | 0 | 普通音频通话，默认模式
与 `CHANNEL_PROFIEL_MEETING(16)` 配置相同。
你可以联系技术支持更换默认配置参数。 | | CHANNEL_PROFILE_GAME | 2 | 游戏语音模式，低功耗、低流量消耗。
低端机在此模式下运行时，进行了额外的性能优化：

部分低端机型配置编码帧长 40/60

部分低端机型关闭软件 3A 音频处理增强对 iOS 其他屏幕录制进行的兼容性，避免音频录制被 RTC 打断。

| | CHANNEL_PROFILE_CLOUD_GAME | 3 | 云游戏模式。
如果你的游戏场景需要低延迟的配置，使用此设置。
此设置下，弱网抗性较差。 | | CHANNEL_PROFILE_LOW_LATENCY | 4 | 云渲染模式。超低延时配置。
如果你的应用并非游戏但又对延时要求较高时，选用此模式
该模式下，音视频通话延时会明显降低，但同时弱网抗性、通话音质等均会受到一定影响。 | | CHANNEL_PROFILE_CHAT | 5 | 适用于 1 vs 1 音视频通话 | | CHANNEL_PROFILE_CHAT_ROOM | 6 | 适用于 3 人及以上纯语音通话。
通话中，闭麦时为是媒体模式，上麦后切换为通话模式。 | | CHANNEL_PROFILE_LW_TOGETHER | 7 | 实现多端同步播放音视频，适用于 “一起看” 或 “一起听” 场景。
该场景中，使用 RTC 信令同步播放进度，共享的音频内容不通过 RTC 进行传输。 | | CHANNEL_PROFILE_GAME_HD | 8 | 适用于对音质要求较高的游戏场景，优化音频 3A 策略，只通过媒体模式播放音频 | | CHANNEL_PROFILE_CO_HOST | 9 | 适用于直播中主播之间连麦的业务场景。
该场景中，直播时通过 CDN，发起连麦 PK 时使用 RTC。 | | CHANNEL_PROFILE_INTERACTIVE_PODCAST | 10 | 适用于单主播和观众进行音视频互动的直播。通话模式，上下麦不会有模式切换，避免音量突变现象 | | CHANNEL_PROFILE_KTV | 11 | 线上 KTV 场景，音乐音质，低延迟
使用 RTC 传输伴奏音乐，混音后的歌声，适合独唱或单通合唱 | | CHANNEL_PROFILE_CHORUS | 12 | 适合在线实时合唱场景，高音质，超低延迟。使用本配置前请联系技术支持进行协助完成其他配置。 | | CHANNEL_PROFIEL_VR_CHAT | 13 | 适用于 VR 场景。支持最高 192 KHz 音频采样率，可开启球形立体声。 | | CHANNEL_PROFILE_GAME_STREAMING | 14 | 适用于 1 vs 1 游戏串流，支持公网或局域网。 | | CHANNEL_PROFILE_LAN_LIVE_STREAMING | 15 | 适用于局域网的 1 对多视频直播，最高支持 8K， 60 帧/秒， 100 Mbps 码率
需要在局域网配置私有化部署媒体服务器。 | | CHANNEL_PROFIEL_MEETING | 16 | 适用于云端会议中的个人设备。 | | CHANNEL_PROFILE_MEETING_ROOM | 17 | 适用于云端会议中的会议室终端设备，例如 Rooms，投屏盒子等。 | | CHANNEL_PROFILE_CLASSROOM | 18 | 适用于课堂互动，房间内所有成员都可以进行音视频互动
当你的场景中需要同时互动的成员超过 10 人时使用此模式 | | [deprecated] CHANNEL_PROFILE_LIVE_BROADCASTING | 1 | `Deprecated since 3.42 and will be deleted in 3.51, use CHANNEL_PROFILE_INTERACTIVE_PODCAST instead.`
直播模式。
当你对音视频通话的音质和画质要求较高时，应使用此设置。
此设置下，当用户使用蓝牙耳机收听时，蓝牙耳机使用媒体模式。 | # MixedStreamLayoutConfig ```java public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig ``` 视频流合流整体布局信息。开启转推直播功能后，你可以设置参与合流的每路视频流的预设布局信息和合流背景信息等。 ## 成员函数 | 返回 | 名称 | | --- | --- | | MixedStreamLayoutConfig | [setBackgroundColor](#MixedStreamLayoutConfig-setbackgroundcolor) | | String | [getBackgroundColor](#MixedStreamLayoutConfig-getbackgroundcolor) | | MixedStreamLayoutConfig | [setBackgroundImageURL](#MixedStreamLayoutConfig-setbackgroundimageurl) | | String | [getBackgroundImageURL](#MixedStreamLayoutConfig-getbackgroundimageurl) | | MixedStreamLayoutConfig | [setRegions](#MixedStreamLayoutConfig-setregions) | | MixedStreamLayoutRegionConfig [] | [getRegions](#MixedStreamLayoutConfig-getregions) | | MixedStreamLayoutConfig | [setUserConfigExtraInfo](#MixedStreamLayoutConfig-setuserconfigextrainfo) | | String | [getUserConfigExtraInfo](#MixedStreamLayoutConfig-getuserconfigextrainfo) | ## 函数说明 ### setBackgroundColor ```java MixedStreamLayoutConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.setBackgroundColor(String backgroundColor) ``` 设置画布的背景颜色。值不合法或未设置时，自动使用默认值。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | backgroundColor | String | 合流背景颜色，用十六进制颜色码（HEX）表示。例如，#FFFFFF 表示纯白，#000000 表示纯黑。默认值为 #000000。 | ### getBackgroundColor ```java String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.getBackgroundColor() ``` 获取画布的背景颜色。 ### setBackgroundImageURL ```java MixedStreamLayoutConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.setBackgroundImageURL(String backgroundImageURL) ``` > Available since 3.57 设置合流后整体画布的背景图片 URL。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | backgroundImageURL | String | 背景图片 URL，长度最大为 1024 bytes。支持的图片格式包括：JPG, JPEG, PNG。如果背景图片的宽高和整体屏幕的宽高不一致，背景图片会缩放到铺满屏幕。 | ### getBackgroundImageURL ```java String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.getBackgroundImageURL() ``` > Available since 3.57 获取背景图片的地址。 ### setRegions ```java MixedStreamLayoutConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.setRegions(MixedStreamLayoutRegionConfig[] regions) ``` 设置用户布局信息列表。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | regions | MixedStreamLayoutRegionConfig[] | 用户布局信息列表。为 [MixedStreamLayoutRegionConfig](#MixedStreamConfig-MixedStreamLayoutRegionConfig) 数据类型的数组。每一个该类型对象为一路单独的视频流的布局信息。
值不合法或未设置时，自动使用默认值。 | ### getRegions ```java MixedStreamLayoutRegionConfig[] com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.getRegions() ``` 获取用户布局信息列表。 ### setUserConfigExtraInfo ```java MixedStreamLayoutConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.setUserConfigExtraInfo(String userConfigExtraInfo) ``` 设置透传的 App 数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | userConfigExtraInfo | String | 透传的 App 数据，长度不超过 4 KB。 | ### getUserConfigExtraInfo ```java String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.getUserConfigExtraInfo() ``` 获取透传的 App 数据。 # IAudioFrame ```java public interface com.ss.bytertc.engine.utils.IAudioFrame ``` 音频数据 ## 成员函数 | 返回 | 名称 | | --- | --- | | long | [timestamp_us](#IAudioFrame-timestamp_us) | | AudioSampleRate | [sample_rate](#IAudioFrame-sample_rate) | | AudioChannel | [channel](#IAudioFrame-channel) | | ByteBuffer | [getDataBuffer](#IAudioFrame-getdatabuffer) | | int | [data_size](#IAudioFrame-data_size) | | AudioFrameType | [frame_type](#IAudioFrame-frame_type) | | void | [release](#IAudioFrame-release) | ## 函数说明 ### timestamp_us ```java long com.ss.bytertc.engine.utils.IAudioFrame.timestamp_us() ``` 获取音频帧时间戳。 **返回值** 音频帧时间戳，单位：微秒。 ### sample_rate ```java AudioSampleRate com.ss.bytertc.engine.utils.IAudioFrame.sample_rate() ``` 获取音频采样率，参看 [AudioSampleRate](#AudioSampleRate)。 **返回值** 音频采样率 ### channel ```java AudioChannel com.ss.bytertc.engine.utils.IAudioFrame.channel() ``` 获取音频声道，参看 [AudioChannel](#AudioChannel)。 **返回值** 音频声道 **注意** 双声道的情况下，左右声道的音频帧数据以 LRLRLR 形式排布。 ### getDataBuffer ```java ByteBuffer com.ss.bytertc.engine.utils.IAudioFrame.getDataBuffer() ``` 获取音频帧内存块地址 **返回值** 音频帧的 ByteBuffer ### data_size ```java int com.ss.bytertc.engine.utils.IAudioFrame.data_size() ``` 获取音频帧数据大小。 **返回值** 音频帧数据大小，单位：字节。 ### frame_type ```java AudioFrameType com.ss.bytertc.engine.utils.IAudioFrame.frame_type() ``` 获取音频帧类型，目前只支持 PCM，参看 [AudioFrameType](#AudioFrameType)。 **返回值** 音频帧类型 ### release ```java void com.ss.bytertc.engine.utils.IAudioFrame.release() ``` 释放音频帧。 # ForwardStreamStateInfo ```java public class com.ss.bytertc.engine.data.ForwardStreamStateInfo ``` 跨房间转发媒体流过程中的不同目标房间的状态和错误信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [roomId](#ForwardStreamStateInfo-roomid) | | ForwardStreamState | [state](#ForwardStreamStateInfo-state) | | ForwardStreamError | [error](#ForwardStreamStateInfo-error) | ## 变量说明 ### roomId ```java public String com.ss.bytertc.engine.data.ForwardStreamStateInfo.roomId ``` 跨房间转发媒体流过程中目标房间 ID 空字符串代表所有目标房间 ### state ```java public ForwardStreamState com.ss.bytertc.engine.data.ForwardStreamStateInfo.state ``` 跨房间转发媒体流过程中该目标房间的状态，参看 [ForwardStreamState](#ForwardStreamState) ### error ```java public ForwardStreamError com.ss.bytertc.engine.data.ForwardStreamStateInfo.error ``` 跨房间转发媒体流过程中该目标房间抛出的错误码，参看 [ForwardStreamError](#ForwardStreamError) # RemoteVideoConfig ```java public class com.ss.bytertc.engine.data.RemoteVideoConfig ``` 远端视频帧信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#RemoteVideoConfig-width) | | int | [height](#RemoteVideoConfig-height) | | int | [framerate](#RemoteVideoConfig-framerate) | ## 成员函数 | 返回 | 名称 | | --- | --- | | RemoteVideoConfig | [RemoteVideoConfig](#RemoteVideoConfig-remotevideoconfig) | ## 变量说明 ### width ```java public int com.ss.bytertc.engine.data.RemoteVideoConfig.width = 0 ``` 视频宽度，单位：px ### height ```java public int com.ss.bytertc.engine.data.RemoteVideoConfig.height = 0 ``` 视频高度，单位：px ### framerate ```java public int com.ss.bytertc.engine.data.RemoteVideoConfig.framerate = 0 ``` 期望订阅的最高帧率，单位：fps，默认值为 0 即满帧订阅，设为大于 0 的值时开始生效。如果发布端发布帧率 > 订阅端订阅的帧率，下行媒体服务器 SVC 丢帧，订阅端收到通过此接口设置的帧率；如果发布端发布帧率 < 订阅端订阅的帧率，则订阅端只能收到发布的帧率仅码流支持 SVC 分级编码特性时方可生效。 ## 函数说明 ### RemoteVideoConfig ```java com.ss.bytertc.engine.data.RemoteVideoConfig.RemoteVideoConfig( int width, int height, int framerate ) ``` 远端视频参数设置 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | int | 视频宽度，单位：px | | height | int | 视频高度，单位：px | | framerate | int | 期望订阅的最高帧率，单位：fps，默认值为 0 即满帧订阅，设为大于 0 的值时开始生效。
如果发布端发布帧率 > 订阅端订阅的帧率，下行媒体服务器 SVC 丢帧，订阅端收到通过此接口设置的帧率；如果发布端发布帧率 < 订阅端订阅的帧率，则订阅端只能收到发布的帧率
仅码流支持 SVC 分级编码特性时方可生效。 | # PauseResumeControlMediaType ```java public enum com.ss.bytertc.engine.type.PauseResumeControlMediaType ``` 暂停/恢复接收远端的媒体流类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO | 0 | 只控制音频，不影响视频 | | VIDEO | 1 | 只控制视频，不影响音频 | | AUDIO_AND_VIDEO | 2 | 同时控制音频和视频 | # RTCEncodedVideoFrame ```java public class com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame ``` 视频帧信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteBuffer | [buffer](#RTCEncodedVideoFrame-buffer) | | long | [timestampUs](#RTCEncodedVideoFrame-timestampus) | | long | [timestampDtsUs](#RTCEncodedVideoFrame-timestampdtsus) | | int | [width](#RTCEncodedVideoFrame-width) | | int | [height](#RTCEncodedVideoFrame-height) | | VideoCodecType | [videoCodecType](#RTCEncodedVideoFrame-videocodectype) | | VideoPictureType | [videoPictureType](#RTCEncodedVideoFrame-videopicturetype) | | VideoRotation | [videoRotation](#RTCEncodedVideoFrame-videorotation) | ## 变量说明 ### buffer ```java public final ByteBuffer com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.buffer ``` 视频帧数据指针地址 buffer 为 Direct 类型且 size 需和 capacity 相等 ### timestampUs ```java public long com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.timestampUs ``` 视频采集时间戳，单位：微秒 ### timestampDtsUs ```java public long com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.timestampDtsUs ``` 视频编码时间戳，单位：微秒 ### width ```java public int com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.width ``` 视频分辨率的宽度，单位：px ### height ```java public int com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.height ``` 视频分辨率的高度，单位：px ### videoCodecType ```java public VideoCodecType com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.videoCodecType ``` 视频编码类型。参看 [VideoCodecType](#VideoCodecType) ### videoPictureType ```java public VideoPictureType com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.videoPictureType ``` 视频帧类型。参看 [VideoPictureType](#VideoPictureType) ### videoRotation ```java public VideoRotation com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.videoRotation ``` 视频帧旋转角度，默认旋转 0 度。参看 [VideoRotation](#VideoRotation) # AudioMixingState ```java public enum com.ss.bytertc.engine.data.AudioMixingState ``` 音频混音文件播放状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_MIXING_STATE_PRELOADED | 0 | 混音已加载 | | AUDIO_MIXING_STATE_PLAYING | 1 | 混音正在播放 | | AUDIO_MIXING_STATE_PAUSED | 2 | 混音暂停 | | AUDIO_MIXING_STATE_STOPPED | 3 | 混音停止 | | AUDIO_MIXING_STATE_FAILED | 4 | 混音播放失败 | | AUDIO_MIXING_STATE_FINISHED | 5 | 混音播放结束 | | AUDIO_MIXING_STATE_PCM_ENABLED | 6 | 准备 PCM 混音 | | AUDIO_MIXING_STATE_PCM_DISABLED | 7 | PCM 混音播放结束 | # DownloadLyricType ```java public enum com.ss.bytertc.ktv.data.DownloadLyricType ``` 歌词文件类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | KRC | 0 | KRC 歌词文件。 | | LRC | 1 | LRC 歌词文件。 | # MixedStreamType ```java public enum com.ss.bytertc.engine.live.MixedStreamType ``` 合流类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MIXED_STREAM_TYPE_BY_SERVER | 0 | 服务端合流。 | | MIXED_STREAM_TYPE_BY_CLIENT | 1 | 保留字段，无意义 | # RemoteAudioStats ```java public class com.ss.bytertc.engine.type.RemoteAudioStats ``` 远端音频流统计信息，统计周期为 2s。本地用户订阅远端音频流成功后，SDK 会周期性地通过 `onRemoteStreamStats` 通知本地用户订阅的音频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [audioLossRate](#RemoteAudioStats-audiolossrate) | | float | [receivedKBitrate](#RemoteAudioStats-receivedkbitrate) | | int | [stallCount](#RemoteAudioStats-stallcount) | | int | [stallDuration](#RemoteAudioStats-stallduration) | | long | [e2eDelay](#RemoteAudioStats-e2edelay) | | int | [playoutSampleRate](#RemoteAudioStats-playoutsamplerate) | | int | [statsInterval](#RemoteAudioStats-statsinterval) | | int | [rtt](#RemoteAudioStats-rtt) | | int | [totalRtt](#RemoteAudioStats-totalrtt) | | int | [quality](#RemoteAudioStats-quality) | | int | [jitterBufferDelay](#RemoteAudioStats-jitterbufferdelay) | | int | [numChannels](#RemoteAudioStats-numchannels) | | int | [receivedSampleRate](#RemoteAudioStats-receivedsamplerate) | | int | [frozenRate](#RemoteAudioStats-frozenrate) | | int | [concealedSamples](#RemoteAudioStats-concealedsamples) | | int | [concealmentEvent](#RemoteAudioStats-concealmentevent) | | int | [decSampleRate](#RemoteAudioStats-decsamplerate) | | int | [decDuration](#RemoteAudioStats-decduration) | | int | [jitter](#RemoteAudioStats-jitter) | ## 变量说明 ### audioLossRate ```java public float com.ss.bytertc.engine.type.RemoteAudioStats.audioLossRate ``` 音频丢包率。统计周期内的音频下行丢包率，取值范围为 [0, 1] 。 ### receivedKBitrate ```java public float com.ss.bytertc.engine.type.RemoteAudioStats.receivedKBitrate ``` 接收码率。统计周期内的音频接收码率，单位为 kbps 。 ### stallCount ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.stallCount ``` 音频卡顿次数。统计周期内的卡顿次数。 ### stallDuration ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.stallDuration ``` 音频卡顿时长。统计周期内的卡顿时长，单位为 ms 。 ### e2eDelay ```java public long com.ss.bytertc.engine.type.RemoteAudioStats.e2eDelay ``` 用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为 ms 。 ### playoutSampleRate ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.playoutSampleRate ``` 播放采样率。统计周期内的音频播放采样率信息，单位为 Hz 。 ### statsInterval ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.statsInterval ``` 统计间隔。此次统计周期的间隔，单位为 ms 。 ### rtt ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.rtt ``` 客户端到服务端数据传输的往返时延，单位为 ms 。 ### totalRtt ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.totalRtt ``` 发送端——服务端——接收端全链路数据传输往返时延。单位为 ms 。 ### quality ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.quality ``` 远端用户发送的音频流质量。值含义参考 [NetworkQuality](#NetworkQuality)。 ### jitterBufferDelay ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.jitterBufferDelay ``` 因引入 jitter buffer 机制导致的延时。单位为 ms 。 ### numChannels ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.numChannels ``` 音频声道数。 ### receivedSampleRate ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.receivedSampleRate ``` 音频接收采样率。统计周期内接收到的远端音频采样率信息，单位为 Hz 。 ### frozenRate ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.frozenRate ``` 远端用户在加入房间后发生音频卡顿的累计时长占音频总有效时长的百分比。音频有效时长是指远端用户进房发布音频流后，除停止发送音频流和禁用音频模块之外的音频时长。 ### concealedSamples ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.concealedSamples ``` 音频丢包补偿(PLC) 样点总个数。 ### concealmentEvent ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.concealmentEvent ``` 音频丢包补偿(PLC) 累计次数。 ### decSampleRate ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.decSampleRate ``` 音频解码采样率。统计周期内的音频解码采样率信息，单位为 Hz 。 ### decDuration ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.decDuration ``` 此次订阅中，对远端音频流进行解码的累计耗时。单位为 s。 ### jitter ```java public int com.ss.bytertc.engine.type.RemoteAudioStats.jitter ``` 音频下行网络抖动，单位为 ms 。 # ScreenSharingParameters ```java public class com.ss.bytertc.engine.video.ScreenSharingParameters ``` 屏幕共享的编码参数配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [maxWidth](#ScreenSharingParameters-maxwidth) | | int | [maxHeight](#ScreenSharingParameters-maxheight) | | int | [frameRate](#ScreenSharingParameters-framerate) | | int | [bitrate](#ScreenSharingParameters-bitrate) | | int | [minBitrate](#ScreenSharingParameters-minbitrate) | ## 变量说明 ### maxWidth ```java public int com.ss.bytertc.engine.video.ScreenSharingParameters.maxWidth = 0 ``` 屏幕采集编码最大宽度, ### maxHeight ```java public int com.ss.bytertc.engine.video.ScreenSharingParameters.maxHeight = 0 ``` 屏幕采集编码最大高度 ### frameRate ```java public int com.ss.bytertc.engine.video.ScreenSharingParameters.frameRate = 15 ``` 屏幕采集编码帧率, 单位 fps ### bitrate ```java public int com.ss.bytertc.engine.video.ScreenSharingParameters.bitrate = -1 ``` 屏幕采集编码码率, `-1` 为自动码率, SDK 会根据宽高信息选择合适的码率，单位 kbps ### minBitrate ```java public int com.ss.bytertc.engine.video.ScreenSharingParameters.minBitrate = 0 ``` 视频最小编码码率, 单位 kbps。编码码率不会低于 `minBitrate`。默认值为 `0`。范围：[0, bitrate)，当 `bitrate` < `minBitrate` 时，为适配码率模式。以下情况，设置本参数无效： - 当 `bitrate` 为 `0` 时，不对视频流进行编码发送。 - 当 `bitrate` < `0` 时，适配码率模式。 # VideoOrientation ```java public enum com.ss.bytertc.engine.data.VideoOrientation ``` 视频帧朝向 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ADAPTIVE | 0 | （默认）使用相机输出的原始视频帧的角度，不对视频帧进行额外旋转。 | | PORTRAIT | 1 | 固定为竖屏，将相机采集到的视频帧转换为竖屏，在整个 RTC 链路中传递竖屏帧。 | | LANDSCAPE | 2 | 固定为横屏，将相机采集到的视频帧转换为横屏，在整个 RTC 链路中传递横屏帧。 | # AudioRecordingConfig ```java public class com.ss.bytertc.engine.data.AudioRecordingConfig ``` 音频录制配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [absoluteFileName](#AudioRecordingConfig-absolutefilename) | | AudioSampleRate | [sampleRate](#AudioRecordingConfig-samplerate) | | AudioChannel | [channel](#AudioRecordingConfig-channel) | | AudioFrameSource | [frameSource](#AudioRecordingConfig-framesource) | | AudioQuality | [quality](#AudioRecordingConfig-quality) | ## 变量说明 ### absoluteFileName ```java public String com.ss.bytertc.engine.data.AudioRecordingConfig.absoluteFileName ``` 录制文件路径。一个有读写权限的绝对路径，包含文件名和文件后缀。录制文件的格式仅支持 .aac 和 .wav。 ### sampleRate ```java public AudioSampleRate com.ss.bytertc.engine.data.AudioRecordingConfig.sampleRate ``` 录音采样率。参看 [AudioSampleRate](#AudioSampleRate)。 ### channel ```java public AudioChannel com.ss.bytertc.engine.data.AudioRecordingConfig.channel ``` 录音音频声道。参看 [AudioChannel](#AudioChannel)。如果录制时设置的的音频声道数与采集时的音频声道数不同： - 如果采集的声道数为 1，录制的声道数为 2，那么，录制的音频为经过单声道数据拷贝后的双声道数据，而不是立体声。 - 如果采集的声道数为 2，录制的声道数为 1，那么，录制的音频为经过双声道数据混合后的单声道数据。 ### frameSource ```java public AudioFrameSource com.ss.bytertc.engine.data.AudioRecordingConfig.frameSource ``` 录音内容来源，参看 [AudioFrameSource](#AudioFrameSource)。默认为 AUDIO_FRAME_SOURCE_MIXED(2)。 ### quality ```java public AudioQuality com.ss.bytertc.engine.data.AudioRecordingConfig.quality ``` 录音音质。仅在录制文件格式为 .aac 时可以设置。参看 [AudioQuality](#AudioQuality)。采样率为 32kHz 时，不同音质录制文件（时长为 10min）的大小分别是： - 低音质：1.2MB； - 【默认】中音质：2MB； - 高音质：3.75MB； - 超高音质：7.5MB。 # AudioRoute ```java public enum com.ss.bytertc.engine.data.AudioRoute ``` 音频播放路由 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_ROUTE_DEFAULT | -1 | 默认设备。通过 `setDefaultAudioRoute` 设置的音频路由。 | | AUDIO_ROUTE_HEADSET | 1 | 有线耳机 | | AUDIO_ROUTE_EARPIECE | 2 | 听筒。设备自带的，一般用于通话的播放硬件。 | | AUDIO_ROUTE_SPEAKERPHONE | 3 | 扬声器。设备自带的，一般用于免提播放的硬件。 | | AUDIO_ROUTE_HEADSET_BLUETOOTH | 4 | 蓝牙耳机 | | AUDIO_ROUTE_HEADSET_USB | 5 | USB 设备 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [value](#AudioRoute-value) | ## 函数说明 ### value ```java int com.ss.bytertc.engine.data.AudioRoute.value() ``` 获取当前值 **返回值** 当前值 # Position ```java public class com.ss.bytertc.engine.data.Position ``` 本地用户在房间内的位置坐标，需自行建立空间直角坐标系 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [x](#Position-x) | | float | [y](#Position-y) | | float | [z](#Position-z) | ## 变量说明 ### x ```java public float com.ss.bytertc.engine.data.Position.x ``` x 坐标 ### y ```java public float com.ss.bytertc.engine.data.Position.y ``` y 坐标 ### z ```java public float com.ss.bytertc.engine.data.Position.z ``` z 坐标 # MediaInputType ```java public enum com.ss.bytertc.engine.data.MediaInputType ``` 视频输入类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MEDIA_INPUT_TYPE_EXTERNAL | 0 | 自定义采集。
设置完成后方可直接向 SDK 推送视频帧。 | | MEDIA_INPUT_TYPE_INTERNAL | 1 | 内部 SDK 采集。
此设置仅切换至内部采集，你需继续调用 [startVideoCapture](70080#RTCVideo-startvideocapture) 开启内部采集。 | # EncoderPreference ```java public enum com.ss.bytertc.engine.ScreenVideoEncoderConfig.EncoderPreference ``` 屏幕流编码模式。默认采用流畅模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MaintainFramerate | 1 | 流畅模式，优先保障帧率。适用于共享游戏、视频等动态画面。 | | MaintainQuality | 2 | 清晰模式，优先保障分辨率。适用于共享 PPT、文档、图片等静态画面。 | # AudioPlayType ```java public enum com.ss.bytertc.ktv.data.AudioPlayType ``` 音乐播放类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | LOCAL | 0 | 仅本地播放。 | | REMOTE | 1 | 仅远端播放。 | | LOCAL_AND_REMOTE | 2 | 本地、远端同时播放。 | # DownloadFileType ```java public enum com.ss.bytertc.ktv.data.DownloadFileType ``` 下载文件类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MUSIC | 1 | 音频文件。 | | KRC | 2 | KRC 歌词文件。 | | LRC | 3 | LRC 歌词文件。 | | MIDI | 4 | MIDI 文件。 | # MediaPlayerCustomSourceSeekWhence ```java public enum com.ss.bytertc.engine.data.MediaPlayerCustomSourceSeekWhence ``` 音频数据的起始读取位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | SET | 0 | 从音频数据的头开始读取，读取的实际偏移量为参数 offset 的值。 | | CUR | 1 | 从音频数据的某一位置开始读取，读取的实际偏移量为音频数据当前的读取位置位置加上参数 offset 的值。 | | END | 2 | 从音频数据的尾开始读取，读取的实际数据偏移量为用户传入的音频数据大小加上参数 offset 的值。 | | SIZE | 3 | 返回音频数据的大小。 | # AudioCodecType ```java public enum com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.AudioCodecType ``` 音频编码格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_CODEC_TYPE_AAC | AAC | AAC 格式。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | String | [getValue](#AudioCodecType-getvalue) | ## 函数说明 ### getValue ```java String com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.AudioCodecType.getValue() ``` 获取音频编码格式。 **返回值** 音频编码格式。 # SingScoringConfig ```java public class com.ss.bytertc.engine.data.SingScoringConfig ``` K 歌评分配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | AudioSampleRate | [sampleRate](#SingScoringConfig-samplerate) | | MulDimSingScoringMode | [mode](#SingScoringConfig-mode) | | String | [lyricsFilepath](#SingScoringConfig-lyricsfilepath) | | String | [midiFilepath](#SingScoringConfig-midifilepath) | ## 变量说明 ### sampleRate ```java public AudioSampleRate com.ss.bytertc.engine.data.SingScoringConfig.sampleRate ``` 音频采样率。仅支持 44100 Hz、48000 Hz。 ### mode ```java public MulDimSingScoringMode com.ss.bytertc.engine.data.SingScoringConfig.mode ``` 打分维度，详见 [MulDimSingScoringMode](#MulDimSingScoringMode)。 ### lyricsFilepath ```java public String com.ss.bytertc.engine.data.SingScoringConfig.lyricsFilepath ``` 歌词文件路径。打分功能仅支持 KRC 歌词文件。 ### midiFilepath ```java public String com.ss.bytertc.engine.data.SingScoringConfig.midiFilepath ``` 歌曲 midi 文件路径。 # LyricStatus ```java public enum com.ss.bytertc.ktv.data.LyricStatus ``` 歌词格式类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | NONE | 0 | 无歌词。 | | KRC | 1 | KRC 歌词。 | | LRC | 2 | LRC 歌词。 | | KRC_AND_LRC | 4 | KRC 歌词和 LRC 歌词均有。 | # AudioQuality ```java public enum com.ss.bytertc.engine.data.AudioQuality ``` 音频质量。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_QUALITY_LOW | 0 | 低音质 | | AUDIO_QUALITY_MEDIUM | 1 | 中音质 | | AUDIO_QUALITY_HIGH | 2 | 高音质 | | AUDIO_QUALITY_ULTRA_HIGH | 3 | 超高音质 | # MixedStreamLayoutRegionType ```java public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionType ``` 合流布局区域类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MIXED_STREAM_LAYOUT_REGION_TYPE_VIDEO_STREAM | 0 | 合流布局区域类型为视频。 | | MIXED_STREAM_LAYOUT_REGION_TYPE_IMAGE | 1 | 合流布局区域类型为图片。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [getValue](#MixedStreamLayoutRegionType-getvalue) | ## 函数说明 ### getValue ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionType.getValue() ``` 获取合流布局区域类型。 **返回值** 合流布局区域类型。 # AudioFrameCallbackMethod ```java public enum com.ss.bytertc.engine.data.AudioFrameCallbackMethod ``` 音频回调方法 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_FRAME_CALLBACK_RECORD | 0 | 本地麦克风录制的音频数据回调 | | AUDIO_FRAME_CALLBACK_PLAYBACK | 1 | 订阅的远端所有用户混音后的音频数据回调 | | AUDIO_FRAME_CALLBACK_MIXED | 2 | 本地麦克风录制和订阅的远端所有用户混音后的音频数据回调 | | AUDIO_FRAME_CALLBACK_REMOTE_USER | 3 | 订阅的远端每个用户混音前的音频数据回调 | # RtcUser ```java public class com.ss.bytertc.engine.type.RtcUser ``` 用户信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [userId](#RtcUser-userid) | | String | [metaData](#RtcUser-metadata) | ## 变量说明 ### userId ```java public String com.ss.bytertc.engine.type.RtcUser.userId ``` 用户 id ### metaData ```java public String com.ss.bytertc.engine.type.RtcUser.metaData ``` 元数据 # LogoutReason ```java public class com.ss.bytertc.engine.type.LogoutReason ``` 用户登出的原因 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [LOGOUT_REASON_LOGOUT](#LogoutReason-logout_reason_logout) | | int | [LOGOUT_REASON_DUPLICATE_LOGIN](#LogoutReason-logout_reason_duplicate_login) | ## 变量说明 ### LOGOUT_REASON_LOGOUT ```java public static final int com.ss.bytertc.engine.type.LogoutReason.LOGOUT_REASON_LOGOUT = 0 ``` 用户主动退出用户调用 `logout` 接口登出，或者销毁引擎登出。 ### LOGOUT_REASON_DUPLICATE_LOGIN ```java public static final int com.ss.bytertc.engine.type.LogoutReason.LOGOUT_REASON_DUPLICATE_LOGIN = 1 ``` 用户被动退出另一个用户以相同 UserId 进行了 `login`，导致本端用户被踢出。 # VideoRenderMirrorType ```java public enum com.ss.bytertc.engine.video.VideoRenderMirrorType ``` 是否将视频帧镜像。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ON | 1 | 开启镜像。 | | OFF | 2 | （默认值）不开启镜像。 | # SourceCrop ```java static class com.ss.bytertc.engine.publicstream.PublicStreaming.SourceCrop ``` 公共流布局中的视频裁剪参数。 ## 成员函数 | 返回 | 名称 | | --- | --- | | SourceCrop | [setLocationX](#SourceCrop-setlocationx) | | SourceCrop | [setLocationY](#SourceCrop-setlocationy) | | SourceCrop | [setWidthProportion](#SourceCrop-setwidthproportion) | | SourceCrop | [setHeightProportion](#SourceCrop-setheightproportion) | ## 函数说明 ### setLocationX ```java SourceCrop com.ss.bytertc.engine.publicstream.PublicStreaming.SourceCrop.setLocationX(double x) ``` 设置左上角横坐标。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | x | double | 裁剪后得到的视频帧左上角横坐标相对于裁剪前整体画面的归一化比例，取值范围[0.0, 1.0)。 | **返回值** 裁剪配置。详见 [SourceCrop](#PublicStreaming-SourceCrop) 数据类型。 ### setLocationY ```java SourceCrop com.ss.bytertc.engine.publicstream.PublicStreaming.SourceCrop.setLocationY(double y) ``` 设置左上角纵坐标。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | y | double | 裁剪后得到的视频帧左上角纵坐标相对于裁剪前整体画面的归一化比例，取值范围[0.0, 1.0)。 | **返回值** 裁剪配置。详见 [SourceCrop](#PublicStreaming-SourceCrop) 数据类型。 ### setWidthProportion ```java SourceCrop com.ss.bytertc.engine.publicstream.PublicStreaming.SourceCrop.setWidthProportion(double w) ``` 设置视频宽度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | w | double | 裁剪后得到的视频帧宽度相对于裁剪前整体画面的归一化比例，取值范围(0.0, 1.0] | **返回值** 裁剪配置。详见 [SourceCrop](#PublicStreaming-SourceCrop) 数据类型。 ### setHeightProportion ```java SourceCrop com.ss.bytertc.engine.publicstream.PublicStreaming.SourceCrop.setHeightProportion(double h) ``` 设置视频高度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | h | double | 裁剪后得到的视频帧高度相对于裁剪前整体画面的归一化比例，取值范围(0.0, 1.0]。 | **返回值** 裁剪配置。详见 [SourceCrop](#PublicStreaming-SourceCrop) 数据类型。 # LiveTranscoding ```java public class com.ss.bytertc.engine.live.LiveTranscoding ``` 转推直播配置参数。(新) ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [ACTION_START](#LiveTranscoding-action_start) | | String | [ACTION_CHANGED](#LiveTranscoding-action_changed) | | String | [ACTION_STOPPED](#LiveTranscoding-action_stopped) | ## 静态函数 | 返回 | 名称 | | --- | --- | | static LiveTranscoding | [getDefualtLiveTranscode](#LiveTranscoding-getdefualtlivetranscode) | ## 成员函数 | 返回 | 名称 | | --- | --- | | boolean | [getFieldVideoConfigBFrame](#LiveTranscoding-getfieldvideoconfigbframe) | | void | [setUrl](#LiveTranscoding-seturl) | | void | [setRoomId](#LiveTranscoding-setroomid) | | void | [setUserId](#LiveTranscoding-setuserid) | | void | [setVideo](#LiveTranscoding-setvideo) | | void | [setAudio](#LiveTranscoding-setaudio) | | void | [setSpatialConfig](#LiveTranscoding-setspatialconfig) | | void | [setClientMixParam](#LiveTranscoding-setclientmixparam) | | void | [setLayout](#LiveTranscoding-setlayout) | | ByteRTCStreamMixingType | [getMixType](#LiveTranscoding-getmixtype) | | void | [setMixType](#LiveTranscoding-setmixtype) | | String | [getUrl](#LiveTranscoding-geturl) | | VideoConfig | [getVideo](#LiveTranscoding-getvideo) | | AudioConfig | [getAudio](#LiveTranscoding-getaudio) | | SpatialConfig | [getSpatialConfig](#LiveTranscoding-getspatialconfig) | | ClientMixParam | [getClientMixParam](#LiveTranscoding-getclientmixparam) | | Layout | [getLayout](#LiveTranscoding-getlayout) | | void | [deprecated] [setAction](#LiveTranscoding-setaction) | ## 变量说明 ### ACTION_START ```java public static final String com.ss.bytertc.engine.live.LiveTranscoding.ACTION_START = "started" ``` 开启转推直播。 ### ACTION_CHANGED ```java public static final String com.ss.bytertc.engine.live.LiveTranscoding.ACTION_CHANGED = "layoutChanged" ``` 更新合流视频布局。 ### ACTION_STOPPED ```java public static final String com.ss.bytertc.engine.live.LiveTranscoding.ACTION_STOPPED = "stopped" ``` 停止直播推流功能。 ## 函数说明 ### getDefualtLiveTranscode ```java static LiveTranscoding com.ss.bytertc.engine.live.LiveTranscoding.getDefualtLiveTranscode() ``` 获取默认的转推直播配置参数。 **返回值** 默认的转推直播配置参数。参看 [LiveTranscoding](#LiveTranscoding)。 ### getFieldVideoConfigBFrame ```java boolean com.ss.bytertc.engine.live.LiveTranscoding.getFieldVideoConfigBFrame() ``` ### setUrl ```java void com.ss.bytertc.engine.live.LiveTranscoding.setUrl(String url) ``` 设置推流 CDN 地址。仅支持 RTMP 协议，Url 必须满足正则 `/^rtmps?:\/\//`。本参数不支持过程中更新。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | String | 推流地址 | ### setRoomId ```java void com.ss.bytertc.engine.live.LiveTranscoding.setRoomId(String roomId) ``` 设置推流房间 ID。`roomId` 和 `userId` 长度相加不得超过 126 字节。本参数不支持过程中更新。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomId | String | 推流房间 ID。 | ### setUserId ```java void com.ss.bytertc.engine.live.LiveTranscoding.setUserId(String userId) ``` 设置推流用户 ID。`roomId` 和 `userId` 长度相加不得超过 126 字节。本参数不支持过程中更新。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | userId | String | 推流用户 ID。 | ### setVideo ```java void com.ss.bytertc.engine.live.LiveTranscoding.setVideo(VideoConfig video) ``` 设置视频转码配置参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | video | VideoConfig | 视频转码配置参数。详见 [VideoConfig](#PublicStreaming-VideoConfig) 数据类型。 | ### setAudio ```java void com.ss.bytertc.engine.live.LiveTranscoding.setAudio(AudioConfig audio) ``` 设置音频转码配置参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audio | AudioConfig | 音频转码配置参数，参看 [AudioConfig](#LiveTranscoding-AudioConfig)。 | ### setSpatialConfig ```java void com.ss.bytertc.engine.live.LiveTranscoding.setSpatialConfig(SpatialConfig spatialConfig) ``` 设置推流 CDN 的空间音频参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | spatialConfig | SpatialConfig | 空间音频参数。详见 [SpatialConfig](#LiveTranscoding-SpatialConfig) 数据类型。 | ### setClientMixParam ```java void com.ss.bytertc.engine.live.LiveTranscoding.setClientMixParam(ClientMixParam param) ``` 设置客户端合流配置参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | param | ClientMixParam | 客户端合流配置参数。详见 [ClientMixParam](#LiveTranscoding-ClientMixParam) 数据类型。 | ### setLayout ```java void com.ss.bytertc.engine.live.LiveTranscoding.setLayout(Layout layout) ``` 设置视频流合流整体布局信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | layout | Layout | 视频流合流整体布局参数，参看 [Layout](#Layout)。 | ### getMixType ```java ByteRTCStreamMixingType com.ss.bytertc.engine.live.LiveTranscoding.getMixType() ``` 获取合流类型。 **返回值** 合流类型，参看 [ByteRTCStreamMixingType](#ByteRTCStreamMixingType)。 ### setMixType ```java void com.ss.bytertc.engine.live.LiveTranscoding.setMixType(ByteRTCStreamMixingType mixType) ``` 设置合流类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mixType | ByteRTCStreamMixingType | 合流类型，参看 [ByteRTCStreamMixingType](#ByteRTCStreamMixingType)。 | **注意** 本参数不支持过程中更新。 ### getUrl ```java String com.ss.bytertc.engine.live.LiveTranscoding.getUrl() ``` 获取推流的 CDN 地址。 **返回值** CDN 的 URL 地址。 ### getVideo ```java VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.getVideo() ``` 获取视频转码配置参数。 **返回值** 当前视频转码配置参数。详见 [VideoConfig](#LiveTranscoding-VideoConfig) 数据类型。 ### getAudio ```java AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.getAudio() ``` 获取音频转码配置参数。 **返回值** 当前音频转码配置参数，参看 [AudioConfig](#LiveTranscoding-AudioConfig)。 ### getSpatialConfig ```java SpatialConfig com.ss.bytertc.engine.live.LiveTranscoding.getSpatialConfig() ``` 获取空间音频配置参数。 **返回值** 当前空间音频配置参数。详见 [SpatialConfig](#LiveTranscoding-SpatialConfig) 数据类型。 ### getClientMixParam ```java ClientMixParam com.ss.bytertc.engine.live.LiveTranscoding.getClientMixParam() ``` 获取客户端合流配置参数。 **返回值** 当前客户端合流配置参数。详见 [ClientMixParam](#LiveTranscoding-ClientMixParam) 数据类型。 ### getLayout ```java Layout com.ss.bytertc.engine.live.LiveTranscoding.getLayout() ``` 获取视频流合流整体布局信息。 **返回值** 当前视频流合流整体布局，参看 [Layout](#Layout)。 ### setAction ```java void com.ss.bytertc.engine.live.LiveTranscoding.setAction(String action) ``` > Deprecated since 3.50 and will be deleted in 3.55, use [startLiveTranscoding](70080#RTCVideo-startlivetranscoding), [updateLiveTranscoding](70080#RTCVideo-updatelivetranscoding), [stopLiveTranscoding](70080#RTCVideo-stoplivetranscoding) instead. 设置转推直播动作参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | action | String | 转推直播动作。可选取值如下：

ACTION_START: 开启转推直播功能
ACTION_CHANGED: 更新转推直播视频合流布局
ACTION_STOPPED: 停止转推直播功能

| # VideoDimensions ```java public class com.ss.bytertc.engine.video.VideoDimensions ``` 视频编码像素 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#VideoDimensions-width) | | int | [height](#VideoDimensions-height) | ## 变量说明 ### width ```java public int com.ss.bytertc.engine.video.VideoDimensions.width ``` 宽 ### height ```java public int com.ss.bytertc.engine.video.VideoDimensions.height ``` 高 # SpatialConfig ```java public static class com.ss.bytertc.engine.live.LiveTranscoding.SpatialConfig ``` 推流 CDN 的空间音频参数。 ## 成员函数 | 返回 | 名称 | | --- | --- | | SpatialConfig | [setAudienceSpatialPosition](#SpatialConfig-setaudiencespatialposition-2) | | SpatialConfig | [setAudienceSpatialOrientation](#SpatialConfig-setaudiencespatialorientation) | | SpatialConfig | [setEnableSpatialRender](#SpatialConfig-setenablespatialrender) | ## 函数说明 ### setAudienceSpatialPosition ```java SpatialConfig com.ss.bytertc.engine.live.LiveTranscoding.SpatialConfig.setAudienceSpatialPosition(Position pos) ``` 设置听众的空间位置。听众指收听来自 CDN 的音频流的用户。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | pos | Position | 听众的空间位置，参看 [Position](#Position)。 | ### setAudienceSpatialOrientation ```java SpatialConfig com.ss.bytertc.engine.live.LiveTranscoding.SpatialConfig.setAudienceSpatialOrientation(HumanOrientation orientation) ``` 设置听众的空间朝向。听众指收听来自 CDN 的音频流的用户。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | orientation | HumanOrientation | 听众的空间朝向。参看 [HumanOrientation](#HumanOrientation)。 | ### setEnableSpatialRender ```java SpatialConfig com.ss.bytertc.engine.live.LiveTranscoding.SpatialConfig.setEnableSpatialRender(boolean enableSpatialRender) ``` 设置是否开启推流 CDN 时的空间音频效果。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enableSpatialRender | boolean | 是否开启推流 CDN 时的空间音频效果：

true：开启；
false：关闭。

| **注意** 当你启用此效果时，你需要设定推流中各个 [SpatialConfig](#LiveTranscoding-SpatialConfig) 的 `spatialPosition` 值，实现空间音频效果。 # MixedStreamSEIContentMode ```java public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSEIContentMode ``` 服务端合流转推 SEI 内容。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MIXED_STREAM_SEI_CONTENT_MODE_DEFAULT | 0 | 视频流中包含全部的 SEI 信息。默认设置。 | | MIXED_STREAM_SEI_CONTENT_MODE_ENABLE_VOLUME_INDICATION | 1 | 随非关键帧传输的 SEI 数据中仅包含音量信息。
当设置 [setEnableVolumeIndication](#MixedStreamServerControlConfig-setenablevolumeindication) 为 true 时，此参数设置生效。 | # AudioMixingError ```java public enum com.ss.bytertc.engine.data.AudioMixingError ``` 混音错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_MIXING_ERROR_OK | 0 | 正常 | | AUDIO_MIXING_ERROR_PRELOAD_FAILED | 1 | 预加载失败。找不到混音文件或者文件长度超出 20s | | AUDIO_MIXING_ERROR_START_FAILED | 2 | 混音开启失败。找不到混音文件或者混音文件打开失败 | | AUDIO_MIXING_ERROR_ID_NOT_FOUND | 3 | 混音 ID 异常 | | AUDIO_MIXING_ERROR_SET_POSITION_FAILED | 4 | 设置混音文件的播放位置出错 | | AUDIO_MIXING_ERROR_INVALID_VOLUME | 5 | 音量参数不合法，仅支持设置的音量值为[0, 400] | | AUDIO_MIXING_ERROR_LOAD_CONFLICT | 6 | 播放的文件与预加载的文件不一致。请先使用 [unloadAudioMixing](70080#IAudioMixingManager-unloadaudiomixing) 卸载此前的文件。 | | AUDIO_MIXING_ERROR_ID_TYPE_NOT_MATCH | 7 | 不支持此混音类型。 | | AUDIO_MIXING_ERROR_ID_TYPE_INVALID_PITCH | 8 | 设置混音文件的音调不合法 | | AUDIO_MIXING_ERROR_INVALID_AUDIO_TRACK | 9 | 设置混音文件的音轨不合法 | | AUDIO_MIXING_ERROR_IS_STARTING | 10 | 混音文件正在启动中 | | AUDIO_MIXING_ERROR_INVALID_PLAYBACK_SPEED | 11 | 设置混音文件的播放速度不合法 | # AACProfile ```java public enum com.ss.bytertc.engine.live.LiveTranscoding.AACProfile ``` AAC 编码规格。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AAC_PROFILE_LC | LC | AAC-LC 规格，默认值。 | | AAC_PROFILE_HEV1 | HEv1 | HE-AAC v1 规格。 | | AAC_PROFILE_HEV2 | HEv2 | HE-AAC v2 规格。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | String | [getValue](#AACProfile-getvalue) | ## 函数说明 ### getValue ```java String com.ss.bytertc.engine.live.LiveTranscoding.AACProfile.getValue() ``` 获取 AAC 编码规格。 **返回值** AAC 编码规格。 # AudioSelectionPriority ```java public enum com.ss.bytertc.engine.type.AudioSelectionPriority ``` 音频选路优先级设置 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_SELECTION_PRIORITY_NORMAL | 0 | 正常，参加音频选路 | | AUDIO_SELECTION_PRIORITY_HIGIH | 1 | 高优先级，跳过音频选路 | # DataMessageSourceType ```java public enum com.ss.bytertc.engine.data.DataMessageSourceType ``` 数据消息来源 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | DATA_MESSAGE_SOURCE_TYPE_DEFAULT | 0 | 通过客户端或服务端的插入的自定义消息。 | | DATA_MESSAGE_SOURCE_TYPE_SYSTEM | 1 | 系统数据，包含音量指示信息。 | # Layout ```java static class com.ss.bytertc.engine.publicstream.PublicStreaming.Layout ``` 公共流的合流布局 ## 成员函数 | 返回 | 名称 | | --- | --- | | Region [] | [getRegions](#Layout-getregions-2) | | void | [setRegions](#Layout-setregions-2) | | int | [getInterpolationMode](#Layout-getinterpolationmode) | | void | [setInterpolationMode](#Layout-setinterpolationmode) | | int | [getLayoutMode](#Layout-getlayoutmode) | | void | [setLayoutMode](#Layout-setlayoutmode) | | String | [getBackgroundImage](#Layout-getbackgroundimage) | | void | [setBackgroundImage](#Layout-setbackgroundimage) | | String | [getBackgroundColor](#Layout-getbackgroundcolor-2) | | void | [setBackgroundColor](#Layout-setbackgroundcolor-2) | ## 函数说明 ### getRegions ```java Region[] com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.getRegions() ``` 获取当前公共流的用户布局信息列表。 **返回值** 当前公共流的用户布局信息列表。 ### setRegions ```java void com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.setRegions(Region[] regions) ``` 设置合成公共流的各路流的布局信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | regions | Region[] | 各路流的布局信息列表。为 [Region](#region-2) 数据类型的数组。每一个该类型对象为一路单独的视频流的布局信息。 | ### getInterpolationMode ```java int com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.getInterpolationMode() ``` 获取插帧模式。 **返回值** 插帧模式。 - `0`: 补最后一帧 - `1`: 补背景图片，如果没有设置背景图片则补黑帧 ### setInterpolationMode ```java void com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.setInterpolationMode(int interMode) ``` 设置插帧模式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | interMode | int | 插帧模式。

`0`: 补最后一帧
`1`: 补背景图片或者黑帧

| ### getLayoutMode ```java int com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.getLayoutMode() ``` 获取当前公共流的布局模式。 **返回值** 当前使用的布局模式。 - `0`: 自动模式。默认值。 - `2`: 自定义模式。 ### setLayoutMode ```java void com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.setLayoutMode(int layoutMode) ``` 设置公共流的布局模式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | layoutMode | int | 公共流的目标布局模式：

`0`: 自动模式。默认值。
`2`: 自定义模式。

| ### getBackgroundImage ```java String com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.getBackgroundImage() ``` 获取视频的背景图片链接。 **返回值** 当前背景图片链接 ### setBackgroundImage ```java void com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.setBackgroundImage(String bgImage) ``` 设置背景图片链接。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | bgImage | String | 背景图片链接。 | ### getBackgroundColor ```java String com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.getBackgroundColor() ``` 获取画布的背景颜色。 **返回值** 当前画布的背景颜色。 ### setBackgroundColor ```java void com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.setBackgroundColor(String backgroundColor) ``` 设置画布的背景颜色。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | backgroundColor | String | 画布的背景颜色。格式为 RGB 定义下的 Hex 值，如 #FFB6C1 表示浅粉色。默认值 #000000，表示为黑色 | # VideoEffectExpressionConfig ```java public class com.ss.bytertc.engine.video.VideoEffectExpressionConfig ``` 人像属性检测参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | boolean | [enableAgeDetect](#VideoEffectExpressionConfig-enableagedetect) | | boolean | [enableGenderDetect](#VideoEffectExpressionConfig-enablegenderdetect) | | boolean | [enableEmotionDetect](#VideoEffectExpressionConfig-enableemotiondetect) | | boolean | [enableAttractivenessDetect](#VideoEffectExpressionConfig-enableattractivenessdetect) | | boolean | [enableHappinessDetect](#VideoEffectExpressionConfig-enablehappinessdetect) | ## 变量说明 ### enableAgeDetect ```java public boolean com.ss.bytertc.engine.video.VideoEffectExpressionConfig.enableAgeDetect = false ``` 是否开启年龄检测。 ### enableGenderDetect ```java public boolean com.ss.bytertc.engine.video.VideoEffectExpressionConfig.enableGenderDetect = false ``` 是否开启性别检测。 ### enableEmotionDetect ```java public boolean com.ss.bytertc.engine.video.VideoEffectExpressionConfig.enableEmotionDetect = false ``` 是否开启表情检测。 ### enableAttractivenessDetect ```java public boolean com.ss.bytertc.engine.video.VideoEffectExpressionConfig.enableAttractivenessDetect = false ``` 是否开启吸引力检测。 ### enableHappinessDetect ```java public boolean com.ss.bytertc.engine.video.VideoEffectExpressionConfig.enableHappinessDetect = false ``` 是否开启开心程度检测。 # FaceDetectionResult ```java public class com.ss.bytertc.engine.video.FaceDetectionResult ``` 人脸检测结果 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [detectResult](#FaceDetectionResult-detectresult) | | int | [imageWidth](#FaceDetectionResult-imagewidth) | | int | [imageHeight](#FaceDetectionResult-imageheight) | | Rectangle[] | [faces](#FaceDetectionResult-faces) | | long | [frameTimestampUs](#FaceDetectionResult-frametimestampus) | ## 变量说明 ### detectResult ```java public int com.ss.bytertc.engine.video.FaceDetectionResult.detectResult ``` 人脸检测结果 - 0：检测成功 - !0：检测失败。详见[CV 错误码](https://www.volcengine.com/docs/6705/102042)。 ### imageWidth ```java public int com.ss.bytertc.engine.video.FaceDetectionResult.imageWidth ``` 原始图片宽度(px) ### imageHeight ```java public int com.ss.bytertc.engine.video.FaceDetectionResult.imageHeight ``` 原始图片高度(px) ### faces ```java public Rectangle [] com.ss.bytertc.engine.video.FaceDetectionResult.faces ``` 识别到人脸的矩形框。数组的长度和检测到的人脸数量一致。参看 [Rectangle](#Rectangle)。 ### frameTimestampUs ```java public long com.ss.bytertc.engine.video.FaceDetectionResult.frameTimestampUs ``` 进行人脸识别的视频帧的时间戳。 # VideoFrame ```java public abstract class com.ss.bytertc.engine.video.VideoFrame ``` 视频帧 ## 成员函数 | 返回 | 名称 | | --- | --- | | synchronized void | [setReleaseCallback](#VideoFrame-setreleasecallback) | | synchronized boolean | [hasReleaseCallback](#VideoFrame-hasreleasecallback) | | abstract VideoFrameType | [getFrameType](#VideoFrame-getframetype) | | abstract VideoPixelFormat | [getPixelFormat](#VideoFrame-getpixelformat) | | abstract VideoContentType | [getContentType](#VideoFrame-getcontenttype) | | abstract long | [getTimeStampUs](#VideoFrame-gettimestampus) | | abstract int | [getWidth](#VideoFrame-getwidth) | | abstract int | [getHeight](#VideoFrame-getheight) | | abstract VideoRotation | [getRotation](#VideoFrame-getrotation) | | abstract ColorSpace | [getColorSpace](#VideoFrame-getcolorspace) | | abstract CameraId | [getCameraId](#VideoFrame-getcameraid) | | abstract int | [getNumberOfPlanes](#VideoFrame-getnumberofplanes) | | abstract ByteBuffer | [getPlaneData](#VideoFrame-getplanedata) | | abstract int | [getPlaneStride](#VideoFrame-getplanestride) | | abstract ByteBuffer | [getExternalDataInfo](#VideoFrame-getexternaldatainfo) | | abstract ByteBuffer | [getSupplementaryInfo](#VideoFrame-getsupplementaryinfo) | | abstract int | [getTextureID](#VideoFrame-gettextureid) | | abstract float[] | [getTextureMatrix](#VideoFrame-gettexturematrix) | | abstract EGLContext | [getEGLContext](#VideoFrame-geteglcontext) | | synchronized void | [retain](#VideoFrame-retain) | | synchronized void | [release](#VideoFrame-release) | ## 函数说明 ### setReleaseCallback ```java synchronized void com.ss.bytertc.engine.video.VideoFrame.setReleaseCallback(Runnable releaseCallback) ``` 设置视频帧释放回调，当视频帧的引用计数归 0 时，会执行 releaseCallback **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | releaseCallback | Runnable | 视频帧释放回调 | ### hasReleaseCallback ```java synchronized boolean com.ss.bytertc.engine.video.VideoFrame.hasReleaseCallback() ``` 用于检查当前的视频帧是否已设置 releaseCallback **返回值** - true：是 - false：否 ### getFrameType ```java abstract VideoFrameType com.ss.bytertc.engine.video.VideoFrame.getFrameType() ``` 获取视频帧类型，参看 [VideoFrameType](#VideoFrameType) ### getPixelFormat ```java abstract VideoPixelFormat com.ss.bytertc.engine.video.VideoFrame.getPixelFormat() ``` 获取视频帧格式，参看 [VideoPixelFormat](#VideoPixelFormat) ### getContentType ```java abstract VideoContentType com.ss.bytertc.engine.video.VideoFrame.getContentType() ``` 获取视频内容类型 **返回值** 视频内容类型，参看 [VideoContentType](#VideoContentType)。 ### getTimeStampUs ```java abstract long com.ss.bytertc.engine.video.VideoFrame.getTimeStampUs() ``` 获取视频帧时间戳，单位：微秒 ### getWidth ```java abstract int com.ss.bytertc.engine.video.VideoFrame.getWidth() ``` 获取视频帧宽度，单位：px ### getHeight ```java abstract int com.ss.bytertc.engine.video.VideoFrame.getHeight() ``` 获取视频帧高度，单位：px ### getRotation ```java abstract VideoRotation com.ss.bytertc.engine.video.VideoFrame.getRotation() ``` 获取视频帧旋转角度 ### getColorSpace ```java abstract ColorSpace com.ss.bytertc.engine.video.VideoFrame.getColorSpace() ``` 获取视频帧色彩空间，参看 [ColorSpace](#ColorSpace) ### getCameraId ```java abstract CameraId com.ss.bytertc.engine.video.VideoFrame.getCameraId() ``` 获取视频帧的摄像头信息，参看 [CameraId](#CameraId) ### getNumberOfPlanes ```java abstract int com.ss.bytertc.engine.video.VideoFrame.getNumberOfPlanes() ``` 获取视频帧像素平面数量 **注意** yuv 数据存储格式分为打包（packed）存储格式和平面（planar）存储格式，planar 格式中 Y、U、V 分平面存储，packed 格式中 Y、U、V 交叉存储 ### getPlaneData ```java abstract ByteBuffer com.ss.bytertc.engine.video.VideoFrame.getPlaneData(int planeIndex) ``` 获取 plane 数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | planeIndex | int | plane 数据索引 | ### getPlaneStride ```java abstract int com.ss.bytertc.engine.video.VideoFrame.getPlaneStride(int planeIndex) ``` 获取指定 plane 中数据行的长度 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | planeIndex | int | plane 数据索引 | ### getExternalDataInfo ```java abstract ByteBuffer com.ss.bytertc.engine.video.VideoFrame.getExternalDataInfo() ``` 获取 SEI 数据 ### getSupplementaryInfo ```java abstract ByteBuffer com.ss.bytertc.engine.video.VideoFrame.getSupplementaryInfo() ``` 获取补充数据指针 ### getTextureID ```java abstract int com.ss.bytertc.engine.video.VideoFrame.getTextureID() ``` 获取纹理 ID ### getTextureMatrix ```java abstract float[] com.ss.bytertc.engine.video.VideoFrame.getTextureMatrix() ``` 获取纹理矩阵 ### getEGLContext ```java abstract EGLContext com.ss.bytertc.engine.video.VideoFrame.getEGLContext() ``` 获取纹理使用的 EGLContext ### retain ```java synchronized void com.ss.bytertc.engine.video.VideoFrame.retain() ``` 对当前的视频帧进行一次引用计数 ### release ```java synchronized void com.ss.bytertc.engine.video.VideoFrame.release() ``` 对当前的视频帧减少一次引用计数 # RemoteStreamKey ```java public class com.ss.bytertc.engine.data.RemoteStreamKey ``` 远端流信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [roomId](#RemoteStreamKey-roomid) | | String | [userId](#RemoteStreamKey-userid) | | StreamIndex | [streamIndex](#RemoteStreamKey-streamindex) | ## 成员函数 | 返回 | 名称 | | --- | --- | | String | [getRoomId](#RemoteStreamKey-getroomid) | | String | [getUserId](#RemoteStreamKey-getuserid) | | StreamIndex | [getStreamIndex](#RemoteStreamKey-getstreamindex) | | boolean | [hasNullProperty](#RemoteStreamKey-hasnullproperty) | ## 变量说明 ### roomId ```java public String com.ss.bytertc.engine.data.RemoteStreamKey.roomId ``` 房间 ID ### userId ```java public String com.ss.bytertc.engine.data.RemoteStreamKey.userId ``` 用户 ID ### streamIndex ```java public StreamIndex com.ss.bytertc.engine.data.RemoteStreamKey.streamIndex ``` 流属性，包括主流、屏幕流。参看 [StreamIndex](#StreamIndex) ## 函数说明 ### getRoomId ```java String com.ss.bytertc.engine.data.RemoteStreamKey.getRoomId() ``` 获取房间 ID ### getUserId ```java String com.ss.bytertc.engine.data.RemoteStreamKey.getUserId() ``` 获取用户 ID ### getStreamIndex ```java StreamIndex com.ss.bytertc.engine.data.RemoteStreamKey.getStreamIndex() ``` 获取流属性，包括主流、屏幕流。参看 [StreamIndex](#StreamIndex) ### hasNullProperty ```java boolean com.ss.bytertc.engine.data.RemoteStreamKey.hasNullProperty() ``` 检查当前类中是否有为空的字段 # VoiceReverbType ```java public enum com.ss.bytertc.engine.type.VoiceReverbType ``` 混响特效类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | VOICE_REVERB_ORIGINAL | 0 | 原声，不含特效 | | VOICE_REVERB_ECHO | 1 | 回声 | | VOICE_REVERB_CONCERT | 2 | 演唱会 | | VOICE_REVERB_ETHEREAL | 3 | 空灵 | | VOICE_REVERB_KTV | 4 | KTV | | VOICE_REVERB_STUDIO | 5 | 录音棚 | | VOICE_REVERB_VIRTUAL_STEREO | 6 | 虚拟立体声 | | VOICE_REVERB_SPACIOUS | 7 | 空旷 | | VOICE_REVERB_3D | 8 | 3D 人声 | # MediaPlayerCustomSourceMode ```java public enum com.ss.bytertc.engine.data.MediaPlayerCustomSourceMode ``` 自定义音频源模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | PUSH | 0 | 当播放来自本地的 PCM 数据时，使用此选项。 | | PULL | 1 | 当播放来自内存的音频数据时，使用此选项。 | # KTVPlayerErrorCode ```java public enum com.ss.bytertc.ktv.data.KTVPlayerErrorCode ``` KTV 播放器错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | OK | 0 | 成功。 | | FILE_NOT_EXIST | -3020 | 播放错误，请下载后播放。 | | FILE_ERROR | -3021 | 播放错误，请确认文件播放格式。 | | NOT_JOIN_ROOM | -3022 | 播放错误，未进入房间。 | | PARAM | -3023 | 参数错误。 | | START_ERROR | -3024 | 播放失败，找不到文件或文件打开失败。 | | MIX_ID_ERROR | -3025 | 混音 ID 异常。 | | POSITION_ERROR | -3026 | 设置播放位置出错。 | | AUDIO_VOLUME_ERROR | -3027 | 音量参数不合法，可设置的取值范围为 [0,400]。 | | TYPE_ERROR | -3028 | 不支持此混音类型。 | | PITCH_ERROR | -3029 | 音调文件不合法。 | | AUDIO_TRACK_ERROR | -3030 | 音轨不合法。 | | STARTING_ERROR | -3031 | 混音启动中。 | # AudioChannel ```java public enum com.ss.bytertc.engine.data.AudioChannel ``` 音频声道。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_CHANNEL_AUTO | -1 | 默认设置。双声道。 | | AUDIO_CHANNEL_MONO | 1 | 单声道 | | AUDIO_CHANNEL_STEREO | 2 | 双声道 | # RemoteVideoStateChangeReason ```java public enum com.ss.bytertc.engine.type.RemoteVideoStateChangeReason ``` 远端视频流状态改变的原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | REMOTE_VIDEO_STATE_CHANGE_REASON_INTERNAL | 0 | 内部原因 | | REMOTE_VIDEO_STATE_CHANGE_REASON_NETWORK_CONGESTION | 1 | 网络阻塞 | | REMOTE_VIDEO_STATE_CHANGE_REASON_NETWORK_RECOVERY | 2 | 网络恢复正常 | | REMOTE_VIDEO_STATE_CHANGE_REASON_LOCAL_MUTED | 3 | 本地用户停止接收远端视频流或本地用户禁用视频模块 | | REMOTE_VIDEO_STATE_CHANGE_REASON_LOCAL_UNMUTED | 4 | 本地用户恢复接收远端视频流或本地用户启用视频模块 | | REMOTE_VIDEO_STATE_CHANGE_REASON_REMOTE_MUTED | 5 | 远端用户停止发送视频流或远端用户禁用视频模块 | | REMOTE_VIDEO_STATE_CHANGE_REASON_REMOTE_UNMUTED | 6 | 远端用户恢复发送视频流或远端用户启用视频模块 | | REMOTE_VIDEO_STATE_CHANGE_REASON_REMOTE_OFFLINE | 7 | 远端用户离开房间
状态转换参看 [onUserUnpublishStream](70081#IRTCRoomEventHandler-onuserunpublishstream)/ [onUserUnpublishScreen](70081#IRTCRoomEventHandler-onuserunpublishscreen)。 | # PerformanceAlarmReason ```java public enum com.ss.bytertc.engine.type.PerformanceAlarmReason ``` 性能相关告警的原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BANDWIDTH_FALLBACKED | 0 | 网络原因差，造成了发送性能回退。仅在开启发送性能回退时，会收到此原因。 | | BANDWIDTH_RESUMED | 1 | 网络性能恢复，发送性能回退恢复。仅在开启发送性能回退时，会收到此原因。 | | PERFORMANCE_FALLBACKED | 2 | 如果未开启发送性能回退，收到此告警时，意味着性能不足；
如果开启了发送性能回退，收到此告警时，意味着性能不足，且已发生发送性能回退。 | | PERFORMANCE_RESUMED | 3 | 如果未开启发送性能回退，收到此告警时，意味着性能不足已恢复；
如果开启了发送性能回退，收到此告警时，意味着性能不足已恢复，且已发生发送性能回退恢复。 | # VideoDeviceType ```java public enum com.ss.bytertc.engine.type.VideoDeviceType ``` 当前视频设备类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | VIDEO_DEVICE_TYPE_UNKNOWN | -1 | 未知设备类型 | | VIDEO_DEVICE_TYPE_RENDER_DEVICE | 0 | 视频渲染设备类型 | | VIDEO_DEVICE_TYPE_CAPTURE_DEVICE | 1 | 视频采集设备类型 | | VIDEO_DEVICE_TYPE_SCREEN_CAPTURE_DEVICE | 2 | 屏幕流视频设备 | # HotMusicInfo ```java public class com.ss.bytertc.ktv.data.HotMusicInfo ``` 热榜歌曲数据。 ## 成员变量 | 类型 | 名称 | | --- | --- | | MusicHotType | [hotType](#HotMusicInfo-hottype) | | String | [hotName](#HotMusicInfo-hotname) | | MusicInfo[] | [musicInfos](#HotMusicInfo-musicinfos) | ## 变量说明 ### hotType ```java public MusicHotType com.ss.bytertc.ktv.data.HotMusicInfo.hotType ``` 热榜类别，参看 [MusicHotType](#MusicHotType)。多个热榜类别可以按位或组合。 ### hotName ```java public String com.ss.bytertc.ktv.data.HotMusicInfo.hotName ``` 热榜名称。 ### musicInfos ```java public MusicInfo [] com.ss.bytertc.ktv.data.HotMusicInfo.musicInfos ``` 歌曲数据，参看 [MusicInfo](#MusicInfo)。 # TranscoderRenderMode ```java public enum com.ss.bytertc.engine.live.LiveTranscoding.TranscoderRenderMode ``` 图片或视频流的缩放模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | RENDER_HIDDEN | 1 | 视窗填满优先，默认值。
视频尺寸等比缩放，直至视窗被填满。当视频尺寸与显示窗口尺寸不一致时，多出的视频将被截掉。 | | RENDER_FIT | 2 | 视频帧内容全部显示优先。
视频尺寸等比缩放，优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时，会把窗口未被填满的区域填充成背景颜色。 | | RENDER_ADAPTIVE | 3 | 视频帧自适应画布。
视频尺寸非等比例缩放，把窗口充满。在此过程中，视频帧的长宽比例可能会发生变化。 | | [deprecated] RENDER_UNKNOWN | 0 | `Deprecated since 3.45 and will be deleted in 3.51.` | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [getValue](#TranscoderRenderMode-getvalue) | ## 函数说明 ### getValue ```java int com.ss.bytertc.engine.live.LiveTranscoding.TranscoderRenderMode.getValue() ``` 获取视频内容的缩放模式。 **返回值** 视频内容的缩放模式。 # MixedStreamServerControlConfig ```java public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig ``` 服务端合流控制参数。 ## 成员函数 | 返回 | 名称 | | --- | --- | | MixedStreamServerControlConfig | [setSeiPayloadType](#MixedStreamServerControlConfig-setseipayloadtype) | | int | [getSeiPayloadType](#MixedStreamServerControlConfig-getseipayloadtype) | | MixedStreamServerControlConfig | [setSeiPayloadUuid](#MixedStreamServerControlConfig-setseipayloaduuid) | | String | [getSeiPayloadUuid](#MixedStreamServerControlConfig-getseipayloaduuid) | | MixedStreamServerControlConfig | [setVolumeIndicationInterval](#MixedStreamServerControlConfig-setvolumeindicationinterval) | | float | [getVolumeIndicationInterval](#MixedStreamServerControlConfig-getvolumeindicationinterval) | | MixedStreamServerControlConfig | [setEnableVolumeIndication](#MixedStreamServerControlConfig-setenablevolumeindication) | | boolean | [getEnableVolumeIndication](#MixedStreamServerControlConfig-getenablevolumeindication) | | MixedStreamServerControlConfig | [setIsAddVolumeValue](#MixedStreamServerControlConfig-setisaddvolumevalue) | | boolean | [getIsAddVolumeValue](#MixedStreamServerControlConfig-getisaddvolumevalue) | | MixedStreamServerControlConfig | [setSeiContentMode](#MixedStreamServerControlConfig-setseicontentmode) | | MixedStreamSEIContentMode | [getSeiContentMode](#MixedStreamServerControlConfig-getseicontentmode) | | MixedStreamServerControlConfig | [setTalkVolume](#MixedStreamServerControlConfig-settalkvolume) | | int | [getTalkVolume](#MixedStreamServerControlConfig-gettalkvolume) | | MixedStreamServerControlConfig | [setPushStreamMode](#MixedStreamServerControlConfig-setpushstreammode) | | MixedStreamPushMode | [getPushStreamMode](#MixedStreamServerControlConfig-getpushstreammode) | | MixedStreamServerControlConfig | [setMediaType](#MixedStreamServerControlConfig-setmediatype) | | MixedStreamMediaType | [getMediaType](#MixedStreamServerControlConfig-getmediatype) | ## 函数说明 ### setSeiPayloadType ```java MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setSeiPayloadType(int seiPayloadType) ``` > Available since 3.56 设置合流转推 SEI 信息的 payload type。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | seiPayloadType | int | 默认值为 `100`，只支持设置 `5` 和 `100`。 | **返回值** MixedStreamServerControlConfig，参看 MixedStreamServerControlConfig{ MixedStreamServerControlConfig}。 **注意** 在转推直播的过程中，该参数不支持变更。 ### getSeiPayloadType ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getSeiPayloadType() ``` > Available since 3.56 获取合流转推 SEI 信息的 payload type。 ### setSeiPayloadUuid ```java MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setSeiPayloadUuid(String seiPayloadUuid) ``` > Available since 3.56 设置合流转推 SEI 信息的 Payload UUID。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | seiPayloadUuid | String | 该参数长度需为 32 位，否则会收到错误码为 1091 的回调。该参数每个字符的范围需为 [0, 9] [a, f] [A, F]。
该参数不应带有`-`字符，如系统自动生成的 UUID 中带有`-`，则应删去。 | **返回值** MixedStreamServerControlConfig，参看 MixedStreamServerControlConfig{ MixedStreamServerControlConfig}。 **注意** PayloadType 为 `5` 时，必须填写 PayloadUUID，否则会收到错误回调，错误码为 1091。 PayloadType 不是 `5` 时，不需要填写 PayloadUUID，如果填写会被后端忽略。在转推直播的过程中，该参数不支持变更。 ### getSeiPayloadUuid ```java String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getSeiPayloadUuid() ``` > Available since 3.56 获取合流转推 SEI 信息的 Payload UUID。 ### setVolumeIndicationInterval ```java MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setVolumeIndicationInterval(float volumeIndicationInterval) ``` > Available since 3.56 设置声音信息提示间隔。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | volumeIndicationInterval | float | 提示间隔，单位为秒，取值范围为 [0.3,+∞)，默认值为 2。
此值仅取整百毫秒。若传入两位及以上小数，则四舍五入取第一位小数的值。例如，若传入 0.36，则取 0.4。 | ### getVolumeIndicationInterval ```java float com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getVolumeIndicationInterval() ``` > Available since 3.56 获取音量提示间隔。 ### setEnableVolumeIndication ```java MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setEnableVolumeIndication(boolean enableVolumeIndication) ``` > Available since 3.56 设置是否开启单独发送声音提示 SEI 的功能。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enableVolumeIndication | boolean | 是否开启单独发送声音提示 SEI：

true：开启；
false：关闭。（默认值）

| **注意** 开启后，你可以通过 [setSeiContentMode](#MixedStreamServerControlConfig-setseicontentmode) 控制 SEI 的内容是否只携带声音信息。 ### getEnableVolumeIndication ```java boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getEnableVolumeIndication() ``` > Available since 3.56 获取是否开启单独发送声音提示 SEI 功能的设置。 ### setIsAddVolumeValue ```java MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setIsAddVolumeValue(boolean addVolumeValue) ``` > Available since 3.56 设置声音信息 SEI 是否包含音量值。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | addVolumeValue | boolean | 是否包含音量值：

true：包含；
false：不包含。默认值。

| ### getIsAddVolumeValue ```java boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getIsAddVolumeValue() ``` > Available since 3.56 获取声音信息 SEI 是否包含音量值的设置。 ### setSeiContentMode ```java MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setSeiContentMode(MixedStreamSEIContentMode seiContentMode) ``` > Available since 3.56 设置 SEI 内容。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | seiContentMode | MixedStreamSEIContentMode | SEI 内容，参看 [MixedStreamSEIContentMode](#MixedStreamSEIContentMode)。 | ### getSeiContentMode ```java MixedStreamSEIContentMode com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getSeiContentMode() ``` > Available since 3.56 获取 SEI 内容设置。 ### setTalkVolume ```java MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setTalkVolume(int talkVolume) ``` > Available since 3.56 设置有效音量大小。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | talkVolume | int | 有效音量大小，取值范围为 [0, 255]，默认值为 0。
超出取值范围则自动调整为默认值，即 0。 | ### getTalkVolume ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getTalkVolume() ``` > Available since 3.56 获取有效音量大小。 ### setPushStreamMode ```java MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setPushStreamMode(MixedStreamPushMode pushStreamMode) ``` > Available since 3.57 设置是否在没有用户发布流的情况下发起转推直播。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | pushStreamMode | MixedStreamPushMode | 合流任务发起模式。具体参看 [MixedStreamPushMode](#MixedStreamPushMode)。
该参数在发起合流任务后的转推直播过程中不支持动态变更。 | ### getPushStreamMode ```java MixedStreamPushMode com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getPushStreamMode() ``` > Available since 3.57 获取合流任务发起模式的设置。 ### setMediaType ```java MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setMediaType(MixedStreamMediaType mediaType) ``` > Available since 3.57 设置合流推到 CDN 时输出的媒体流类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mediaType | MixedStreamMediaType | 输出的媒体流类型。参看 [MixedStreamMediaType](#MixedStreamMediaType)。
默认输出音视频流。支持输出纯音频流，但暂不支持输出纯视频流。 | ### getMediaType ```java MixedStreamMediaType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getMediaType() ``` > Available since 3.57 获取合流推到 CDN 时输出的媒体流类型设置。 # AudioMixingDualMonoMode ```java public enum com.ss.bytertc.engine.data.AudioMixingDualMonoMode ``` 混音播放声道类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_MIXING_DUAL_MONO_MODE_AUTO | 0 | 和音频文件一致 | | AUDIO_MIXING_DUAL_MONO_MODE_L | 1 | 只能听到音频文件中左声道的音频 | | AUDIO_MIXING_DUAL_MONO_MODE_R | 2 | 只能听到音频文件中右声道的音频 | | AUDIO_MIXING_DUAL_MONO_MODE_MIX | 3 | 能同时听到音频文件中左右声道的音频 | # LocalAudioStats ```java public class com.ss.bytertc.engine.type.LocalAudioStats ``` 本地音频流统计信息，统计周期为 2s 。本地用户发布音频流成功后，SDK 会周期性地通过 `onLocalStreamStats` 通知用户发布的音频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [audioLossRate](#LocalAudioStats-audiolossrate) | | float | [sendKBitrate](#LocalAudioStats-sendkbitrate) | | int | [recordSampleRate](#LocalAudioStats-recordsamplerate) | | int | [statsInterval](#LocalAudioStats-statsinterval) | | int | [rtt](#LocalAudioStats-rtt) | | int | [numChannels](#LocalAudioStats-numchannels) | | int | [sentSampleRate](#LocalAudioStats-sentsamplerate) | | int | [jitter](#LocalAudioStats-jitter) | ## 变量说明 ### audioLossRate ```java public float com.ss.bytertc.engine.type.LocalAudioStats.audioLossRate ``` 音频丢包率。此次统计周期内的音频上行丢包率，取值范围为 [0, 1] 。 ### sendKBitrate ```java public float com.ss.bytertc.engine.type.LocalAudioStats.sendKBitrate ``` 发送码率。此次统计周期内的音频发送码率，单位为 kbps 。 ### recordSampleRate ```java public int com.ss.bytertc.engine.type.LocalAudioStats.recordSampleRate ``` 采集采样率。此次统计周期内的音频采集采样率信息，单位为 Hz 。 ### statsInterval ```java public int com.ss.bytertc.engine.type.LocalAudioStats.statsInterval ``` 统计间隔。此次统计周期的间隔，单位为 ms 。此字段用于设置回调的统计周期，默认设置为 2s 。 ### rtt ```java public int com.ss.bytertc.engine.type.LocalAudioStats.rtt ``` 往返时延。单位为 ms 。 ### numChannels ```java public int com.ss.bytertc.engine.type.LocalAudioStats.numChannels ``` 音频声道数。 ### sentSampleRate ```java public int com.ss.bytertc.engine.type.LocalAudioStats.sentSampleRate ``` 音频发送采样率。此次统计周期内的音频发送采样率信息，单位为 Hz 。 ### jitter ```java public int com.ss.bytertc.engine.type.LocalAudioStats.jitter ``` 音频上行网络抖动，单位为 ms 。 # MixedStreamVideoConfig ```java public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig ``` 视频转码配置参数。值不合法或未设置时，自动使用默认值。 ## 成员函数 | 返回 | 名称 | | --- | --- | | MixedStreamVideoConfig | [setFps](#MixedStreamVideoConfig-setfps) | | int | [getFps](#MixedStreamVideoConfig-getfps) | | MixedStreamVideoConfig | [setGop](#MixedStreamVideoConfig-setgop) | | int | [getGop](#MixedStreamVideoConfig-getgop) | | MixedStreamVideoConfig | [setBitrate](#MixedStreamVideoConfig-setbitrate) | | int | [getBitrate](#MixedStreamVideoConfig-getbitrate) | | MixedStreamVideoConfig | [setWidth](#MixedStreamVideoConfig-setwidth) | | int | [getWidth](#MixedStreamVideoConfig-getwidth) | | MixedStreamVideoConfig | [setHeight](#MixedStreamVideoConfig-setheight) | | int | [getHeight](#MixedStreamVideoConfig-getheight) | | MixedStreamVideoConfig | [setEnableBframe](#MixedStreamVideoConfig-setenablebframe) | | boolean | [getEnableBframe](#MixedStreamVideoConfig-getenablebframe) | | MixedStreamVideoConfig | [setVideoCodec](#MixedStreamVideoConfig-setvideocodec) | | MixedStreamVideoCodecType | [getVideoCodec](#MixedStreamVideoConfig-getvideocodec) | ## 函数说明 ### setFps ```java MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setFps(int fps) ``` 设置合流视频帧率。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | fps | int | 合流视频帧率。单位为 FPS，取值范围为 [1,60]，默认值为 15 FPS。 | ### getFps ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getFps() ``` 获取合流视频帧率。 ### setGop ```java MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setGop(int gop) ``` 设置视频 I 帧时间间隔。建议设置。本参数不支持过程中更新。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | gop | int | 视频 I 帧时间间隔。单位为秒，取值范围为 [1, 5]，默认值为 2 秒。 | ### getGop ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getGop() ``` 获取视频 I 帧时间间隔。 ### setBitrate ```java MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setBitrate(int bitrate) ``` 设置合流视频码率。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | bitrate | int | 合流视频码率。单位为 Kbps，取值范围为 [1,10000]，默认值为自适应模式。 | ### getBitrate ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getBitrate() ``` 获取合流视频码率。 ### setWidth ```java MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setWidth(int width) ``` 设置合流视频宽度。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | int | 合流视频宽度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 640 px。
设置值为非偶数时，自动向上取偶数。 | ### getWidth ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getWidth() ``` 获取合流视频宽度。 ### setHeight ```java MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setHeight(int height) ``` 设置合流视频高度。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | height | int | 合流视频高度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 360 px。
设置值为非偶数时，自动向上取偶数。 | ### getHeight ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getHeight() ``` 获取合流视频高度。 ### setEnableBframe ```java MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setEnableBframe(boolean enableBframe) ``` 设置是否使用 B 帧（仅在服务端合流生效）。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enableBframe | boolean | 是否使用 B 帧。取值含义如下:

true: 使用 B 帧
false: 不使用 B 帧

| ### getEnableBframe ```java boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getEnableBframe() ``` 获取是否使用 B 帧（仅在服务端合流生效）的设置。 ### setVideoCodec ```java MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setVideoCodec(MixedStreamVideoCodecType videoCodec) ``` 设置视频编码格式。建议设置。本参数不支持过程中更新。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoCodec | MixedStreamVideoCodecType | 视频编码格式，参看 [MixedStreamVideoCodecType](#MixedStreamVideoCodecType)。默认值为 `MIXED_STREAM_VIDEO_CODEC_TYPE_H264("H264")`。 | ### getVideoCodec ```java MixedStreamVideoCodecType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getVideoCodec() ``` 获取视频编码格式。 # MediaPlayerCustomSource ```java public class com.ss.bytertc.engine.data.MediaPlayerCustomSource ``` 音频源 ## 成员变量 | 类型 | 名称 | | --- | --- | | MediaPlayerCustomSourceMode | [mode](#MediaPlayerCustomSource-mode) | | MediaPlayerCustomSourceStreamType | [type](#MediaPlayerCustomSource-type) | ## 变量说明 ### mode ```java public MediaPlayerCustomSourceMode com.ss.bytertc.engine.data.MediaPlayerCustomSource.mode = MediaPlayerCustomSourceMode.PUSH ``` 数据源模式，详见 [MediaPlayerCustomSourceMode](#MediaPlayerCustomSourceMode)。 ### type ```java public MediaPlayerCustomSourceStreamType com.ss.bytertc.engine.data.MediaPlayerCustomSource.type = MediaPlayerCustomSourceStreamType.RAW ``` 数据源类型，详见 [MediaPlayerCustomSourceStreamType](#MediaPlayerCustomSourceStreamType) # MusicFilterType ```java public enum com.ss.bytertc.ktv.data.MusicFilterType ``` 歌曲过滤方式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | NONE | 0 | 不过滤。 | | WITHOUT_LYRIC | 1<<0 | 过滤没有歌词的歌曲。 | | UNSUPPORTED_SCORE | 1<<1 | 过滤不支持打分的歌曲。 | | UNSUPPORTED_ACCOMPANY | 1<<2 | 过滤不支持伴唱切换的歌曲。 | | UNSUPPORTED_CLIMAX | 1<<3 | 过滤没有高潮片段的歌曲。 | # RemoteAudioPropertiesInfo ```java public class com.ss.bytertc.engine.data.RemoteAudioPropertiesInfo ``` 远端音频属性信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | RemoteStreamKey | [streamKey](#RemoteAudioPropertiesInfo-streamkey) | | AudioPropertiesInfo | [audioPropertiesInfo](#RemoteAudioPropertiesInfo-audiopropertiesinfo) | ## 变量说明 ### streamKey ```java public RemoteStreamKey com.ss.bytertc.engine.data.RemoteAudioPropertiesInfo.streamKey ``` 远端流信息，详见 [RemoteStreamKey](#RemoteStreamKey) ### audioPropertiesInfo ```java public AudioPropertiesInfo com.ss.bytertc.engine.data.RemoteAudioPropertiesInfo.audioPropertiesInfo ``` 音频属性信息，详见 [AudioPropertiesInfo](#AudioPropertiesInfo) # LocalVideoRenderPosition ```java public enum com.ss.bytertc.engine.video.LocalVideoRenderPosition ``` 本地视频帧回调位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AFTER_CAPTURE | 0 | 采集后。 | | AFTER_PREPROCESS | 1 | （默认值）前处理后。 | # RTCLogConfig ```java public class com.ss.bytertc.engine.data.RTCLogConfig ``` 本地日志参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [logPath](#RTCLogConfig-logpath) | | int | [logFileSize](#RTCLogConfig-logfilesize) | | LocalLogLevel | [logLevel](#RTCLogConfig-loglevel) | | String | [logFilenamePrefix](#RTCLogConfig-logfilenameprefix) | ## 变量说明 ### logPath ```java public String com.ss.bytertc.engine.data.RTCLogConfig.logPath ``` 日志存储路径，必填。 ### logFileSize ```java public int com.ss.bytertc.engine.data.RTCLogConfig.logFileSize = 10 ``` 日志文件最大占用的总空间，单位为 MB，必填。取值范围为 1～100 MB。若 `logFileSize` < 1，取 1 MB。若 `logFileSize` \> 100，取 100 MB。其中，单个日志文件最大为 2 MB： - 若 1 ≤ `logFileSize` ≤ 2，则会生成一个日志文件。 - 若 `logFileSize` \> 2，假设 `logFileSize/2` 的整数部分为 N，则前 N 个文件，每个文件会写满 2 MB，第 N+1 个文件大小不超过 `logFileSize mod 2` ，否则会删除最老的文件，以此类推。 ### logLevel ```java public LocalLogLevel com.ss.bytertc.engine.data.RTCLogConfig.logLevel = LocalLogLevel.WARNING ``` 日志等级，参看 [LocalLogLevel](#LocalLogLevel)，必填，目前仅支持警告级别。 ### logFilenamePrefix ```java public String com.ss.bytertc.engine.data.RTCLogConfig.logFilenamePrefix ``` 日志文件名前缀，必填。该字符串必须符合正则表达式：[a-zA-Z0-9_@-.]{1,128}。最终的日志文件名为`前缀 + "_" + 文件创建时间 + "_rtclog".log`，如 `logPrefix_2023-05-25_172324_rtclog.log`。 # AudioReportMode ```java public enum com.ss.bytertc.engine.data.AudioReportMode ``` 音量回调模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_REPORT_MODE_NORMAL | 0 | 默认始终开启音量回调。 | | AUDIO_REPORT_MODE_DISCONNECT | 1 | 可见用户进房并停止推流后，关闭音量回调。 | | AUDIO_REPORT_MODE_RESET | 2 | 可见用户进房并停止推流后，开启音量回调，回调值重置为 0。 | # AudioFormat ```java public class com.ss.bytertc.engine.data.AudioFormat ``` 音频参数格式 ## 成员变量 | 类型 | 名称 | | --- | --- | | AudioSampleRate | [sampleRate](#AudioFormat-samplerate) | | AudioChannel | [channel](#AudioFormat-channel) | | int | [samplesPerCall](#AudioFormat-samplespercall) | ## 变量说明 ### sampleRate ```java public AudioSampleRate com.ss.bytertc.engine.data.AudioFormat.sampleRate ``` 音频采样率，参看 [AudioSampleRate](#AudioSampleRate)。 ### channel ```java public AudioChannel com.ss.bytertc.engine.data.AudioFormat.channel ``` 音频声道，参看 [AudioChannel](#AudioChannel)。 ### samplesPerCall ```java public int com.ss.bytertc.engine.data.AudioFormat.samplesPerCall ``` 单次回调的音频帧中包含的采样点数。你可以通过设置 `samplesPerCall`，`sampleRate` 和 `channel`，设置音频帧长。默认值为 `0`，此时，采样点数取最小值。最小值为帧长间隔是 0.01s 时的值，即 `sampleRate * channel * 0.01s`。最大值是 `2048`。超出取值范围时，采样点数取默认值。该参数仅在设置读写回调时生效，调用 [enableAudioFrameCallback](70080#RTCVideo-enableaudioframecallback) 开启只读模式回调时设置该参数不生效。 # MediaTypeEnhancementConfig ```java public class com.ss.bytertc.engine.type.MediaTypeEnhancementConfig ``` 蜂窝网络辅助增强应用的媒体模式 ## 成员变量 | 类型 | 名称 | | --- | --- | | boolean | [enhanceSignaling](#MediaTypeEnhancementConfig-enhancesignaling) | | boolean | [enhanceAudio](#MediaTypeEnhancementConfig-enhanceaudio) | | boolean | [enhanceVideo](#MediaTypeEnhancementConfig-enhancevideo) | | boolean | [enhanceScreenAudio](#MediaTypeEnhancementConfig-enhancescreenaudio) | | boolean | [enhanceScreenVideo](#MediaTypeEnhancementConfig-enhancescreenvideo) | ## 变量说明 ### enhanceSignaling ```java public boolean com.ss.bytertc.engine.type.MediaTypeEnhancementConfig.enhanceSignaling = false ``` 对信令消息，是否启用蜂窝网络辅助增强。默认不启用。 ### enhanceAudio ```java public boolean com.ss.bytertc.engine.type.MediaTypeEnhancementConfig.enhanceAudio = false ``` 对屏幕共享以外的其他音频，是否启用蜂窝网络辅助增强。默认不启用。 ### enhanceVideo ```java public boolean com.ss.bytertc.engine.type.MediaTypeEnhancementConfig.enhanceVideo = false ``` 对屏幕共享视频以外的其他视频，是否启用蜂窝网络辅助增强。默认不启用。 ### enhanceScreenAudio ```java public boolean com.ss.bytertc.engine.type.MediaTypeEnhancementConfig.enhanceScreenAudio = false ``` 对屏幕共享音频，是否启用蜂窝网络辅助增强。默认不启用。 ### enhanceScreenVideo ```java public boolean com.ss.bytertc.engine.type.MediaTypeEnhancementConfig.enhanceScreenVideo = false ``` 对屏幕共享视频，是否启用蜂窝网络辅助增强。默认不启用。 # MirrorType ```java public enum com.ss.bytertc.engine.data.MirrorType ``` 镜像类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MIRROR_TYPE_NONE | 0 | 本地预览和编码传输时均无镜像效果 | | MIRROR_TYPE_RENDER | 1 | 本地预览时有镜像效果，编码传输时无镜像效果 | | MIRROR_TYPE_RENDER_AND_ENCODER | 3 | 本地预览和编码传输时均有镜像效果 | # CloudProxyInfo ```java public class com.ss.bytertc.engine.data.CloudProxyInfo ``` 云代理信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [cloudProxyIp](#CloudProxyInfo-cloudproxyip) | | int | [cloudProxyPort](#CloudProxyInfo-cloudproxyport) | ## 变量说明 ### cloudProxyIp ```java public String com.ss.bytertc.engine.data.CloudProxyInfo.cloudProxyIp ``` 云代理服务器 IP ### cloudProxyPort ```java public int com.ss.bytertc.engine.data.CloudProxyInfo.cloudProxyPort ``` 云代理服务器端口 # VideoEncoderConfig ```java public class com.ss.bytertc.engine.VideoEncoderConfig ``` 视频流参数描述 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#VideoEncoderConfig-width) | | int | [height](#VideoEncoderConfig-height) | | int | [frameRate](#VideoEncoderConfig-framerate) | | int | [maxBitrate](#VideoEncoderConfig-maxbitrate) | | int | [minBitrate](#VideoEncoderConfig-minbitrate) | | EncoderPreference | [encodePreference](#VideoEncoderConfig-encodepreference) | ## 变量说明 ### width ```java public int com.ss.bytertc.engine.VideoEncoderConfig.width ``` 视频宽度，单位：px ### height ```java public int com.ss.bytertc.engine.VideoEncoderConfig.height ``` 视频高度，单位：px ### frameRate ```java public int com.ss.bytertc.engine.VideoEncoderConfig.frameRate ``` 视频帧率，单位：fps ### maxBitrate ```java public int com.ss.bytertc.engine.VideoEncoderConfig.maxBitrate = -1 ``` 最大编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。设为 `-1` 即适配码率模式，系统将根据输入的分辨率和帧率自动计算适用的码率。设为 `0` 则不对视频流进行编码发送。 3.44.1 及以上版本，内部采集时默认值为 `-1`，3.44.1 以前版本无默认值，需手动设置。 ### minBitrate ```java public int com.ss.bytertc.engine.VideoEncoderConfig.minBitrate = 0 ``` 视频最小编码码率, 单位 kbps。编码码率不会低于 `minBitrate`。默认值为 `0`。范围：[0, maxBitrate)，当 `maxBitrate` < `minBitrate` 时，为适配码率模式。以下情况，设置本参数无效： - 当 `maxBitrate` 为 `0` 时，不对视频流进行编码发送。 - 当 `maxBitrate` < `0` 时，适配码率模式。 ### encodePreference ```java public EncoderPreference com.ss.bytertc.engine.VideoEncoderConfig.encodePreference = EncoderPreference.MAINTAIN_FRAMERATE ``` 编码策略偏好，默认为帧率优先。参看 [EncoderPreference](#EncoderPreference-3)。 # FirstFramePlayState ```java public enum com.ss.bytertc.engine.type.FirstFramePlayState ``` 首帧播放状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | FIRST_FRAME_PLAY_STATE_PLAYING | 0 | 播放中 | | FIRST_FRAME_PLAY_STATE_PLAYED | 1 | 播放成功 | | FIRST_FRAME_PLAY_STATE_END | 2 | 播放失败 | # RemoteVideoSinkConfig ```java public class com.ss.bytertc.engine.video.RemoteVideoSinkConfig ``` 远端视频帧回调配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | RemoteVideoRenderPosition | [position](#RemoteVideoSinkConfig-position) | | int | [pixelFormat](#RemoteVideoSinkConfig-pixelformat) | | VideoApplyRotation | [applyRotation](#RemoteVideoSinkConfig-applyrotation) | | VideoRenderMirrorType | [mirrorType](#RemoteVideoSinkConfig-mirrortype) | ## 变量说明 ### position ```java public RemoteVideoRenderPosition com.ss.bytertc.engine.video.RemoteVideoSinkConfig.position = RemoteVideoRenderPosition.AFTER_POST_PROCESS ``` 远端视频帧回调位置，参看 [RemoteVideoRenderPosition](#RemoteVideoRenderPosition)，默认回调后处理后的视频帧。 ### pixelFormat ```java public int com.ss.bytertc.engine.video.RemoteVideoSinkConfig.pixelFormat = 0 ``` 远端视频帧回调格式，参看 [VideoPixelFormat](#VideoPixelFormat)，默认值为 0。 ### applyRotation ```java public VideoApplyRotation com.ss.bytertc.engine.video.RemoteVideoSinkConfig.applyRotation = VideoApplyRotation.DEFAULT ``` 是否将视频帧自动转正，参看 [VideoApplyRotation](#VideoApplyRotation)，默认为不旋转。 ### mirrorType ```java public VideoRenderMirrorType com.ss.bytertc.engine.video.RemoteVideoSinkConfig.mirrorType = VideoRenderMirrorType.OFF ``` 是否将视频帧镜像。参看 [VideoRenderMirrorType](#VideoRenderMirrorType)，默认为不镜像。本设置与 [setRemoteVideoMirrorType](70080#RTCVideo-setremotevideomirrortype)（适用于内部渲染）相互独立。 # AnsMode ```java public enum com.ss.bytertc.engine.type.AnsMode ``` 降噪模式。降噪算法受调用 [joinRoom](70080#RTCRoom-joinroom) 时设置的房间模式影响。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ANS_MODE_DISABLE | 0 | 关闭所有音频降噪能力。 | | ANS_MODE_LOW | 1 | 适用于微弱降噪。 | | ANS_MODE_MEDIUM | 2 | 适用于抑制中度平稳噪声，如空调声和风扇声。 | | ANS_MODE_HIGH | 3 | 适用于抑制嘈杂非平稳噪声，如键盘声、敲击声、碰撞声、动物叫声。 | | ANS_MODE_AUTOMATIC | 4 | 启用音频降噪能力。具体的降噪算法由 RTC 智能决策。 | # LocalAudioStreamState ```java public enum com.ss.bytertc.engine.data.LocalAudioStreamState ``` 本地音频流状态。 SDK 通过 onLocalAudioStateChanged 回调该状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | LOCAL_AUDIO_STREAM_STATE_STOPPED | 0 | 本地音频默认初始状态。
麦克风停止工作时回调该状态，对应错误码 [LocalAudioStreamError](#LocalAudioStreamError) 中的 kLocalAudioStreamErrorOk 。 | | LOCAL_AUDIO_STREAM_STATE_RECORDING | 1 | 本地音频录制设备启动成功。
采集到音频首帧时回调该状态，对应错误码 [LocalAudioStreamError](#LocalAudioStreamError) 中的 kLocalAudioStreamErrorOk 。 | | LOCAL_AUDIO_STREAM_STATE_ENCODING | 2 | 本地音频首帧编码成功。
音频首帧编码成功时回调该状态，对应错误码 [LocalAudioStreamError](#LocalAudioStreamError) 中的 kLocalAudioStreamErrorOk 。 | | LOCAL_AUDIO_STREAM_STATE_FAILED | 3 | 本地音频启动失败，在以下时机回调该状态：

本地录音设备启动失败，对应错误码 [LocalAudioStreamError](#LocalAudioStreamError) 中的 kLocalAudioStreamErrorRecordFailure 。

检测到没有录音设备权限，对应错误码 [LocalAudioStreamError](#LocalAudioStreamError) 中的 kLocalAudioStreamErrorDeviceNoPermission。

音频编码失败，对应错误码 [LocalAudioStreamError](#LocalAudioStreamError) 中的 kLocalAudioStreamErrorEncodeFailure。

| ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [value](#LocalAudioStreamState-value) | ## 函数说明 ### value ```java int com.ss.bytertc.engine.data.LocalAudioStreamState.value() ``` 获取当前值 **返回值** 当前值 # VideoFrameInfo ```java public class com.ss.bytertc.engine.data.VideoFrameInfo ``` 视频帧信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#VideoFrameInfo-width) | | int | [height](#VideoFrameInfo-height) | | VideoRotation | [rotation](#VideoFrameInfo-rotation) | ## 变量说明 ### width ```java public int com.ss.bytertc.engine.data.VideoFrameInfo.width = 0 ``` 宽（像素） ### height ```java public int com.ss.bytertc.engine.data.VideoFrameInfo.height = 0 ``` 高（像素） ### rotation ```java public VideoRotation com.ss.bytertc.engine.data.VideoFrameInfo.rotation = VideoRotation.VIDEO_ROTATION_0 ``` 视频帧顺时针旋转角度。参看 [VideoRotation](#VideoRotation)。 # EngineConfig ```java public class com.ss.bytertc.engine.data.EngineConfig ``` 引擎配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [ENGINE_CONFIG_VALID](#EngineConfig-engine_config_valid) | | int | [ENGINE_CONFIG_INVALID_APP_ID](#EngineConfig-engine_config_invalid_app_id) | | int | [ENGINE_CONFIG_INVALID_NATIVE_LIB_PATH](#EngineConfig-engine_config_invalid_native_lib_path) | | String | [appID](#EngineConfig-appid) | | Object | [eglContext](#EngineConfig-eglcontext) | | JSONObject | [parameters](#EngineConfig-parameters) | ## 变量说明 ### ENGINE_CONFIG_VALID ```java public static final int com.ss.bytertc.engine.data.EngineConfig.ENGINE_CONFIG_VALID = 0 ``` EngineConfig 有效 ### ENGINE_CONFIG_INVALID_APP_ID ```java public static final int com.ss.bytertc.engine.data.EngineConfig.ENGINE_CONFIG_INVALID_APP_ID = 1 ``` EngineConfig 无效，AppID 无效 ### ENGINE_CONFIG_INVALID_NATIVE_LIB_PATH ```java public static final int com.ss.bytertc.engine.data.EngineConfig.ENGINE_CONFIG_INVALID_NATIVE_LIB_PATH = 2 ``` EngineConfig 无效，nativeLoadPath 无效 ### appID ```java public String com.ss.bytertc.engine.data.EngineConfig.appID ``` 必填，每个应用的唯一标识符，由 RTC 控制台随机生成的。不同的 AppId 生成的实例在 RTC 中进行音视频通话完全独立，无法互通。 ### eglContext ```java public Object com.ss.bytertc.engine.data.EngineConfig.eglContext = null ``` 选填，如果需要支持外部纹理硬编码，则需要以 `JObject` 方式传入 `eglContext` ### parameters ```java public JSONObject com.ss.bytertc.engine.data.EngineConfig.parameters = null ``` 选填，私有参数。如需使用请联系技术支持人员。 # TranscoderClientMixVideoFormat ```java public enum com.ss.bytertc.engine.live.LiveTranscoding.TranscoderClientMixVideoFormat ``` 客户端合流回调视频格式。设置为系统不支持的格式时，自动回调系统默认格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | YUV_I420 | 0 | YUV I420。Android、Windows 默认回调格式。支持系统：Android、Windows。 | | TEXTURE_2D | 1 | OpenGL GL_TEXTURE_2D 格式纹理。支持系统：安卓。 | | CVPIXEL_BUFFER_BGRA | 2 | CVPixelBuffer BGRA。iOS 默认回调格式。支持系统: iOS。 | | YUV_NV12 | 3 | YUV NV12。macOS 默认回调格式。支持系统: macOS。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [getValue](#TranscoderClientMixVideoFormat-getvalue) | ## 函数说明 ### getValue ```java int com.ss.bytertc.engine.live.LiveTranscoding.TranscoderClientMixVideoFormat.getValue() ``` 获取合流输出内容类型。 **返回值** 合流输出内容类型 # VideoConfig ```java public static class com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig ``` 视频转码配置参数。值不合法或未设置时，自动使用默认值。 ## 成员函数 | 返回 | 名称 | | --- | --- | | VideoConfig | [setCodec](#VideoConfig-setcodec) | | VideoConfig | [setFps](#VideoConfig-setfps) | | VideoConfig | [setGop](#VideoConfig-setgop) | | VideoConfig | [setBFrame](#VideoConfig-setbframe) | | VideoConfig | [setKBitRate](#VideoConfig-setkbitrate) | | VideoConfig | [setWidth](#VideoConfig-setwidth) | | VideoConfig | [setHeight](#VideoConfig-setheight) | ## 函数说明 ### setCodec ```java VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setCodec(VideoCodecType codec) ``` 设置视频编码格式。本参数不支持过程中更新。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | codec | VideoCodecType | 视频编码格式，参看 [VideoCodecType](#VideoCodecType)。默认值为 `VIDEO_CODEC_TYPE_H264("H264")`。 | ### setFps ```java VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setFps(int fps) ``` 设置合流视频帧率。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | fps | int | 合流视频帧率。单位为 FPS，取值范围为 [1,60]，默认值为 15 FPS。 | ### setGop ```java VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setGop(int gop) ``` 设置视频 I 帧时间间隔。本参数不支持过程中更新。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | gop | int | 视频 I 帧时间间隔。单位为秒，取值范围为 [1, 5]，默认值为 2 秒。 | ### setBFrame ```java VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setBFrame(boolean useBFrame) ``` 设置是否使用 B 帧（仅在服务端合流生效）。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | useBFrame | boolean | 是否使用 B 帧。取值含义如下:

true: 使用 B 帧
false: 不使用 B 帧

| ### setKBitRate ```java VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setKBitRate(int kBitRate) ``` 设置合流视频码率。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | kBitRate | int | 合流视频码率。单位为 Kbps，取值范围为 [1,10000]，默认值为自适应模式。 | ### setWidth ```java VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setWidth(int width) ``` 设置合流视频宽度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | int | 合流视频宽度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 640 px。
设置值为非偶数时，自动向上取偶数。 | ### setHeight ```java VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setHeight(int height) ``` 设置合流视频高度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | height | int | 合流视频高度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 360 px。
设置值为非偶数时，自动向上取偶数。 | # RemoteStreamSwitch ```java public class com.ss.bytertc.engine.type.RemoteStreamSwitch ``` 流切换信息。本地用户订阅的远端流触发回退策略时的流切换信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [uid](#RemoteStreamSwitch-uid) | | boolean | [isScreen](#RemoteStreamSwitch-isscreen) | | int | [beforeVideoIndex](#RemoteStreamSwitch-beforevideoindex) | | int | [afterVideoIndex](#RemoteStreamSwitch-aftervideoindex) | | boolean | [beforeEnable](#RemoteStreamSwitch-beforeenable) | | boolean | [afterEnable](#RemoteStreamSwitch-afterenable) | | FallbackOrRecoverReason | [reason](#RemoteStreamSwitch-reason) | ## 变量说明 ### uid ```java public String com.ss.bytertc.engine.type.RemoteStreamSwitch.uid ``` 订阅的音视频流的发布者的用户 ID ### isScreen ```java public boolean com.ss.bytertc.engine.type.RemoteStreamSwitch.isScreen ``` 是否是屏幕共享流 ### beforeVideoIndex ```java public int com.ss.bytertc.engine.type.RemoteStreamSwitch.beforeVideoIndex ``` 流切换前订阅视频流的分辨率对应的索引 ### afterVideoIndex ```java public int com.ss.bytertc.engine.type.RemoteStreamSwitch.afterVideoIndex ``` 流切换后订阅视频流的分辨率对应的索引 ### beforeEnable ```java public boolean com.ss.bytertc.engine.type.RemoteStreamSwitch.beforeEnable ``` 流切换前是否有视频流 ### afterEnable ```java public boolean com.ss.bytertc.engine.type.RemoteStreamSwitch.afterEnable ``` 流切换后是否有视频流 ### reason ```java public FallbackOrRecoverReason com.ss.bytertc.engine.type.RemoteStreamSwitch.reason ``` 流切换原因，详见类型 [FallbackOrRecoverReason](#FallbackOrRecoverReason)。 # MixedStreamSpatialConfig ```java public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig ``` 推流 CDN 的空间音频参数。 ## 成员函数 | 返回 | 名称 | | --- | --- | | MixedStreamSpatialConfig | [setAudienceSpatialPosition](#MixedStreamSpatialConfig-setaudiencespatialposition-2) | | Position | [getAudienceSpatialPosition](#MixedStreamSpatialConfig-getaudiencespatialposition) | | MixedStreamSpatialConfig | [setAudienceSpatialOrientation](#MixedStreamSpatialConfig-setaudiencespatialorientation) | | HumanOrientation | [getAudienceSpatialOrientation](#MixedStreamSpatialConfig-getaudiencespatialorientation) | | MixedStreamSpatialConfig | [setEnableSpatialRender](#MixedStreamSpatialConfig-setenablespatialrender) | | boolean | [getEnableSpatialRender](#MixedStreamSpatialConfig-getenablespatialrender) | ## 函数说明 ### setAudienceSpatialPosition ```java MixedStreamSpatialConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.setAudienceSpatialPosition(Position pos) ``` 设置听众的空间位置。听众指收听来自 CDN 的音频流的用户。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | pos | Position | 听众的空间位置，参看 [Position](#Position)。 | ### getAudienceSpatialPosition ```java Position com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.getAudienceSpatialPosition() ``` 获取听众的空间位置。 ### setAudienceSpatialOrientation ```java MixedStreamSpatialConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.setAudienceSpatialOrientation(HumanOrientation orientation) ``` 设置听众的空间朝向。听众指收听来自 CDN 的音频流的用户。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | orientation | HumanOrientation | 听众的空间朝向。参看 [HumanOrientation](#HumanOrientation)。 | ### getAudienceSpatialOrientation ```java HumanOrientation com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.getAudienceSpatialOrientation() ``` 获取听众的空间朝向。 ### setEnableSpatialRender ```java MixedStreamSpatialConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.setEnableSpatialRender(boolean enableSpatialRender) ``` 设置是否开启推流 CDN 时的空间音频效果。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enableSpatialRender | boolean | 是否开启推流 CDN 时的空间音频效果：

true：开启；
false：关闭。

| **注意** 当你启用此效果时，你需要设定推流中各个 MixedStreamSpatialConfig 的 `Position` 值，实现空间音频效果。 ### getEnableSpatialRender ```java boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.getEnableSpatialRender() ``` 获取是否开启推流 CDN 空间音频效果的设置。 # VideoCanvas ```java public class com.ss.bytertc.engine.VideoCanvas ``` 视频帧渲染设置 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [RENDER_MODE_HIDDEN](#VideoCanvas-render_mode_hidden) | | int | [RENDER_MODE_FIT](#VideoCanvas-render_mode_fit) | | int | [RENDER_MODE_FILL](#VideoCanvas-render_mode_fill) | | View | [renderView](#VideoCanvas-renderview) | | Surface | [renderSurface](#VideoCanvas-rendersurface) | | int | [renderMode](#VideoCanvas-rendermode) | | int | [backgroundColor](#VideoCanvas-backgroundcolor) | | VideoRotation | [renderRotation](#VideoCanvas-renderrotation) | ## 变量说明 ### RENDER_MODE_HIDDEN ```java public static final int com.ss.bytertc.engine.VideoCanvas.RENDER_MODE_HIDDEN = 1 ``` 视窗填满优先，默认值。视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长大于等于视窗对应边长。 ### RENDER_MODE_FIT ```java public static final int com.ss.bytertc.engine.VideoCanvas.RENDER_MODE_FIT = 2 ``` 视频帧内容全部显示优先。视频帧等比缩放，直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同，视窗上未被视频帧填满区域将填充 `background_color`。缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长小于等于视窗对应边长。 ### RENDER_MODE_FILL ```java public static final int com.ss.bytertc.engine.VideoCanvas.RENDER_MODE_FILL = 3 ``` 视频帧自适应画布。视频帧非等比缩放，直至画布被填满。在此过程中，视频帧的长宽比例可能会发生变化。 ### renderView ```java public View com.ss.bytertc.engine.VideoCanvas.renderView ``` 本地视图句柄。渲染 View 对象时，使用此字段，并将 `renderSurface` 设置为 `null`。 ### renderSurface ```java public Surface com.ss.bytertc.engine.VideoCanvas.renderSurface ``` 本地 surface 句柄。渲染 Surface 对象时，使用此字段，并将 `renderView` 设置为 `null`。 ### renderMode ```java public int com.ss.bytertc.engine.VideoCanvas.renderMode ``` 渲染模式，可选 `RENDER_MODE_HIDDEN(1)`, `RENDER_MODE_FIT(2)` 和 `RENDER_MODE_FILL(3)`。默认值为 `RENDER_MODE_HIDDEN(1)`。 ### backgroundColor ```java public int com.ss.bytertc.engine.VideoCanvas.backgroundColor ``` 用于填充画布空白部分的背景颜色。取值范围是 `[0x00000000, 0xFFFFFFFF]`。默认值是 `0x00000000`。其中，透明度设置无效。 ### renderRotation ```java public VideoRotation com.ss.bytertc.engine.VideoCanvas.renderRotation ``` 设置接收到的远端视频帧在本端渲染时的旋转角度。参看 [VideoRotation](#VideoRotation)。默认为 0 度，即不做旋转处理。该设置仅对远端视频有效，对本地视频设置不生效。 # RemoteVideoStats ```java public class com.ss.bytertc.engine.type.RemoteVideoStats ``` 远端视频流统计信息，统计周期为 2s 。本地用户订阅远端视频流成功后，SDK 会周期性地通过 `onRemoteStreamStats` 通知本地用户订阅的远端视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#RemoteVideoStats-width) | | int | [height](#RemoteVideoStats-height) | | float | [videoLossRate](#RemoteVideoStats-videolossrate) | | float | [receivedKBitrate](#RemoteVideoStats-receivedkbitrate) | | int | [decoderOutputFrameRate](#RemoteVideoStats-decoderoutputframerate) | | int | [rendererOutputFrameRate](#RemoteVideoStats-rendereroutputframerate) | | int | [stallCount](#RemoteVideoStats-stallcount) | | int | [stallDuration](#RemoteVideoStats-stallduration) | | long | [e2eDelay](#RemoteVideoStats-e2edelay) | | boolean | [isScreen](#RemoteVideoStats-isscreen) | | int | [statsInterval](#RemoteVideoStats-statsinterval) | | int | [rtt](#RemoteVideoStats-rtt) | | int | [frozenRate](#RemoteVideoStats-frozenrate) | | int | [codecType](#RemoteVideoStats-codectype) | | int | [videoIndex](#RemoteVideoStats-videoindex) | | int | [jitter](#RemoteVideoStats-jitter) | ## 变量说明 ### width ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.width ``` 远端视频流宽度 ### height ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.height ``` 远端视频流高度 ### videoLossRate ```java public float com.ss.bytertc.engine.type.RemoteVideoStats.videoLossRate ``` 视频丢包率。统计周期内的视频下行丢包率，取值范围为 [0，1] 。 ### receivedKBitrate ```java public float com.ss.bytertc.engine.type.RemoteVideoStats.receivedKBitrate ``` 接收码率。统计周期内的视频接收码率，单位为 kbps 。 ### decoderOutputFrameRate ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.decoderOutputFrameRate ``` 解码器输出帧率。统计周期内的视频解码器输出帧率，单位 fps 。 ### rendererOutputFrameRate ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.rendererOutputFrameRate ``` 渲染帧率。统计周期内的视频渲染帧率，单位 fps 。 ### stallCount ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.stallCount ``` 卡顿次数。统计周期内的卡顿次数。 ### stallDuration ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.stallDuration ``` 卡顿时长。统计周期内的视频卡顿总时长。单位 ms 。 ### e2eDelay ```java public long com.ss.bytertc.engine.type.RemoteVideoStats.e2eDelay ``` 用户体验级别的端到端延时，从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为毫秒 ### isScreen ```java public boolean com.ss.bytertc.engine.type.RemoteVideoStats.isScreen ``` 所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。 ### statsInterval ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.statsInterval ``` 统计间隔，此次统计周期的间隔，单位为 ms 。此字段用于设置回调的统计周期，目前设置为 2s 。 ### rtt ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.rtt ``` 往返时延，单位为 ms 。 ### frozenRate ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.frozenRate ``` 远端用户在进房后发生视频卡顿的累计时长占视频总有效时长的百分比（%）。视频有效时长是指远端用户进房发布视频流后，除停止发送视频流和禁用视频模块之外的视频时长。 ### codecType ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.codecType ``` 视频的编码类型，具体参考 [VideoCodecType](#VideoCodecType)。 ### videoIndex ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.videoIndex ``` 对应多种分辨率的流的下标。 ### jitter ```java public int com.ss.bytertc.engine.type.RemoteVideoStats.jitter ``` 视频下行网络抖动，单位为 ms。 # VideoApplyRotation ```java public enum com.ss.bytertc.engine.video.VideoApplyRotation ``` 是否将视频帧自动转正。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | DEFAULT | -1 | （默认值）不旋转。 | | DEGREE_0 | 0 | 自动转正视频，即根据视频帧的旋转角信息将视频帧旋转到 0 度。 | # VideoDeviceInfo ```java public class com.ss.bytertc.engine.video.VideoDeviceInfo ``` > Available since 3.56 视频设备信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [deviceId](#VideoDeviceInfo-deviceid) | | String | [deviceName](#VideoDeviceInfo-devicename) | | VideoDeviceFacing | [deviceFacing](#VideoDeviceInfo-devicefacing) | ## 变量说明 ### deviceId ```java public String com.ss.bytertc.engine.video.VideoDeviceInfo.deviceId ``` 设备 ID ### deviceName ```java public String com.ss.bytertc.engine.video.VideoDeviceInfo.deviceName ``` 设备名称 ### deviceFacing ```java public VideoDeviceFacing com.ss.bytertc.engine.video.VideoDeviceInfo.deviceFacing ``` 视频设备朝向信息，参看 [VideoDeviceFacing](#VideoDeviceFacing)。 # IVideoSink ```java public interface com.ss.bytertc.engine.video.IVideoSink ``` 自定义视频渲染器。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onFrame](#IVideoSink-onframe) | | int | [getRenderElapse](#IVideoSink-getrenderelapse) | ## 函数说明 ### onFrame ```java void com.ss.bytertc.engine.video.IVideoSink.onFrame(VideoFrame frame) ``` 视频帧回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | frame | VideoFrame | 视频帧结构类，参看 [VideoFrame](#VideoFrame) | ### getRenderElapse ```java int com.ss.bytertc.engine.video.IVideoSink.getRenderElapse() ``` 获取外部渲染耗时。 **返回值** 外部渲染平均耗时，单位：毫秒 # VideoRotation ```java public enum com.ss.bytertc.engine.data.VideoRotation ``` 视频帧旋转角度 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | VIDEO_ROTATION_0 | 0 | 顺时针旋转 0 度 | | VIDEO_ROTATION_90 | 90 | 顺时针旋转 90 度 | | VIDEO_ROTATION_180 | 180 | 顺时针旋转 180 度 | | VIDEO_ROTATION_270 | 270 | 顺时针旋转 270 度 | # OrientationMode ```java public static enum com.ss.bytertc.engine.video.VideoEncoderConfiguration.OrientationMode ``` 视频编码的方向模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ORIENTATION_MODE_ADAPTIVE | 0 | 视频输出方向与采集方向一致。 | | ORIENTATION_MODE_FIXED_LANDSCAPE | 1 | 固定横屏输出视频。若采集到的视频是竖屏模式，则视频编码器会对其进行裁剪。 | | ORIENTATION_MODE_FIXED_PORTRAIT | 2 | 固定竖屏输出视频。若采集到的视频是横屏模式，则视频编码器会对其进行裁剪。 | # LocalVideoSinkConfig ```java public class com.ss.bytertc.engine.video.LocalVideoSinkConfig ``` 本地视频帧回调配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | LocalVideoRenderPosition | [position](#LocalVideoSinkConfig-position) | | int | [pixelFormat](#LocalVideoSinkConfig-pixelformat) | ## 变量说明 ### position ```java public LocalVideoRenderPosition com.ss.bytertc.engine.video.LocalVideoSinkConfig.position = LocalVideoRenderPosition.AFTER_CAPTURE ``` 本地视频帧回调位置，参看 [LocalVideoRenderPosition](#LocalVideoRenderPosition)，默认回调前处理后的视频帧。 ### pixelFormat ```java public int com.ss.bytertc.engine.video.LocalVideoSinkConfig.pixelFormat = 0 ``` 本地视频帧回调格式，参看 [VideoPixelFormat](#VideoPixelFormat)，默认值为 0。 # RecordingProgress ```java public class com.ss.bytertc.engine.data.RecordingProgress ``` 本地录制进度 ## 成员变量 | 类型 | 名称 | | --- | --- | | long | [duration](#RecordingProgress-duration) | | long | [fileSize](#RecordingProgress-filesize) | ## 变量说明 ### duration ```java public long com.ss.bytertc.engine.data.RecordingProgress.duration ``` 当前文件的累计录制时长，单位：毫秒 ### fileSize ```java public long com.ss.bytertc.engine.data.RecordingProgress.fileSize ``` 当前录制文件的大小，单位：byte # RemoteUserPriority ```java public enum com.ss.bytertc.engine.type.RemoteUserPriority ``` 远端用户优先级，在性能不足需要回退时，会优先回退优先级低的用户的音视频流。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | REMOTE_USER_PRIORITY_LOW | 0 | 用户优先级为低，默认值。 | | REMOTE_USER_PRIORITY_MEDIUM | 100 | 用户优先级为正常。 | | REMOTE_USER_PRIORITY_HIGH | 200 | 用户优先级为高。 | # LocalVideoStreamState ```java public enum com.ss.bytertc.engine.type.LocalVideoStreamState ``` 本地视频流状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | LOCAL_VIDEO_STREAM_STATE_STOPPED | 0 | 本地视频采集停止状态（默认初始状态）
本地视频采集关闭时回调该状态，对应错误码 [LocalVideoStreamError](#LocalVideoStreamError) 中的 `LOCAL_VIDEO_STREAM_ERROR_OK` | | LOCAL_VIDEO_STREAM_STATE_RECORDING | 1 | 本地视频采集设备启动成功
本地视频采集开启时回调该状态，对应错误码 [LocalVideoStreamError](#LocalVideoStreamError) 中的 `LOCAL_VIDEO_STREAM_ERROR_OK` | | LOCAL_VIDEO_STREAM_STATE_ENCODING | 2 | 本地视频采集后，首帧编码成功
本地视频首帧编码成功时回调该状态，对应错误码 [LocalVideoStreamError](#LocalVideoStreamError) 中的 `LOCAL_VIDEO_STREAM_ERROR_OK` | | LOCAL_VIDEO_STREAM_STATE_FAILED | 3 | 本地视频启动失败

本地视频采集设备启动失败，对应错误码 [LocalVideoStreamError](#LocalVideoStreamError) 中的 `LOCAL_VIDEO_STREAM_ERROR_FAILURE`

检测到没有视频采集设备权限，对应错误码 [LocalVideoStreamError](#LocalVideoStreamError) 中的 `LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION`

视频编码失败，对应错误码 [LocalVideoStreamError](#LocalVideoStreamError) 中的 `LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE`

| # RenderError ```java public enum com.ss.bytertc.engine.type.RenderError ``` 渲染错误码 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | RENDER_ERROR_OK | 0 | 渲染正常 | | RENDER_ERROR_USING_INTERNAL_SURFACE | -1 | Android 外部直显时使用了内部 surface | | RENDER_ERROR_USING_SOFTWARE_DECODER | -2 | 设置 Android 外部直显时使用软解 | # ExpressionDetectInfo ```java public class com.ss.bytertc.engine.video.ExpressionDetectInfo ``` 人像属性检测信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [age](#ExpressionDetectInfo-age) | | float | [boyProb](#ExpressionDetectInfo-boyprob) | | float | [attractive](#ExpressionDetectInfo-attractive) | | float | [happyScore](#ExpressionDetectInfo-happyscore) | | float | [sadScore](#ExpressionDetectInfo-sadscore) | | float | [angryScore](#ExpressionDetectInfo-angryscore) | | float | [surpriseScore](#ExpressionDetectInfo-surprisescore) | | float | [arousal](#ExpressionDetectInfo-arousal) | | float | [valence](#ExpressionDetectInfo-valence) | ## 变量说明 ### age ```java public float com.ss.bytertc.engine.video.ExpressionDetectInfo.age ``` 预测年龄，取值范围 (0, 100)。 ### boyProb ```java public float com.ss.bytertc.engine.video.ExpressionDetectInfo.boyProb ``` 预测为男性的概率，取值范围 (0.0, 1.0)。 ### attractive ```java public float com.ss.bytertc.engine.video.ExpressionDetectInfo.attractive ``` 预测的吸引力分数，取值范围 (0, 100)。 ### happyScore ```java public float com.ss.bytertc.engine.video.ExpressionDetectInfo.happyScore ``` 预测的微笑程度，取值范围 (0, 100)。 ### sadScore ```java public float com.ss.bytertc.engine.video.ExpressionDetectInfo.sadScore ``` 预测的伤心程度，取值范围 (0, 100)。 ### angryScore ```java public float com.ss.bytertc.engine.video.ExpressionDetectInfo.angryScore ``` 预测的生气程度，取值范围 (0, 100)。 ### surpriseScore ```java public float com.ss.bytertc.engine.video.ExpressionDetectInfo.surpriseScore ``` 预测的吃惊程度，取值范围 (0, 100)。 ### arousal ```java public float com.ss.bytertc.engine.video.ExpressionDetectInfo.arousal ``` 预测的情绪激动程度，取值范围 (0, 100)。 ### valence ```java public float com.ss.bytertc.engine.video.ExpressionDetectInfo.valence ``` 预测的情绪正负程度，取值范围 (-100, 100)。 # RemoteAudioState ```java public enum com.ss.bytertc.engine.data.RemoteAudioState ``` 用户订阅的远端音频流状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | REMOTE_AUDIO_STATE_STOPPED | 0 | 远端音频流默认初始状态，在以下时机回调该状态：

本地用户停止接收远端音频流，对应原因是 [RemoteAudioStateChangeReason](#RemoteAudioStateChangeReason) 中的 `kRemoteAudioReasonLocalMuted`

远端用户停止发送音频流，对应原因是 [RemoteAudioStateChangeReason](#RemoteAudioStateChangeReason) 中的 `kRemoteAudioReasonRemoteMuted`

远端用户离开房间，对应原因是 [RemoteAudioStateChangeReason](#RemoteAudioStateChangeReason) 中的 `kRemoteAudioReasonRemoteOffline`

成功解码远端音频首帧，对应原因是 [RemoteAudioStateChangeReason](#RemoteAudioStateChangeReason) 中的 `kRemoteAudioReasonLocalUnmuted`

网络由阻塞恢复正常，对应原因是 [RemoteAudioStateChangeReason](#RemoteAudioStateChangeReason) 中的 `kRemoteAudioReasonNetworkRecovery`

本地用户恢复接收远端音频流，对应原因是 [RemoteAudioStateChangeReason](#RemoteAudioStateChangeReason) 中的 `kRemoteAudioReasonLocalUnmuted`

远端用户恢复发送音频流，对应原因是 [RemoteAudioStateChangeReason](#RemoteAudioStateChangeReason) 中的 `kRemoteAudioReasonRemoteUnmuted`

| | REMOTE_AUDIO_STATE_FROZEN | 3 | 远端音频流卡顿。
网络阻塞导致丢包率大于 40% 时回调该状态，对应原因是 [
RemoteAudioStateChangeReason](#RemoteAudioStateChangeReason) 中的 `kRemoteAudioReasonNetworkCongestion` | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [value](#RemoteAudioState-value) | ## 函数说明 ### value ```java int com.ss.bytertc.engine.data.RemoteAudioState.value() ``` 获取当前值 **返回值** 当前值 # FrameUpdateInfo ```java public class com.ss.bytertc.engine.data.FrameUpdateInfo ``` RTC 智能决策后得到的帧率和分辨率积（宽*高）。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [pixel](#FrameUpdateInfo-pixel) | | int | [frameRate](#FrameUpdateInfo-framerate) | ## 变量说明 ### pixel ```java public int com.ss.bytertc.engine.data.FrameUpdateInfo.pixel ``` 分辨率积（宽*高）。 ### frameRate ```java public int com.ss.bytertc.engine.data.FrameUpdateInfo.frameRate ``` 帧率。 # AudioPropertiesConfig ```java public class com.ss.bytertc.engine.data.AudioPropertiesConfig ``` 音频属性信息提示的相关配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [interval](#AudioPropertiesConfig-interval) | | boolean | [enableSpectrum](#AudioPropertiesConfig-enablespectrum) | | boolean | [enableVad](#AudioPropertiesConfig-enablevad) | | AudioReportMode | [localMainReportMode](#AudioPropertiesConfig-localmainreportmode) | | AudioPropertiesMode | [audioReportMode](#AudioPropertiesConfig-audioreportmode) | | float | [smooth](#AudioPropertiesConfig-smooth) | | boolean | [enableVoicePitch](#AudioPropertiesConfig-enablevoicepitch) | ## 变量说明 ### interval ```java public int com.ss.bytertc.engine.data.AudioPropertiesConfig.interval ``` 信息提示间隔，单位：ms - `<= 0`: 关闭信息提示 - `(0,100]`: 开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms - `> 100`: 开启信息提示，并将信息提示间隔设置为此值 ### enableSpectrum ```java public boolean com.ss.bytertc.engine.data.AudioPropertiesConfig.enableSpectrum = false ``` 是否开启音频频谱检测 ### enableVad ```java public boolean com.ss.bytertc.engine.data.AudioPropertiesConfig.enableVad = false ``` 是否开启人声检测 (VAD) ### localMainReportMode ```java public AudioReportMode com.ss.bytertc.engine.data.AudioPropertiesConfig.localMainReportMode = AudioReportMode.AUDIO_REPORT_MODE_NORMAL ``` 音量回调模式。详见 [AudioReportMode](#AudioReportMode)。 ### audioReportMode ```java public AudioPropertiesMode com.ss.bytertc.engine.data.AudioPropertiesConfig.audioReportMode = AudioPropertiesMode.AUDIO_PROPERTIES_MODE_MICROPHONE ``` [onLocalAudioPropertiesReport](70081#IRTCVideoEventHandler-onlocalaudiopropertiesreport) 中包含音频数据的范围。参看 [AudioPropertiesMode](#AudioPropertiesMode)。默认仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据，不包含本地混音音频数据。 ### smooth ```java public float com.ss.bytertc.engine.data.AudioPropertiesConfig.smooth = 1.0f ``` 适用于音频属性信息提示的平滑系数。取值范围是 `(0.0, 1.0]`。默认值为 `1.0`，不开启平滑效果；值越小，提示音量平滑效果越明显。如果要开启平滑效果，可以设置为 `0.3`。 ### enableVoicePitch ```java public boolean com.ss.bytertc.engine.data.AudioPropertiesConfig.enableVoicePitch = false ``` 是否回调本地用户的人声基频。 # VideoPixelFormat ```java public enum com.ss.bytertc.engine.data.VideoPixelFormat ``` 视频帧的数据格式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | UNKNOWN | 0 | 未知格式 | | I420 | 1 | I420 格式 | | NV12 | 2 | NV12 格式 | | NV21 | 3 | NV21 格式 | | RGBA | 5 | RGBA 格式 | | TEXTURE_2D | GLES10.GL_TEXTURE_2D | Texture2D 格式 | | TEXTURE_OES | GLES11Ext.GL_TEXTURE_EXTERNAL_OES | TextureOES 格式 | # LocalProxyError ```java public enum com.ss.bytertc.engine.type.LocalProxyError ``` 本地代理错误。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | OK | 0 | 本地代理服务器无错误。 | | SOCKS5_VERSION_ERROR | 1 | 代理服务器回复的版本号不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。 | | SOCKS5_FORMAT_ERROR | 2 | 代理服务器回复的格式错误不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。 | | SOCKS5_INVALID_VALUE | 3 | 代理服务器回复的字段值不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。 | | SOCKS5_USER_PASS_NOT_GIVEN | 4 | 未提供代理服务器的用户名及密码，导致 Socks5 代理连接失败。请重新调用 `setLocalProxy`，在设置本地代理时填入用户名和密码。 | | SOCKS5_TCP_CLOSED | 5 | TCP 关闭，导致 Socks5 代理连接失败。请检查网络或者代理服务器是否存在异常。 | | HTTP_TUNNEL_FAILED | 6 | Http 隧道代理错误。请检查 Http 隧道代理服务器或者网络是否存在异常。 | # MediaStreamType ```java public enum com.ss.bytertc.engine.type.MediaStreamType ``` 媒体流类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | RTC_MEDIA_STREAM_TYPE_AUDIO | 1 | 只控制音频 | | RTC_MEDIA_STREAM_TYPE_VIDEO | 2 | 只控制视频 | | RTC_MEDIA_STREAM_TYPE_BOTH | 3 | 同时控制音频和视频 | # MediaDeviceState ```java public class com.ss.bytertc.engine.type.MediaDeviceState ``` 媒体设备状态通过 `onAudioDeviceStateChanged`/`onVideoDeviceStateChanged` 回调设备状态。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [MEDIA_DEVICE_STATE_STARTED](#MediaDeviceState-media_device_state_started) | | int | [MEDIA_DEVICE_STATE_STOPPED](#MediaDeviceState-media_device_state_stopped) | | int | [MEDIA_DEVICE_STATE_RUNTIMEERROR](#MediaDeviceState-media_device_state_runtimeerror) | | int | [MEDIA_DEVICE_STATE_ADDED](#MediaDeviceState-media_device_state_added) | | int | [MEDIA_DEVICE_STATE_REMOVED](#MediaDeviceState-media_device_state_removed) | | int | [MEDIA_DEVICE_STATE_INTERRUPTION_BEGAN](#MediaDeviceState-media_device_state_interruption_began) | | int | [MEDIA_DEVICE_STATE_INTERRUPTION_ENDED](#MediaDeviceState-media_device_state_interruption_ended) | ## 变量说明 ### MEDIA_DEVICE_STATE_STARTED ```java public static final int com.ss.bytertc.engine.type.MediaDeviceState.MEDIA_DEVICE_STATE_STARTED = 1 ``` 设备开启。 ### MEDIA_DEVICE_STATE_STOPPED ```java public static final int com.ss.bytertc.engine.type.MediaDeviceState.MEDIA_DEVICE_STATE_STOPPED = 2 ``` 设备停止。 ### MEDIA_DEVICE_STATE_RUNTIMEERROR ```java public static final int com.ss.bytertc.engine.type.MediaDeviceState.MEDIA_DEVICE_STATE_RUNTIMEERROR = 3 ``` 设备运行时错误。例如，当媒体设备的预期行为是正常采集，但没有收到采集数据时，将回调该状态。 ### MEDIA_DEVICE_STATE_ADDED ```java public static final int com.ss.bytertc.engine.type.MediaDeviceState.MEDIA_DEVICE_STATE_ADDED = 10 ``` 设备连接。 ### MEDIA_DEVICE_STATE_REMOVED ```java public static final int com.ss.bytertc.engine.type.MediaDeviceState.MEDIA_DEVICE_STATE_REMOVED = 11 ``` 设备移除。 ### MEDIA_DEVICE_STATE_INTERRUPTION_BEGAN ```java public static final int com.ss.bytertc.engine.type.MediaDeviceState.MEDIA_DEVICE_STATE_INTERRUPTION_BEGAN = 12 ``` 系统通话打断了音视频通话。将在通话结束后自动恢复。 ### MEDIA_DEVICE_STATE_INTERRUPTION_ENDED ```java public static final int com.ss.bytertc.engine.type.MediaDeviceState.MEDIA_DEVICE_STATE_INTERRUPTION_ENDED = 13 ``` 音视频通话已从系统电话中恢复。 # Region ```java static class com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region ``` 合成公共流的每条流的布局信息 ## 成员函数 | 返回 | 名称 | | --- | --- | | Region | [userId](#Region-userid) | | Region | [roomId](#Region-roomid-2) | | Region | [zorder](#Region-zorder-2) | | Region | [alpha](#Region-alpha-2) | | Region | [mediaType](#Region-mediatype) | | Region | [streamType](#Region-streamtype) | | Region | [renderMode](#Region-rendermode-2) | | Region | [position](#Region-position-2) | | Region | [size](#Region-size-2) | | Region | [sourceCropPosition](#Region-sourcecropposition) | | Region | [sourceCropSize](#Region-sourcecropsize) | ## 函数说明 ### userId ```java Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.userId(String uid) ``` 指定视频流所属用户的 ID。服务端将通过用户 ID 和房间 ID，找到需要合成到公共流中的媒体流。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 用户 ID。必填。 | **返回值** 当前流在公共流中的布局信息。详见 [Region](#region-2)。 ### roomId ```java Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.roomId(String roomId) ``` 设置媒体流所在房间的房间 ID。服务端将通过用户 ID 和房间 ID，找到需要合成到公共流中的媒体流。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomId | String | 必填。如果此媒体流是通过 [startForwardStreamToRooms](70080#RTCRoom-startforwardstreamtorooms) 转发到你所在房间的媒体流时，你应将房间 ID 设置为你所在的房间 ID。 | **返回值** 当前流在公共流中的布局信息。详见 [Region](#region-2)。 ### zorder ```java Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.zorder(int zorder) ``` 设置用户视频布局在画布中的层级。当前 Region 的位置与其他 Region 重合时，将按照此处设置的层级属性进行渲染。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | zorder | int | 用户视频布局在画布中的层级。取值范围为[0, 100]。0(默认）为底层，100 为顶层。 | **返回值** 当前流在公共流中的布局信息。详见 [Region](#region-2)。 ### alpha ```java Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.alpha(double alpha) ``` 设置透明度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | alpha | double | 透明度。必填。可选范围为 [0.0, 1.0]。 | **返回值** 当前流在公共流中的布局信息。详见 [Region](#region-2)。 ### mediaType ```java Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.mediaType(int mediaType) ``` 设置公共流内容类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mediaType | int | 公共流内容类型。默认值为 0，可选取值如下：

0: 输出的混流包含音视频
1: 只包含音频
2: 只包含视频

| **返回值** 当前流在公共流中的布局信息。详见 [Region](#region-2)。 ### streamType ```java Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.streamType(int streamType) ``` 设置公共流媒体类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamType | int | 公共流媒体类型。默认值为 0，可选取值如下：

0: 普通音视频流
1: 屏幕流

| **返回值** 当前流在公共流中的布局信息。详见 [Region](#region-2)。 ### renderMode ```java Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.renderMode(int renderMode) ``` 设置视频显示模式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | renderMode | int | 视频显示模式。可选取值如下：

1: 视频尺寸等比缩放，优先保证窗口被填满。当视频尺寸与显示窗口尺寸不一致时，多出的视频将被截掉。
2: 视频尺寸等比缩放，优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时，会把窗口未被填满的区域填充成黑色。
3: 视频尺寸非等比例缩放，把窗口充满。当视频尺寸与显示窗口尺寸不一致时，视频高或宽方向会被拉伸。

| **返回值** 当前流在公共流中的布局信息。详见 [Region](#region-2)。 ### position ```java Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.position( double x, double y ) ``` 设置用户视频布局的相对位置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | x | double | 视频流对应区域左上角的横坐标相对整体画面的比例，取值的范围为 [0.0, 1.0)。必填。 | | y | double | 视频流对应区域左上角的纵坐标相对整体画面的比例，取值的范围为 [0.0, 1.0)。必填。 | **返回值** 当前流在公共流中的布局信息。详见 [Region](#region-2)。 ### size ```java Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.size( double width, double height ) ``` 设置用户视频相对大小。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | double | 视频流对应区域宽度相对整体画面的比例，取值的范围为 (0.0, 1.0]。必填。 | | height | double | 视频流对应区域高度相对整体画面的比例，取值的范围为 (0.0, 1.0]。必填。 | **返回值** 当前流在公共流中的布局信息。详见 [Region](#region-2)。 ### sourceCropPosition ```java Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.sourceCropPosition( double x, double y ) ``` 设置用户视频布局的相对位置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | x | double | 裁剪后得到的视频帧左上角横坐标相对于裁剪前整体画面的比例，取值的范围为 [0.0, 1.0)。 | | y | double | 裁剪后得到的视频帧左上角纵坐标相对于裁剪前整体画面的比例，取值的范围为 [0.0, 1.0)。 | **返回值** 当前流在公共流中的布局信息。详见 [Region](#region-2)。 ### sourceCropSize ```java Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.sourceCropSize( double width, double height ) ``` 设置裁剪视频相对大小。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | double | 裁剪后得到的视频帧宽度相对于裁剪前整体画面的比例，取值的范围为 (0.0, 1.0]。 | | height | double | 裁剪后得到的视频帧高度相对于裁剪前整体画面的比例，取值的范围为 (0.0, 1.0]。 | **返回值** 当前流在公共流中的布局信息。详见 [Region](#region-2)。 # LocalProxyType ```java public enum com.ss.bytertc.engine.type.LocalProxyType ``` 本地代理的类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | SOCKS5 | 1 | Socks5 代理。选用此代理服务器，需满足 Socks5 协议标准文档的要求。 | | HTTP_TUNNEL | 2 | Http 隧道代理。 | # DivideModel ```java public enum com.ss.bytertc.engine.type.DivideModel ``` 分割模型。开启背景替换功能时生效，详见 [replaceBackground](70080#RTCVideo-replacebackground)。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | EFFECT | 0 | effect | | DEFAULT | 1 | 自研 | # PlayState ```java public enum com.ss.bytertc.ktv.data.PlayState ``` 音乐播放状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | PLAYING | 1 | 播放中。 | | PAUSED | 2 | 暂停中。 | | STOPPED | 3 | 已停止。 | | FAILED | 4 | 播放失败。 | | FINISHED | 5 | 播放结束。 | # VoiceReverbConfig ```java public class com.ss.bytertc.engine.type.VoiceReverbConfig ``` 音频混响效果。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [roomSize](#VoiceReverbConfig-roomsize) | | float | [decayTime](#VoiceReverbConfig-decaytime) | | float | [damping](#VoiceReverbConfig-damping) | | float | [wetGain](#VoiceReverbConfig-wetgain) | | float | [dryGain](#VoiceReverbConfig-drygain) | | float | [preDelay](#VoiceReverbConfig-predelay) | ## 变量说明 ### roomSize ```java public float com.ss.bytertc.engine.type.VoiceReverbConfig.roomSize = 50.0f ``` 混响模拟的房间大小，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。房间越大，混响越强。 ### decayTime ```java public float com.ss.bytertc.engine.type.VoiceReverbConfig.decayTime = 50.0f ``` 混响的拖尾长度，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。 ### damping ```java public float com.ss.bytertc.engine.type.VoiceReverbConfig.damping = 50.0f ``` 混响的衰减阻尼大小，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。 ### wetGain ```java public float com.ss.bytertc.engine.type.VoiceReverbConfig.wetGain = 0.0f ``` 早期反射信号强度。取值范围 `[-20.0, 10.0]`，单位为 dB。默认值为 `0.0f`。 ### dryGain ```java public float com.ss.bytertc.engine.type.VoiceReverbConfig.dryGain = 0.0f ``` 原始信号强度。取值范围 `[-20.0, 10.0]`，单位为 dB。默认值为 `0.0f`。 ### preDelay ```java public float com.ss.bytertc.engine.type.VoiceReverbConfig.preDelay = 0.0f ``` 早期反射信号的延迟。取值范围 `[0.0, 200.0]`，单位为 ms。默认值为 `0.0f`。 # AudioFrameType ```java public enum com.ss.bytertc.engine.data.AudioFrameType ``` 音频帧类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | FRAME_TYPE_PCM16 | 0 | PCM 16bit | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [value](#AudioFrameType-value) | ## 函数说明 ### value ```java int com.ss.bytertc.engine.data.AudioFrameType.value() ``` 获取当前值 **返回值** 当前值 # PushSingleStreamParam ```java public class com.ss.bytertc.engine.live.PushSingleStreamParam ``` 单流转推直播配置参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | String | [roomId](#PushSingleStreamParam-roomid) | | String | [userId](#PushSingleStreamParam-userid) | | String | [url](#PushSingleStreamParam-url) | | boolean | [isScreen](#PushSingleStreamParam-isscreen) | ## 变量说明 ### roomId ```java public String com.ss.bytertc.engine.live.PushSingleStreamParam.roomId ``` 媒体流所在的房间 ID ### userId ```java public String com.ss.bytertc.engine.live.PushSingleStreamParam.userId ``` 媒体流所属的用户 ID ### url ```java public String com.ss.bytertc.engine.live.PushSingleStreamParam.url ``` 推流 CDN 地址。仅支持 RTMP 协议，Url 必须满足正则 `/^rtmps?:\/\//`。本参数不支持过程中更新。 ### isScreen ```java public boolean com.ss.bytertc.engine.live.PushSingleStreamParam.isScreen = false ``` 媒体流是否为屏幕流。 # SubtitleState ```java public enum com.ss.bytertc.engine.type.SubtitleState ``` 字幕任务状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | SUBTITLE_STATE_STARTED | 0 | 开启字幕。 | | SUBTITLE_STATE_STOPED | 1 | 关闭字幕。 | | SUBTITLE_STATE_ERROR | 2 | 字幕任务出现错误。 | # RecordingFileType ```java public enum com.ss.bytertc.engine.type.RecordingFileType ``` 本地录制文件的存储格式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AAC | 0 | aac 格式文件 | | MP4 | 1 | mp4 格式文件 | # RTCNativeLibraryLoader ```java public interface com.ss.bytertc.engine.loader.RTCNativeLibraryLoader ``` 用户自定义动态库加载器实现 ## 成员函数 | 返回 | 名称 | | --- | --- | | boolean | [load](#RTCNativeLibraryLoader-load) | ## 函数说明 ### load ```java boolean com.ss.bytertc.engine.loader.RTCNativeLibraryLoader.load(String libraryName) ``` SDK 在需要加载动态库时通过该方法回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | libraryName | String | 要加载的动态库名称 | # ScreenMediaType ```java public enum com.ss.bytertc.engine.data.ScreenMediaType ``` 屏幕采集媒体类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | SCREEN_MEDIA_TYPE_VIDEO_ONLY | 0 | 仅采集视频 | | SCREEN_MEDIA_TYPE_AUDIO_ONLY | 1 | 仅采集音频 | | SCREEN_MEDIA_TYPE_VIDEO_AND_AUDIO | 2 | 采集音频和视频 | # RTCWatermarkConfig ```java public class com.ss.bytertc.engine.video.RTCWatermarkConfig ``` 水印参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | boolean | [visibleInPreview](#RTCWatermarkConfig-visibleinpreview) | | ByteWatermark | [positionInLandscapeMode](#RTCWatermarkConfig-positioninlandscapemode) | | ByteWatermark | [positionInPortraitMode](#RTCWatermarkConfig-positioninportraitmode) | ## 变量说明 ### visibleInPreview ```java public boolean com.ss.bytertc.engine.video.RTCWatermarkConfig.visibleInPreview = true ``` 水印是否在视频预览中可见，默认可见。 ### positionInLandscapeMode ```java public ByteWatermark com.ss.bytertc.engine.video.RTCWatermarkConfig.positionInLandscapeMode ``` 横屏时的水印位置和大小，参看 [ByteWatermark](#ByteWatermark)。 ### positionInPortraitMode ```java public ByteWatermark com.ss.bytertc.engine.video.RTCWatermarkConfig.positionInPortraitMode ``` 竖屏时的水印位置和大小，参看 [ByteWatermark](#ByteWatermark)。 # MixedStreamRenderMode ```java public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamRenderMode ``` 图片或视频流的缩放模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MIXED_STREAM_RENDER_MODE_HIDDEN | 1 | 视窗填满优先，默认值。
视频尺寸等比缩放，直至视窗被填满。当视频尺寸与显示窗口尺寸不一致时，多出的视频将被截掉。 | | MIXED_STREAM_RENDER_MODE_FIT | 2 | 视频帧内容全部显示优先。
视频尺寸等比缩放，优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时，会把窗口未被填满的区域填充成背景颜色。 | | MIXED_STREAM_RENDER_MODE_ADAPTIVE | 3 | 视频帧自适应画布。
视频尺寸非等比例缩放，把窗口充满。在此过程中，视频帧的长宽比例可能会发生变化。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [getValue](#MixedStreamRenderMode-getvalue) | ## 函数说明 ### getValue ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamRenderMode.getValue() ``` 获取视频内容的缩放模式。 **返回值** 视频内容的缩放模式。 # SubtitleConfig ```java public class com.ss.bytertc.engine.type.SubtitleConfig ``` 字幕配置信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | SubtitleMode | [mode](#SubtitleConfig-mode) | | String | [targetLanguage](#SubtitleConfig-targetlanguage) | ## 变量说明 ### mode ```java public SubtitleMode com.ss.bytertc.engine.type.SubtitleConfig.mode ``` 字幕模式。可以根据需要选择识别和翻译两种模式。开启识别模式，会将识别后的用户语音转化成文字；开启翻译模式，会在语音识别后进行翻译。参看 [SubtitleMode](#SubtitleMode)。 ### targetLanguage ```java public String com.ss.bytertc.engine.type.SubtitleConfig.targetLanguage = "" ``` 目标翻译语言。可点击 [语言支持](https://www.volcengine.com/docs/4640/35107) 查看翻译服务最新支持的语种信息。 # ClientMixParam ```java public static class com.ss.bytertc.engine.live.LiveTranscoding.ClientMixParam ``` 客户端合流参数。 ## 成员函数 | 返回 | 名称 | | --- | --- | | ClientMixParam | [setClientMixUseAudioMixer](#ClientMixParam-setclientmixuseaudiomixer) | | ClientMixParam | [setClientMixUseOriginalFrame](#ClientMixParam-setclientmixuseoriginalframe) | | void | [setClientMixVideoFormat](#ClientMixParam-setclientmixvideoformat) | ## 函数说明 ### setClientMixUseAudioMixer ```java ClientMixParam com.ss.bytertc.engine.live.LiveTranscoding.ClientMixParam.setClientMixUseAudioMixer(Boolean enable) ``` > Available since 3.50 设置客户端合流是否使用混音。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enable | Boolean | 是否使用混音，默认为 true。 | **返回值** 参看 [ClientMixParam](#LiveTranscoding-ClientMixParam)。 ### setClientMixUseOriginalFrame ```java ClientMixParam com.ss.bytertc.engine.live.LiveTranscoding.ClientMixParam.setClientMixUseOriginalFrame(Boolean enable) ``` > Available since 3.50 设置客户端合流是否使用原始视频帧。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enable | Boolean | 是否使用原始视频帧，默认为 false。 | **返回值** 参看 [ClientMixParam](#LiveTranscoding-ClientMixParam)。 ### setClientMixVideoFormat ```java void com.ss.bytertc.engine.live.LiveTranscoding.ClientMixParam.setClientMixVideoFormat(TranscoderClientMixVideoFormat format) ``` > Available since 3.50 设置客户端合流回调视频格式。设置为系统不支持的格式时，自动回调系统默认格式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | format | TranscoderClientMixVideoFormat | 客户端合流回调视频格式，参看 [TranscoderClientMixVideoFormat](#TranscoderClientMixVideoFormat)。 | # VirtualBackgroundSourceType ```java public enum com.ss.bytertc.engine.data.VirtualBackgroundSourceType ``` 虚拟背景类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | COLOR | 0 | 使用纯色背景替换视频原有背景。 | | IMAGE | 1 | 使用自定义图片背景替换视频原有背景。 | # AudioRenderType ```java public enum com.ss.bytertc.engine.data.AudioRenderType ``` 音频输出源类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_RENDER_TYPE_EXTERNAL | 0 | 自定义渲染 | | AUDIO_RENDER_TYPE_INTERNAL | 1 | 内部渲染 | # VideoDeviceFacing ```java public enum com.ss.bytertc.engine.type.VideoDeviceFacing ``` > Available since 3.56 视频设备朝向类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | FRONT | 0 | 前置摄像头 | | BACK | 1 | 后置摄像头 | | UNKNOWN | 2 | 未知类型 | # SubscribeFallbackOptions ```java public enum com.ss.bytertc.engine.type.SubscribeFallbackOptions ``` 订阅端音视频流回退选项。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | SUBSCRIBE_FALLBACK_OPTIONS_DISABLED | 0 | 下行网络不佳或设备性能不足时，不对音视频流作回退处理。默认设置。 | | SUBSCRIBE_FALLBACK_OPTIONS_STREAM_LOW | 1 | 下行网络不佳或设备性能不足时，对视频流做降级处理，具体降级规则参看[音视频流回退](70137)。
该设置仅对发布端调用 [enableSimulcastMode](70080#RTCVideo-enablesimulcastmode) 开启发送多路流功能的情况生效。 | | SUBSCRIBE_FALLBACK_OPTIONS_AUDIO_ONLY | 2 | 下行网络不佳或设备性能不足时，先对视频流做回退处理。当网络状况不满足接收弱流时，则自动取消接收视频，仅接收音频。
该设置仅对发布端调用 [enableSimulcastMode](70080#RTCVideo-enablesimulcastmode) 开启发送多路流功能的情况生效。 | ## 静态函数 | 返回 | 名称 | | --- | --- | | static SubscribeFallbackOptions | [fromId](#SubscribeFallbackOptions-fromid) | ## 函数说明 ### fromId ```java static SubscribeFallbackOptions com.ss.bytertc.engine.type.SubscribeFallbackOptions.fromId(int id) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | id | int | - | # MixedStreamAudioConfig ```java public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig ``` 音频转码配置参数。值不合法或未设置时，自动使用默认值。 ## 成员函数 | 返回 | 名称 | | --- | --- | | MixedStreamAudioConfig | [setChannels](#MixedStreamAudioConfig-setchannels) | | int | [getChannels](#MixedStreamAudioConfig-getchannels) | | MixedStreamAudioConfig | [setSampleRate](#MixedStreamAudioConfig-setsamplerate) | | int | [getSampleRate](#MixedStreamAudioConfig-getsamplerate) | | MixedStreamAudioConfig | [setBitrate](#MixedStreamAudioConfig-setbitrate) | | int | [getBitrate](#MixedStreamAudioConfig-getbitrate) | | MixedStreamAudioConfig | [setAudioCodec](#MixedStreamAudioConfig-setaudiocodec) | | MixedStreamAudioCodecType | [getAudioCodec](#MixedStreamAudioConfig-getaudiocodec) | | MixedStreamAudioConfig | [setAudioProfile](#MixedStreamAudioConfig-setaudioprofile) | | MixedStreamAudioProfile | [getAudioProfile](#MixedStreamAudioConfig-getaudioprofile) | ## 函数说明 ### setChannels ```java MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.setChannels(int channels) ``` 设置声道数。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | channels | int | 音频声道数。可取 1（单声道）、2（双声道），默认值为 2。 | ### getChannels ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.getChannels() ``` 获取声道数。 ### setSampleRate ```java MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.setSampleRate(int sampleRate) ``` 设置音频采样率。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | sampleRate | int | 音频采样率，单位 Hz。可取 32000 Hz、44100 Hz、48000 Hz，默认值为 48000 Hz。 | ### getSampleRate ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.getSampleRate() ``` 获取音频采样率。 ### setBitrate ```java MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.setBitrate(int bitrate) ``` 设置音频码率。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | bitrate | int | 音频码率，单位 Kbps。可取范围 [32, 192]，默认值为 64 Kbps。 | ### getBitrate ```java int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.getBitrate() ``` 获取音频码率。 ### setAudioCodec ```java MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.setAudioCodec(MixedStreamAudioCodecType audioCodec) ``` 设置音频编码格式。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioCodec | MixedStreamAudioCodecType | 音频编码格式，参看 [MixedStreamAudioCodecType](#MixedStreamAudioCodecType)。默认值为 `MIXED_STREAM_AUDIO_CODEC_TYPE_AAC("AAC")`。
本参数不支持过程中更新。 | ### getAudioCodec ```java MixedStreamAudioCodecType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.getAudioCodec() ``` 获取音频编码格式。 ### setAudioProfile ```java MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.setAudioProfile(MixedStreamAudioProfile audioProfile) ``` 设置 AAC 编码规格。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioProfile | MixedStreamAudioProfile | AAC 规格，参看 [MixedStreamAudioProfile](#MixedStreamAudioProfile)。默认值为 `MIXED_STREAM_AUDIO_PROFILE_LC("LC")`。 | ### getAudioProfile ```java MixedStreamAudioProfile com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.getAudioProfile() ``` 获取 AAC 编码规格。 # BackgroundMode ```java public enum com.ss.bytertc.engine.type.BackgroundMode ``` 背景模式开启背景替换功能时生效，详见 [replaceBackground](70080#RTCVideo-replacebackground)。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BACKGROUND_A | 0 | 背景 1 | | BACKGROUND_B | 1 | 背景 2 | | BLUR | 2 | 虚化 | | NONE | 3 | 无 | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [value](#BackgroundMode-value) | ## 函数说明 ### value ```java int com.ss.bytertc.engine.type.BackgroundMode.value() ``` 获取 Background 的 int value **返回值** int 类型的 value # GLTextureVideoFrameBuilder ```java public class com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder ``` 构建纹理格式视频数据返回帧 ## 成员函数 | 返回 | 名称 | | --- | --- | | GLTextureVideoFrameBuilder | [setTimeStampUs](#GLTextureVideoFrameBuilder-settimestampus) | | GLTextureVideoFrameBuilder | [setWidth](#GLTextureVideoFrameBuilder-setwidth) | | GLTextureVideoFrameBuilder | [setHeight](#GLTextureVideoFrameBuilder-setheight) | | GLTextureVideoFrameBuilder | [setRotation](#GLTextureVideoFrameBuilder-setrotation) | | GLTextureVideoFrameBuilder | [setColorSpace](#GLTextureVideoFrameBuilder-setcolorspace) | | GLTextureVideoFrameBuilder | [setExternalDataInfo](#GLTextureVideoFrameBuilder-setexternaldatainfo) | | GLTextureVideoFrameBuilder | [setSupplementaryInfo](#GLTextureVideoFrameBuilder-setsupplementaryinfo) | | GLTextureVideoFrameBuilder | [setTextureID](#GLTextureVideoFrameBuilder-settextureid) | | GLTextureVideoFrameBuilder | [setTextureMatrix](#GLTextureVideoFrameBuilder-settexturematrix) | | GLTextureVideoFrameBuilder | [setEGLContext](#GLTextureVideoFrameBuilder-seteglcontext) | | GLTextureVideoFrameBuilder | [setReleaseCallback](#GLTextureVideoFrameBuilder-setreleasecallback) | | VideoFrame | [build](#GLTextureVideoFrameBuilder-build) | ## 函数说明 ### setTimeStampUs ```java GLTextureVideoFrameBuilder com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.setTimeStampUs(long timeStampUs) ``` 设置视频帧的时间戳 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | timeStampUs | long | 视频帧时间戳 | ### setWidth ```java GLTextureVideoFrameBuilder com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.setWidth(int width) ``` 设置视频帧宽度 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | int | 视频帧宽度，单位：像素 | ### setHeight ```java GLTextureVideoFrameBuilder com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.setHeight(int height) ``` 设置视频帧高度 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | height | int | 视频帧高度，单位：像素 | ### setRotation ```java GLTextureVideoFrameBuilder com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.setRotation(VideoRotation rotation) ``` 设置视频帧旋转角度 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | rotation | VideoRotation | 视频帧旋转角度，参看 [VideoRotation](#VideoRotation) | ### setColorSpace ```java GLTextureVideoFrameBuilder com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.setColorSpace(ColorSpace colorSpace) ``` 设置视频帧色彩空间 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | colorSpace | ColorSpace | 视频帧色彩空间，参看 [ColorSpace](#ColorSpace) | ### setExternalDataInfo ```java GLTextureVideoFrameBuilder com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.setExternalDataInfo(ByteBuffer externalDataInfo) ``` 设置 SEI 数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | externalDataInfo | ByteBuffer | SEI 数据，如果设置的是一个 DirectBuffer，则不会发生拷贝，如果不是，则会发生一次拷贝 | ### setSupplementaryInfo ```java GLTextureVideoFrameBuilder com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.setSupplementaryInfo(ByteBuffer supplementaryInfo) ``` 设置补充数据指针 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | supplementaryInfo | ByteBuffer | 补充数据指针，如果设置的是一个 DirectBuffer，则不会发生拷贝，如果不是，则会发生一次拷贝 | ### setTextureID ```java GLTextureVideoFrameBuilder com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.setTextureID(int textureID) ``` 设置视频帧的纹理 ID **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | textureID | int | 纹理 ID | ### setTextureMatrix ```java GLTextureVideoFrameBuilder com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.setTextureMatrix(float[] textureMatrix) ``` 设置视频帧纹理矩阵 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | textureMatrix | float[] | 视频帧纹理矩阵 | ### setEGLContext ```java GLTextureVideoFrameBuilder com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.setEGLContext(EGLContext eglContext) ``` 设置视频帧的 EGLContext **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | eglContext | EGLContext | 视频帧的 EGLContext | ### setReleaseCallback ```java GLTextureVideoFrameBuilder com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.setReleaseCallback(Runnable releaseCallback) ``` 设置视频帧的释放回调，当视频帧的引用计数归 0 时，会执行 releaseCallback **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | releaseCallback | Runnable | 视频帧的释放回调 | ### build ```java VideoFrame com.ss.bytertc.engine.video.builder.GLTextureVideoFrameBuilder.build() ``` 获取到创建好的视频帧 **返回值** 创建好的视频帧，参看 [VideoFrame](#VideoFrame) # ZoomDirectionType ```java public enum com.ss.bytertc.engine.data.ZoomDirectionType ``` 数码变焦操作类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | CAMERA_MOVE_LEFT | 0 | 相机向左移动 | | CAMERA_MOVE_RIGHT | 1 | 相机向右移动 | | CAMERA_MOVE_UP | 2 | 相机向上移动 | | CAMERA_MOVE_DOWN | 3 | 相机向下移动 | | CAMERA_ZOOM_OUT | 4 | 相机缩小焦距 | | CAMERA_ZOOM_IN | 5 | 相机放大焦距 | | CAMERA_RESET | 6 | 恢复到原始大小 | # StandardPitchInfo ```java public class com.ss.bytertc.engine.data.StandardPitchInfo ``` 标准音高数据数组。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [startTime](#StandardPitchInfo-starttime) | | int | [duration](#StandardPitchInfo-duration) | | int | [pitch](#StandardPitchInfo-pitch) | ## 变量说明 ### startTime ```java public int com.ss.bytertc.engine.data.StandardPitchInfo.startTime ``` 开始时间，单位 ms。 ### duration ```java public int com.ss.bytertc.engine.data.StandardPitchInfo.duration ``` 持续时间，单位 ms。 ### pitch ```java public int com.ss.bytertc.engine.data.StandardPitchInfo.pitch ``` 音高。 # AudioMixingType ```java public enum com.ss.bytertc.engine.data.AudioMixingType ``` 混音播放类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | AUDIO_MIXING_TYPE_PLAYOUT | 0 | 仅本地播放 | | AUDIO_MIXING_TYPE_PUBLISH | 1 | 仅远端播放 | | AUDIO_MIXING_TYPE_PLAYOUT_AND_PUBLISH | 2 | 本地和远端同时播放 | # AttenuationType ```java public enum com.ss.bytertc.engine.type.AttenuationType ``` 空间音频音量随距离衰减模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ATTENUATION_TYPE_NONE | 0 | 不随距离衰减 | | ATTENUATION_TYPE_LINEAR | 1 | 线性衰减，音量随距离增大而线性减小 | | ATTENUATION_TYPE_EXPONENTIAL | 2 | 指数型衰减，音量随距离增大进行指数衰减 | # MediaPlayerCustomSourceStreamType ```java public enum com.ss.bytertc.engine.data.MediaPlayerCustomSourceStreamType ``` 自定义音频流类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | RAW | 0 | 当播放来自本地的 PCM 数据时，使用此选项。 | | ENCODED | 1 | 当播放来自内存的音频数据时，使用此选项。 | # AlphaLayout ```java public enum com.ss.bytertc.engine.data.AlphaLayout ``` Alpha 通道相对于 RGB 通道数据的排列位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TOP | 0 | Alpha 数据置于 RGB 数据上方。 | # MixedStreamConfig ```java public class com.ss.bytertc.engine.live.MixedStreamConfig ``` 转推直播配置参数。 ## 静态函数 | 返回 | 名称 | | --- | --- | | static MixedStreamConfig | [defaultMixedStreamConfig](#MixedStreamConfig-defaultmixedstreamconfig) | ## 成员函数 | 返回 | 名称 | | --- | --- | | MixedStreamConfig | [setUserID](#MixedStreamConfig-setuserid) | | String | [getUserID](#MixedStreamConfig-getuserid) | | MixedStreamConfig | [setRoomID](#MixedStreamConfig-setroomid) | | String | [getRoomID](#MixedStreamConfig-getroomid) | | MixedStreamConfig | [setPushURL](#MixedStreamConfig-setpushurl) | | String | [getPushURL](#MixedStreamConfig-getpushurl) | | MixedStreamConfig | [setExpectedMixingType](#MixedStreamConfig-setexpectedmixingtype) | | ByteRTCStreamMixingType | [getExpectedMixingType](#MixedStreamConfig-getexpectedmixingtype) | | MixedStreamConfig | [setAudioConfig](#MixedStreamConfig-setaudioconfig) | | MixedStreamAudioConfig | [getAudioConfig](#MixedStreamConfig-getaudioconfig) | | MixedStreamConfig | [setServerControlConfig](#MixedStreamConfig-setservercontrolconfig) | | MixedStreamServerControlConfig | [getServerControlConfig](#MixedStreamConfig-getservercontrolconfig) | | MixedStreamConfig | [setVideoConfig](#MixedStreamConfig-setvideoconfig) | | MixedStreamVideoConfig | [getVideoConfig](#MixedStreamConfig-getvideoconfig) | | MixedStreamConfig | [setClientMixConfig](#MixedStreamConfig-setclientmixconfig) | | MixedStreamConfig | [setSpatialConfig](#MixedStreamConfig-setspatialconfig) | | MixedStreamSpatialConfig | [getSpatialConfig](#MixedStreamConfig-getspatialconfig) | | MixedStreamConfig | [setLayout](#MixedStreamConfig-setlayout) | | MixedStreamLayoutConfig | [getLayout](#MixedStreamConfig-getlayout) | | boolean | [getMixedStreamVideoConfigBFrame](#MixedStreamConfig-getmixedstreamvideoconfigbframe) | ## 函数说明 ### defaultMixedStreamConfig ```java static MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.defaultMixedStreamConfig() ``` 获取默认的转推直播配置参数。 **返回值** 默认的转推直播配置参数。参看 [MixedStreamConfig](#MixedStreamConfig)。 ### setUserID ```java MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setUserID(String userID) ``` 设置推流用户 ID。本参数不支持过程中更新。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | userID | String | 推流用户 ID。`roomId` 和 `userId` 长度相加不得超过 126 字节。 | ### getUserID ```java String com.ss.bytertc.engine.live.MixedStreamConfig.getUserID() ``` 获取推流用户 ID。 ### setRoomID ```java MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setRoomID(String roomID) ``` 设置推流用户所在的房间 ID。本参数不支持过程中更新。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomID | String | 推流用户所在的房间 ID。`roomId` 和 `userId` 长度相加不得超过 126 字节。 | ### getRoomID ```java String com.ss.bytertc.engine.live.MixedStreamConfig.getRoomID() ``` 获取推流用户所在的房间 ID。 ### setPushURL ```java MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setPushURL(String pushURL) ``` 设置推流 CDN 地址。仅支持 RTMP 协议，Url 必须满足正则 `/^rtmps?:\/\//`。建议设置。本参数不支持过程中更新。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | pushURL | String | 推流 CDN 地址。 | ### getPushURL ```java String com.ss.bytertc.engine.live.MixedStreamConfig.getPushURL() ``` 获取推流 CDN 地址。 ### setExpectedMixingType ```java MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setExpectedMixingType(ByteRTCStreamMixingType expectedMixingType) ``` 设置合流类型。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | expectedMixingType | ByteRTCStreamMixingType | 合流类型，参看 [ByteRTCStreamMixingType](#ByteRTCStreamMixingType)。 | **注意** 本参数不支持过程中更新。 ### getExpectedMixingType ```java ByteRTCStreamMixingType com.ss.bytertc.engine.live.MixedStreamConfig.getExpectedMixingType() ``` 获取合流类型。 ### setAudioConfig ```java MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setAudioConfig(MixedStreamAudioConfig audioConfig) ``` 设置音频转码配置参数。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioConfig | MixedStreamAudioConfig | 音频转码配置参数，参看 [MixedStreamAudioConfig](#MixedStreamConfig-MixedStreamAudioConfig)。 | ### getAudioConfig ```java MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.getAudioConfig() ``` 获取音频转码配置参数。 ### setServerControlConfig ```java MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setServerControlConfig(MixedStreamServerControlConfig serverControlConfig) ``` > Available since 3.56 设置服务端合流控制参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | serverControlConfig | MixedStreamServerControlConfig | 服务端合流控制参数，参看 [MixedStreamServerControlConfig](#MixedStreamConfig-MixedStreamServerControlConfig)。 | ### getServerControlConfig ```java MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.getServerControlConfig() ``` > Available since 3.56 获取服务端合流控制参数的设置。 ### setVideoConfig ```java MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setVideoConfig(MixedStreamVideoConfig videoConfig) ``` 设置视频转码配置参数。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoConfig | MixedStreamVideoConfig | 视频转码配置参数。详见 [MixedStreamVideoConfig](#MixedStreamConfig-MixedStreamVideoConfig) 数据类型。 | ### getVideoConfig ```java MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.getVideoConfig() ``` 获取视频转码配置参数。 ### setClientMixConfig ```java MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setClientMixConfig(MixedStreamClientMixConfig clientMixConfig) ``` 设置客户端合流配置参数。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | clientMixConfig | MixedStreamClientMixConfig | 客户端合流配置参数。详见 [MixedStreamClientMixConfig](#MixedStreamClientMixConfig) 数据类型。 | ### setSpatialConfig ```java MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setSpatialConfig(MixedStreamSpatialConfig spatialConfig) ``` 设置推流 CDN 的空间音频参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | spatialConfig | MixedStreamSpatialConfig | 空间音频参数。详见 [MixedStreamSpatialConfig](#MixedStreamConfig-MixedStreamSpatialConfig) 数据类型。 | ### getSpatialConfig ```java MixedStreamSpatialConfig com.ss.bytertc.engine.live.MixedStreamConfig.getSpatialConfig() ``` 获取推流 CDN 的空间音频参数。 ### setLayout ```java MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setLayout(MixedStreamLayoutConfig layout) ``` 设置视频流合流整体布局信息。建议设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | layout | MixedStreamLayoutConfig | 视频流合流整体布局参数，参看 [MixedStreamLayoutConfig](#MixedStreamConfig-MixedStreamLayoutConfig)。 | ### getLayout ```java MixedStreamLayoutConfig com.ss.bytertc.engine.live.MixedStreamConfig.getLayout() ``` 获取视频流合流整体布局信息。 ### getMixedStreamVideoConfigBFrame ```java boolean com.ss.bytertc.engine.live.MixedStreamConfig.getMixedStreamVideoConfigBFrame() ``` # SEICountPerFrame ```java public enum com.ss.bytertc.engine.data.SEICountPerFrame ``` SEI 发送模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | SEI_COUNT_PER_FRAME_SINGLE | 0 | 单发模式。即在 1 帧间隔内多次发送 SEI 数据时，多个 SEI 按队列逐帧发送。 | | SEI_COUNT_PER_FRAME_MULTI | 1 | 多发模式。即在 1 帧间隔内多次发送 SEI 数据时，多个 SEI 随下个视频帧同时发送。 |

实时音视频