文档中心
AI 互动课堂
API 参考
Agora Media Streaming Server SDK API Reference for C++
Media Streaming Server SDK API Reference for C++
|
enum | ERROR_CODE_TYPE { ERR_OK = 0,
ERR_FAILED = 1,
ERR_INVALID_ARGUMENT = 2,
ERR_INTERNAL_FAILED = 3
} |
|
enum | STAT_CODE_TYPE { STAT_OK = 0,
STAT_ERR_ARS_JOIN_CHANNEL = 2
} |
|
enum | CHANNEL_PROFILE_TYPE { CHANNEL_PROFILE_COMMUNICATION = 0,
CHANNEL_PROFILE_LIVE_BROADCASTING = 1
} |
|
enum | USER_OFFLINE_REASON_TYPE { USER_OFFLINE_QUIT = 0,
USER_OFFLINE_DROPPED = 1,
USER_OFFLINE_BECOME_AUDIENCE = 2
} |
|
enum | VIDEO_FORMAT_TYPE {
VIDEO_FORMAT_DEFAULT_TYPE = 0,
VIDEO_FORMAT_H264_FRAME_TYPE = 1,
VIDEO_FORMAT_YUV_FRAME_TYPE = 2,
VIDEO_FORMAT_JPG_FRAME_TYPE = 3,
VIDEO_FORMAT_JPG_FILE_TYPE = 4,
VIDEO_FORMAT_JPG_VIDEO_FILE_TYPE = 5
} |
|
enum | AUDIO_FORMAT_TYPE { AUDIO_FORMAT_DEFAULT_TYPE = 0,
AUDIO_FORMAT_AAC_FRAME_TYPE = 1,
AUDIO_FORMAT_PCM_FRAME_TYPE = 2,
AUDIO_FORMAT_MIXED_PCM_FRAME_TYPE = 3
} |
|
enum | AUDIO_FRAME_TYPE { AUDIO_FRAME_RAW_PCM = 0,
AUDIO_FRAME_AAC = 1
} |
|
enum | VIDEO_FRAME_TYPE { VIDEO_FRAME_RAW_YUV = 0,
VIDEO_FRAME_H264 = 1,
VIDEO_FRAME_JPG = 2
} |
|
enum | agora_log_level {
AGORA_LOG_LEVEL_FATAL = 1,
AGORA_LOG_LEVEL_ERROR = 2,
AGORA_LOG_LEVEL_WARN = 3,
AGORA_LOG_LEVEL_NOTICE = 4,
AGORA_LOG_LEVEL_INFO = 5,
AGORA_LOG_LEVEL_DEBUG = 6
} |
|
enum | MEDIASERVER_STREAMING_CMD {
STREAMING_OPEN_URL = 0x01,
STREAMING_APPEND_URL,
STREAMING_REMOVE_URL,
STREAMING_CLEAR_URL,
STREAMING_PLAYNEXT_URL,
STREAMING_GET_URL,
STREAMING_PLAY = 0x10,
STREAMING_PAUSE,
STREAMING_RESUME,
STREAMING_STOP,
STREAMING_SEEK
} |
|
enum | MEDIASERVER_STREAMING_STATE {
STREAMING_CLIP_SET = 1,
STREAMING_CLIP_EOF,
STREAMING_CLIP_SEEK,
STREAMING_CLIP_ERR,
STREAMING_CLIP_NO_NEXT,
STREAMING_CLIP_UPDATE,
STREAMING_CLIP_OVERFLOW
} |
|
◆ uchar_t
◆ uint_t
◆ uid_t
◆ u64_t
◆ UserJoinInfos
◆ RtcChannelStats
◆ StreamingStateInfo
◆ ERROR_CODE_TYPE
错误码。
- 注解
- 你也可能收到来自 Agora RTC SDK 的错误代码,请参考 Agora RTC SDK 错误代码。
枚举值 |
---|
ERR_OK | 0: 没有错误。
|
ERR_FAILED | 1: 一般性的错误(没有明确归类的错误原因)。
|
ERR_INVALID_ARGUMENT | 2: API 调用了无效的参数。例如指定的频道名含有非法字符。
|
ERR_INTERNAL_FAILED | 3: SDK 模块尚未准备好。我们推荐通过以下步骤解决此问题:
- 检查音频设备。
- 检查 App 逻辑。
- 重新初始化 SDK。
|
◆ STAT_CODE_TYPE
状态码。
枚举值 |
---|
STAT_OK | 0: 一切正常。
|
STAT_ERR_ARS_JOIN_CHANNEL | 2: 加入频道失败。
|
◆ CHANNEL_PROFILE_TYPE
频道模式。
枚举值 |
---|
CHANNEL_PROFILE_COMMUNICATION | 0: (默认)通信,即常见的 1 对 1 单聊或群聊,频道内任何用户可以自由说话。
|
CHANNEL_PROFILE_LIVE_BROADCASTING | 1: 直播,有两种用户角色:主播和观众。
|
◆ USER_OFFLINE_REASON_TYPE
远端用户离开当前频道或掉线的原因。
枚举值 |
---|
USER_OFFLINE_QUIT | 0: 远端用户主动离开。
|
USER_OFFLINE_DROPPED | 1: 因过长时间收不到对方数据包,超时掉线。注意,可能有误判。
|
USER_OFFLINE_BECOME_AUDIENCE | 2: 用户身份从主播切换为观众时触发。该选项仅适用于当你在调用 joinChannel 时将频道模式设置为直播的场景。
|
◆ VIDEO_FORMAT_TYPE
视频解码格式。
枚举值 |
---|
VIDEO_FORMAT_DEFAULT_TYPE | 0: 默认视频格式。
|
VIDEO_FORMAT_H264_FRAME_TYPE | 1: 原始视频数据 H.264 帧格式。
|
VIDEO_FORMAT_YUV_FRAME_TYPE | 2: 原始视频数据 YUV 帧格式。
|
VIDEO_FORMAT_JPG_FRAME_TYPE | 3: 原始视频数据 JPG 帧格式。
|
VIDEO_FORMAT_JPG_FILE_TYPE | 4: JPG 文件格式。
|
VIDEO_FORMAT_JPG_VIDEO_FILE_TYPE | 5: JPG 文件格式 + MP4 视频文件格式。
|
◆ AUDIO_FORMAT_TYPE
音频解码格式。
枚举值 |
---|
AUDIO_FORMAT_DEFAULT_TYPE | 0: 默认音频格式。
|
AUDIO_FORMAT_AAC_FRAME_TYPE | 1: 原始音频数据 AAC 帧格式。
|
AUDIO_FORMAT_PCM_FRAME_TYPE | 2: 原始音频数据 PCM 帧格式。
|
AUDIO_FORMAT_MIXED_PCM_FRAME_TYPE | 3: 原始音频数据 PCM 帧混音格式。
|
◆ AUDIO_FRAME_TYPE
原始音频数据格式。
枚举值 |
---|
AUDIO_FRAME_RAW_PCM | 0: PCM 格式。
|
AUDIO_FRAME_AAC | 1: AAC 格式。
|
◆ VIDEO_FRAME_TYPE
原始视频数据格式。
枚举值 |
---|
VIDEO_FRAME_RAW_YUV | 0: YUV 格式。
|
VIDEO_FRAME_H264 | 1: H.264 格式。
|
VIDEO_FRAME_JPG | 2: JPG 格式。
|
◆ agora_log_level
日志等级。
枚举值 |
---|
AGORA_LOG_LEVEL_FATAL | 1: 日志等级为 Fatal。
|
AGORA_LOG_LEVEL_ERROR | 2: 日志等级为 Error。
|
AGORA_LOG_LEVEL_WARN | 3: 日志等级为 Warning。
|
AGORA_LOG_LEVEL_NOTICE | 4: 日志等级为 Notice。
|
AGORA_LOG_LEVEL_INFO | 5: 日志等级为 Info。
|
AGORA_LOG_LEVEL_DEBUG | 6: 日志等级为 Debug。
|
◆ MEDIASERVER_STREAMING_CMD
推流指令。
枚举值 |
---|
STREAMING_OPEN_URL | 打开媒体文件。
|
STREAMING_APPEND_URL | 将指定的媒体文件添加到播放列表。
|
STREAMING_REMOVE_URL | 从播放列表中移除媒体文件。
|
STREAMING_CLEAR_URL | 清除播放列表。
|
STREAMING_PLAYNEXT_URL | 切换至播放列表中的下一个文件。
|
STREAMING_GET_URL | 获取播放列表中的媒体文件路径。
|
STREAMING_PLAY | 开始播放媒体文件。
|
STREAMING_PAUSE | 暂停播放当前文件。
|
STREAMING_RESUME | 恢复播放当前文件。
|
STREAMING_STOP | 停止播放当前文件。
|
STREAMING_SEEK | 跳转到当前文件的指定播放位置(毫秒)。
|
◆ MEDIASERVER_STREAMING_STATE
推流状态。
枚举值 |
---|
STREAMING_CLIP_SET | 当前文件开始播放。
|
STREAMING_CLIP_EOF | 当前文件播放结束。
|
STREAMING_CLIP_SEEK | 已跳转到指定播放位置。
|
STREAMING_CLIP_ERR | 媒体文件音视频数据无法获取。建议检查文件是否存在,并使用 ffprobe 等工具查看文件音视频信息及编码格式。
|
STREAMING_CLIP_NO_NEXT | 播放列表中的最后一个文件还剩 300 毫秒。
|
STREAMING_CLIP_UPDATE | 播放列表的文件个数更新。
|
STREAMING_CLIP_OVERFLOW | 播放列表的文件个数超过上限。
|