Type definition - Flexible Classroom

EduContextRoomType

The classroom type.

Enumerator

OneToOne: One-to-one Classroom
SmallClass: Small Classroom
LargeClass: Lecture Hall

EduContextVideoRenderMode

Video rendering mode.

Enumerator

Hidden: Hidden mode. This mode ensures the window is filled. The SDK uniformly scales the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
Fit: Fit mode. This mode ensures that all video content is displayed. The SDK uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black.

AgoraEduContextVideoSourceType

The video source type.

Enumerator

None: No video

Camera: Video captured by the camera

Screen: Video of the shared screen

AgoraEduContextAudioSourceType

The audio source type.

Enumerator

None: No audio

Camera: Audio sampled by the microphone

AgoraEduContextMediaStreamType

The stream type.

Enumerator

None: The stream contains neither audio nor video.
Audio: Audio-only stream.
Video: Video-only stream.
Both: The stream contains both audio and video.

AgoraEduContextVideoStreamSubscribeLevel

Whether the resolution of the video stream is high or low.

Enumerator

LOW: The video stream of a low resolution

HIGH: The video stream of a high resolution

AgoraEduContextDeviceType

The device type.

Enumerator

Camera: Camera
Mic: Microphone
Speaker: Speaker

AgoraEduContextMediaSourceState

The media source state.

Enumerator

Error: An error occurs in the media source.

Close: The media source is off.

Open: The media source is on.

AgoraEduContextDeviceState2

The device state.

Enumerator

Error: An error occurs in the device.

Close: The device is off.

Open: The device is on.

EduContextUserLeftReason

The reason why the user leaves the room.

Enumerator

Normal: The user leaves the room normally.

KickedOut: The user is kicked out of the room.

AgoraEduContextClassState

The class state.

Enumerator

Before: The class has not been started.
During: The class is in progress.
After: The class has ended.

AgoraEduContextUserRole

The user role.

Enumerator

Teacher: Teacher

Student: Student

Assistant: Teaching assistant (TA)

EduContextNetworkQuality

The network quality type.

Enumerator

Unknown: Unknown

Good: Good

Medium: Medium

Bad: Bad

EduContextMirrorMode

Mirror mode.

Enumerator

AUTO: The SDK disables mirror mode by default.
ENABLED: Enable mirror mode.
DISABLED: Disable mirror mode.

FcrRecordingState

The recording state.

Enumerator

STOPPED: Not in recording
STARTING: Recording being started
STARTED: In recording

EduContextRenderConfig

Video rendering configurations.

data class EduContextRenderConfig(
        val renderMode: EduContextRenderMode = EduContextRenderMode.HIDDEN,
        val mirrorMode: EduContextMirrorMode = EduContextMirrorMode.AUTO)

Attributes

renderMode: Video rendering mode. See EduContextVideoRenderMode.
mirrorMode: Mirror mode. See EduContextMirrorMode.

AgoraEduContextStreamInfo

The stream information.

data class AgoraEduContextStreamInfo(
        val streamUuid: String,
        val streamName: String?,
        val streamType: AgoraEduContextMediaStreamType,
        val videoSourceType: AgoraEduContextVideoSourceType,
        val audioSourceType: AgoraEduContextAudioSourceType,
        var videoSourceState: AgoraEduContextMediaSourceState,
        var audioSourceState: AgoraEduContextMediaSourceState,
        var videoState: AgoraEduContextMediaState,
        var audioState: AgoraEduContextMediaState,
        var owner: AgoraEduContextUserInfo)

Attributes

streamUuid: The stream ID, String.
streamName: The stream name, String.
streamType: The stream type. See AgoraEduContextMediaStreamType.
videoSourceType: The video source type. See AgoraEduContextVideoSourceType.
audioSourceType: The audio source type. See AgoraEduContextAudioSourceType.
videoSourceState: The video source state. See AgoraEduContextMediaSourceState.
audioSourceState: The audio source status. See AgoraEduContextMediaSourceState.
owner: The owner of the stream. See AgoraEduContextUserInfo.

