类 | |
class | IEngine |
class | IEngineConfig |
struct | UserInfo |
struct | AudioVolumeInfo |
struct | RemoteVideoStats |
struct | RemoteAudioStats |
struct | RecordingStats |
class | AudioPcmFrame |
class | AudioAacFrame |
struct | AudioFrame |
class | VideoYuvFrame |
struct | VideoH264Frame |
struct | VideoH265Frame |
struct | VideoJpgFrame |
struct | VideoJpgFile |
struct | VideoFrame |
struct | LiteraWatermarkConfig |
struct | TimestampWatermarkConfig |
struct | ImageWatermarkConfig |
struct | WatermarkConfig |
struct | VideoMixingLayout |
struct | UserJoinInfos |
类型定义 | |
typedef unsigned char | uchar_t |
typedef unsigned int | uint_t |
typedef unsigned int | uid_t |
typedef uint64_t | u64_t |
typedef struct agora::linuxsdk::VideoMixingLayout | VideoMixingLayout |
typedef struct agora::linuxsdk::UserJoinInfos | UserJoinInfos |
typedef unsigned char agora::linuxsdk::uchar_t |
typedef unsigned int agora::linuxsdk::uint_t |
typedef unsigned int agora::linuxsdk::uid_t |
typedef uint64_t agora::linuxsdk::u64_t |
视频合流布局的具体设置。
typedef struct agora::linuxsdk::UserJoinInfos agora::linuxsdk::UserJoinInfos |
用户加入频道信息。
错误代码。
枚举值 | |
---|---|
ERR_OK | 0:没有错误。 |
ERR_FAILED | 1:一般性的错误(没有明确归类的错误原因)。 |
ERR_INVALID_ARGUMENT | 2:API 调用了无效的参数。例如指定的频道名含有非法字符。 |
ERR_INTERNAL_FAILED | 3:SDK 内部启动失败。 |
状态代码。
枚举值 | |
---|---|
STAT_OK | 0:一切正常。 |
STAT_ERR_FROM_ENGINE | 1:Nativa SDK 产生的错误。详见 Agora Native/Web SDK 错误代码。 |
STAT_ERR_ARS_JOIN_CHANNEL | 2:加入频道失败。 |
STAT_ERR_CREATE_PROCESS | 3:创建进程失败。 |
STAT_ERR_MIXED_INVALID_VIDEO_PARAM | 4: 合流视频参数设置错误。请参考分辨率、帧率、码率对照表设置合流视频编码属性。 |
STAT_ERR_NULL_POINTER | 5:无效的指针。 |
STAT_ERR_PROXY_SERVER_INVALID_PARAM | 6:代理服务器参数无效。 |
STAT_POLL_ERR | 0x8:轮询出错。 |
STAT_POLL_HANG_UP | 0x10:轮询挂起。 |
STAT_POLL_NVAL | 0x20:轮询请求无效。 |
录制端离开频道的原因。将 LEAVE_PATH_CODE
与各枚举值逐一进行按位与运算,计算结果非零的,即为退出原因。例如,code 为 6
(二进制 110)时,将其与各枚举值逐一进行按位与计算,LEAVE_CODE_SIG
(二进制 10)与 LEAVE_CODE_NO_USERS
(二进制 100)的结果非零,则退出原因包括收到 SIGINT 信号以及录制超时。
枚举值 | |
---|---|
LEAVE_CODE_INIT | 0:初始化失败。 |
LEAVE_CODE_SIG | 2(二进制 10):AgoraCoreService 收到 SIGINT 信号而触发的退出。 |
LEAVE_CODE_NO_USERS | 4(二进制 100):频道内除录制端外没有其他用户,录制端自动离开频道。 |
LEAVE_CODE_TIMER_CATCH | 8(二进制 1000):可忽略。 |
LEAVE_CODE_CLIENT_LEAVE | 16(二进制 10000):录制端调用 leaveChannel 方法退出频道。 |
警告代码。
用户离开当前频道或掉线的原因。
枚举值 | |
---|---|
USER_OFFLINE_QUIT | 0:用户主动离开。 |
USER_OFFLINE_DROPPED | 1:因过长时间收不到对方数据包,超时掉线。注意:可能有误判。 |
USER_OFFLINE_BECOME_AUDIENCE | 2:用户身份从主播切换为观众时触发。该选项仅适用于当你在调用 joinChannel 时将频道模式设置为直播的场景。 |
录制视频格式。
枚举值 | |
---|---|
VIDEO_FORMAT_DEFAULT_TYPE | 0:默认视频格式。基于你的 codec 设置,默认视频格式可能为 MP4 或 WebM。 |
VIDEO_FORMAT_H264_FRAME_TYPE | DEPRECATED 1:原始视频数据 H.264 帧格式。 |
VIDEO_FORMAT_ENCODED_FRAME_TYPE | 1: 原始视频数据 H.264 或 H.265 帧格式。如设置该格式,你可通过 videoFrameReceived 回调接收原始视频数据。 |
VIDEO_FORMAT_YUV_FRAME_TYPE | 2:原始视频数据 YUV 帧格式。如设置该格式,你可通过 videoFrameReceived 回调接收原始视频数据。 |
VIDEO_FORMAT_JPG_FRAME_TYPE | 3:原始视频数据 JPG 帧格式。如设置该格式,你可通过 videoFrameReceived 回调接收原始视频数据。 |
VIDEO_FORMAT_JPG_FILE_TYPE | 4:JPG 文件格式。 |
VIDEO_FORMAT_JPG_VIDEO_FILE_TYPE | 5:JPG 文件格式 + MP4 或 WebM 视频文件格式。
|
录制音频格式。
枚举值 | |
---|---|
AUDIO_FORMAT_DEFAULT_TYPE | 0:默认音频格式,即 AAC 格式。 |
AUDIO_FORMAT_AAC_FRAME_TYPE | 1:原始音频数据 AAC 帧格式。如设置该格式,你可通过 audioFrameReceived 回调接收原始音频数据。 |
AUDIO_FORMAT_PCM_FRAME_TYPE | 2:原始音频数据 PCM 帧格式。如设置该格式,你可通过 audioFrameReceived 回调接收原始音频数据。 |
AUDIO_FORMAT_MIXED_PCM_FRAME_TYPE | 3:原始音频数据 PCM 帧混音格式。如设置该格式,你可通过 audioFrameReceived 回调接收原始音频数据。 |
选择录制启动模式。
枚举值 | |
---|---|
AUTOMATICALLY_MODE | 0:(默认)自动模式。此模式下,录制端加入频道即开始录制,退出频道即停止录制。 |
MANUALLY_MODE | 1:手动模式。此模式下,可以调用 startService 和 stopService 方法灵活开始、暂停录制。 |
录制文件的音频编码配置。设置采样率,码率,编码模式和声道数。只在合流模式(isMixingEnabled 为 true)下生效。
枚举值 | |
---|---|
AUDIO_PROFILE_DEFAULT | (默认)音频默认设置,采样率 48 KHz,单声道,编码码率为 48 Kbps。 |
AUDIO_PROFILE_HIGH_QUALITY | 高音质模式,采样率 48 KHz,单声道,编码码率 128 Kbps。 |
AUDIO_PROFILE_HIGH_QUALITY_STEREO | 高音质立体声,采样率 48 KHz,双声道,编码码率 192 Kbps。 |
实时混合语音和视频。
详见录制文件的播放器支持。
网络连接状态。
枚举值 | |
---|---|
CONNECTION_STATE_DISCONNECTED | 1:网络连接断开。 该状态表示 SDK 处于:
|
CONNECTION_STATE_CONNECTING | 2:建立网络连接中。 该状态表示 SDK 在调用 joinChannel 后正在与指定的频道建立连接。
|
CONNECTION_STATE_CONNECTED | 3:网络已连接。 该状态表示用户已经加入频道。 如果因网络断开或切换而导致 SDK 与频道的连接中断,SDK 会自动重连,此时应用程序会收到:
|
CONNECTION_STATE_RECONNECTING | 4:重新建立网络连接中。 该状态表示 SDK 之前曾加入过频道,但因网络等原因连接中断了,此时 SDK 会自动尝试重新接入频道。
|
CONNECTION_STATE_FAILED | 5:网络连接失败。 如果 SDK 因服务器端使用 RESTful API 禁止加入频道,则应用程序会收到 onConnectionStateChanged 回调,通知当前网络状态变成 CONNECTION_STATE_FAILED 。 该状态表示 SDK 已不再尝试重新加入频道,用户必须要调用 leaveChannel 离开频道。如果用户还想重新加入频道,则需要再次调用 joinChannel 。 |
引起网络连接状态发生改变的原因。