类型定义
本页列出 iOS API 所有的类型定义。
AgoraEduContextRoomType
AgoraEduContextVideoRenderMode
视频渲染模式。
枚举值
- hidden
- Hidden 模式。优先保证视窗被填满。视频尺寸等比缩放，直至整个视窗被视频填满。如果视频长宽与显示窗口不同，多出的视频将被截掉。
- fit
- Fit 模式。优先保证视频内容全部显示。视频尺寸等比缩放，直至视频窗口的一边与视窗边框对齐。如果视频长宽与显示窗口不同，视窗上未被填满的区域将被涂黑。
AgoraEduContextVideoSourceType
AgoraEduContextAudioSourceType
AgoraEduContextMediaStreamType
AgoraEduContextVideoStreamSubscribeLevel
AgoraEduContextDeviceType
AgoraEduContextMediaSourceState
AgoraEduContextDeviceState
AgoraEduContextUserLeaveReason
AgoraEduContextClassState
AgoraEduContextConnectionState
AgoraEduContextUserRole
AgoraEduContextNetworkQuality
AgoraEduContextSystemDevice
FcrMediaRawDataOperationMode
FcrAudioRawDataPosition
FcrRecordingState
AgoraEduContextRenderConfig
视频渲染配置。
mode
视频渲染模式，详见 AgoraEduContextVideoRenderMode。
isMirror
是否镜像，Bool 型。
AgoraEduContextStreamInfo
流信息。
streamUuid
流 ID，String 型。
streamName
流名称，String 型。
streamType
流类型，详见 AgoraEduContextMediaStreamType。
videoSourceType
视频源类型，详见 AgoraEduContextVideoSourceType。
audioSourceType
音频源类型，详见 AgoraEduContextAudioSourceType。
videoSourceState
视频源状态，详见 AgoraEduContextMediaSourceState。
audioSourceState
音频源状态，详见 AgoraEduContextMediaSourceState。
owner
流所属的用户，详见 AgoraEduContextUserInfo。
AgoraEduContextUserInfo
用户基础信息。
userUuid
用户 ID，String 型。
userName
用户名称，String 型。
role
用户角色，详见 AgoraEduContextUserRole。
rewardCount
收到的奖励次数，Int16 型。
AgoraEduContextDeviceInfo
设备信息。
type
设备类型，详见 AgoraEduContextDeviceType。
deviceId
设备 ID，String 型。
deviceName
设备名称，String 型。
AgoraEduContextRoomInfo
房间信息。
roomUuid
房间 ID，String 型。
roomName
房间名称，String 型。
roomType
房间类型，详见 AgoraEduContextRoomType。
AgoraEduContextClassInfo
课堂信息。
state
课堂状态，详见 AgoraEduContextClassState。
startTime
课堂开始时间，Int64 型。
duration
课堂时长，Int64 型。
closeDelay
拖堂时长，Int64 型。
AgoraEduContextVideoStreamConfig
视频流配置。
dimensionWidth
视频宽，Int 型，单位为 pixel，默认值为 320。
dimensionHeight
视频高，Int 型，单位为 pixel，默认值为 240。
frameRate
视频帧率，Int 型，单位为 fps，默认值为 15。
bitRate
视频码率，Int 型，单位为 Kbps，默认值为 200。
isMirror
视频是否镜像，Bool 型，默认值为 NO。
AgoraEduContextError
错误。
code
错误码，Int 型。
message
错误信息，String 型。
AgoraEduContextGroupInfo
分组信息。
state
是否开启分组讨论。
AgoraEduContextSubRoomInfo
子房间信息。
subRoomUuid
子房间 ID。
subRoomName
子房间名称。
AgoraEduContextSubRoomCreateConfig
子房间创建配置。
subRoomName
子房间名称。
invitationUserList
邀请加入子房间的用户 ID 列表。可为空。
subRoomProperties
子房间自定义属性，可为空。
FcrAudioRawDataConfig
需要回调出的音频数据配置。
sampleRate
采样率，可设为 8000，16000，32000，44100 或 48000。默认值 48000。
samplesPerChannel
每次回调时每个声道的样本点个数。默认值 1024。
channels
单声道或双声道。默认值 1。
mode
对音频数据的操作权限，详见 FcrMediaRawDataOperationMode。默认值 read only。
FcrAudioRawData
音频数据。
samplesPerChannel
每个声道的采样点数。
bytesPerSample
每个样本的字节数，2 字节。
channels
声道数。
sampleRate
采样率。
buffer
指向音频数据内存的指针。buffer 的长度（字节） = (samplesPerChannel * channels * bytesPerSample)
timestamp
时间戳，单位毫秒。
FcrSnapshotInfo
截图信息。
roomUuid
房间 ID。
streamUuid
流 ID
filePath
截图保存地址。
width
图片宽度。
height
图片高度。
FcrMediaPacketStats
媒体包信息数据。
Objective-C
@objcMembers public class FcrMediaPacketStats: NSObject {
public let lastMileDelay: Int
public let txPacketLossRate: Int
public let rxPacketLossRate: Int
public init(lastMileDelay: Int,
txPacketLossRate: Int,
rxPacketLossRate: Int) {
self.lastMileDelay = lastMileDelay
self.txPacketLossRate = txPacketLossRate
self.rxPacketLossRate = rxPacketLossRate
}
}
自从
v2.8.60
lastMileDelay
客户端-接入服务器延时 (毫秒)。
txPacketLossRate
客户端上行发送到服务器的丢包率（%）。
rxPacketLossRate
服务器下行发送到客户端的丢包率（%）。
FcrPerformanceInfo
设备性能信息。
Objective-C
@objcMembers public class FcrPerformanceInfo: NSObject {
public let cpuTotalUsage: Double
public let cpuAppUsage: Double
public let memoryAppUsageRatio: Double
public let memoryTotalUsageRatio: Double
public let memoryAppUsageInKbytes: Int
public init(cpuTotalUsage: Double,
cpuAppUsage: Double,
memoryAppUsageRatio: Double,
memoryTotalUsageRatio: Double,
memoryAppUsageInKbytes: Int) {
self.cpuTotalUsage = cpuTotalUsage
self.cpuAppUsage = cpuAppUsage
self.memoryAppUsageRatio = memoryAppUsageRatio
self.memoryTotalUsageRatio = memoryTotalUsageRatio
self.memoryAppUsageInKbytes = memoryAppUsageInKbytes
}
}
自从
v2.8.60
cpuTotalUsage
当前系统的 CPU 使用率（%）。
cpuAppUsage
当前 App 的 CPU 使用率（%）。
memoryAppUsageRatio
当前 App 的内存占比（%）。
memoryTotalUsageRatio
当前系统的内存占比（%）。
memoryAppUsageInKbytes
当前 App 的内存大小（KB）。