AgoraEduContextUserInfo

The basic user information.

data class AgoraEduContextUserInfo(
    val userUuid: String,
    val userName: String,
    val role: AgoraEduContextUserRole = AgoraEduContextUserRole.Student)

Attributes

userUuid: The user ID, String.
userName: The user name,String.
role: The user role. See AgoraEduContextUserRole.

AgoraEduContextDeviceInfo

The device Information.

data class AgoraEduContextDeviceInfo(
        val deviceId: String,
        val deviceName: String,
        val deviceType: AgoraEduContextDeviceType
)

Attributes

deviceType: The device type. See AgoraEduContextDeviceType.
deviceId: The device ID, String.
deviceName: The device name, String.

EduContextRoomInfo

The room information.

data class EduContextRoomInfo(
    val roomUuid: String,
    val roomName: String,
    val roomType: EduContextRoomType
)

Attributes

roomUuid: The room ID, String.
roomName: The room name, String.
roomType: The room type. See EduContextRoomType.

AgoraEduContextClassInfo

The classroom information.

data class AgoraEduContextClassInfo(
        var state: AgoraEduContextClassState = AgoraEduContextClassState.Before,
        val startTime: Long = 0L,
        val duration: Long = 0L,
        val closeDelay: Long = 0L
)

Attributes

state: The class state. See AgoraEduContextClassState.
startTime: The class start time, Long.
duration: The class duration, Long.
closeDelay: How long the class can last after it ends, Long.

AgoraEduContextLocalStreamConfig

Video configurations.

data class AgoraEduContextLocalStreamConfig(
        val width: Int,
        val height: Int,
        val frameRate: Int,
        val bitRate: Int,
        val mirror: Boolean
)

Attributes

width: The video width (pixel) in Int. The default value is 320.
height: The video height (pixel) in Int. The default value is 240.
frameRate: The frame rate (fps) in Int. The default value is 15.
bitrate: The bitrate (Kbps) in Int. The default value is 200.
mirror: Whether the video is mirrored. Bool. The default value is false.

FcrAudioRawDataConfig

The configuration for the raw audio data to be output in the callback.

public class FcrAudioRawDataConfig {
    public int sampleRate = 48000;
    public int samplesPerChannel = 1024;
    public int channels = 1;
    public int mode = 0;
    public int position = 2;
}

Attributes

sampleRate: The sample rate. You can set this parameter as 8000, 16000, 32000, 44100, or 48000. The default value is 48000.
samplesPerChannel: The number of samples for a channel in a callback. The default value is 1024.
channels: Mono or stereo. The default value is 1.
mode: The permission to operate on the audio data. Temporarily, you can set this parameter only as Constants.RAW_AUDIO_FRAME_OP_MODE_READ_ONLY.
position: The position in the audio pipeline, such as after the recording finishes or before the playback. Temporarily, you can set this parameter only as IAudioFrameObserver.POSITION_RECORD.

FcrAudioRawData

The audio data.

public class FcrAudioRawData {
    public int samplesPerChannel;
    public int bytesPerSample;
    public int channels;
    public int sampleRate;
    public ByteBuffer buffer;
}

Attributes

samplesPerChannel: The number of samples of each channel.
bytesPerSample: The bytes of each sample.
channels: The number of channels.
sampleRate: The sample rate.
buffer: The pointer to audio data buffer. Length of buffer (bytes) = (samplesPerChannel * channels * bytesPerSample)

FcrSnapshotInfo

The snapshot information.

class FcrSnapshotInfo {
    var roomUuid: String? = null
    var streamUuid: String? = null
    var filePath: String? = null
    var width: Int? = null
    var height: Int? = null
}

Parameter

roomUuid: The room ID.
streamUuid: The stream ID.
filePath: The path for saving the snapshot.
width: The width of the snapshot.
height: The height of the snapshot.