文档中心





媒体流加速



全部产品

产品



语音通话



视频通话



互动直播



极速直播



融合 CDN 直播



云信令（原实时消息）



全链路加速



媒体流加速



水晶球



互动白板



云端录制



本地服务端录制



低码高清



远程控制



视频鉴黄



服务端网关



灵动课堂



灵隼物联网云平台



Agora 平台

Beta 产品



语音通话 v4.0.0 Beta



视频通话 v4.0.0 Beta



极速直播 v4.0.0 Beta



互动直播 v4.0.0 Beta

场景方案

云市场

Console Agora.io 社区提交工单





Agora RTSA C API Reference for Linux

概览方法回调

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>

浏览源代码.

结构体
struct	video_frame_info_t

struct	audio_frame_info_t

struct	log_config_t

struct	rtc_service_option_t

struct	audio_codec_option_t

struct	rtc_channel_options_t

struct	agora_rtc_event_handler_t

struct	agora_rtm_handler_t

宏定义
#define	__agora_api__

#define	AGORA_RTM_UID_MAX_LEN 64

#define	AGORA_RTM_DATA_MAX_LEN (32 * 1024)

#define	AGORA_CREDENTIAL_MAX_LEN 256

#define	AGORA_CERTIFICATE_MAX_LEN 1024

枚举
enum	agora_err_code_e { ERR_OKAY = 0, ERR_FAILED = 1, ERR_NET_DOWN = 14, ERR_JOIN_CHANNEL_REJECTED = 17, ERR_INVALID_APP_ID = 101, ERR_INVALID_CHANNEL_NAME = 102, ERR_NO_SERVER_RESOURCES = 103, ERR_LOOKUP_CHANNEL_REJECTED = 105, ERR_OPEN_CHANNEL_REJECTED = 107, ERR_TOKEN_EXPIRED = 109, ERR_INVALID_TOKEN = 110, ERR_DYNAMIC_TOKEN_BUT_USE_STATIC_KEY = 115, ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119 , ERR_OPEN_CHANNEL_INVALID_TICKET = 121, ERR_OPEN_CHANNEL_TRY_NEXT_VOS = 122, ERR_CLIENT_IS_BANNED_BY_SERVER = 123, ERR_SEND_VIDEO_OVER_BANDWIDTH_LIMIT = 200, ERR_AUDIO_DECODER_NOT_MATCH_AUDIO_FRAME = 201, ERR_NO_AUDIO_DECODER_TO_HANDLE_AUDIO_FRAME = 202 }

enum	user_offline_reason_e { USER_OFFLINE_QUIT = 0, USER_OFFLINE_DROPPED = 1 }

enum	rtc_log_level_e { RTC_LOG_DEFAULT = 0, RTC_LOG_EMERG, RTC_LOG_ALERT, RTC_LOG_ERROR, RTC_LOG_WARNING, RTC_LOG_CRIT, RTC_LOG_NOTICE, RTC_LOG_INFO, RTC_LOG_DEBUG }

enum	area_code_e { AREA_CODE_CN = 0x00000001, AREA_CODE_NA = 0x00000002, AREA_CODE_EU = 0x00000004, AREA_CODE_AS = 0x00000008, AREA_CODE_JP = 0x00000010, AREA_CODE_IN = 0x00000020 , AREA_CODE_GLOB = (0xFFFFFFFF) }

enum	video_data_type_e { VIDEO_DATA_TYPE_YUV420 = 0, VIDEO_DATA_TYPE_H264 = 2, VIDEO_DATA_TYPE_GENERIC = 6, VIDEO_DATA_TYPE_GENERIC_JPEG = 20 }

enum	video_frame_type_e { VIDEO_FRAME_KEY = 3, VIDEO_FRAME_DELTA = 4 }

enum	video_frame_rate_e { VIDEO_FRAME_RATE_FPS_1 = 1, VIDEO_FRAME_RATE_FPS_7 = 7, VIDEO_FRAME_RATE_FPS_10 = 10, VIDEO_FRAME_RATE_FPS_15 = 15, VIDEO_FRAME_RATE_FPS_24 = 24, VIDEO_FRAME_RATE_FPS_30 = 30, VIDEO_FRAME_RATE_FPS_60 = 60 }

enum	audio_data_type_e { AUDIO_DATA_TYPE_OPUS = 1, AUDIO_DATA_TYPE_PCMA = 3, AUDIO_DATA_TYPE_PCMU = 4, AUDIO_DATA_TYPE_G722 = 5, AUDIO_DATA_TYPE_AACLC = 8, AUDIO_DATA_TYPE_HEAAC = 9, AUDIO_DATA_TYPE_PCM = 100, AUDIO_DATA_TYPE_GENERIC = 253 }

enum	audio_codec_type_e { AUDIO_CODEC_DISABLED = 0, AUDIO_CODEC_TYPE_OPUS = 1, AUDIO_CODEC_TYPE_G722 = 2, AUDIO_CODEC_TYPE_PCMU = 3 }

enum	cloud_proxy_type_e { CLOUD_PROXY_NONE = 0, CLOUD_PROXY_UDP = 1, CLOUD_PROXY_TCP = 3, CLOUD_PROXY_AUTO = 100 }

enum	rtm_event_type_e { RTM_EVENT_TYPE_LOGIN = 0, RTM_EVENT_TYPE_KICKOFF = 1, RTM_EVENT_TYPE_EXIT = 2 }

enum	rtm_err_code_e { ERR_RTM_OK = 0, ERR_RTM_FAILED = 1, ERR_RTM_LOGIN_REJECTED = 2, ERR_RTM_INVALID_RTM_UID = 3, ERR_RTM_LOGIN_INVALID_TOKEN = 5, ERR_RTM_LOGIN_NOT_AUTHORIZED = 7, ERR_RTM_INVALID_APP_ID = ERR_INVALID_APP_ID, WARN_RTM_LOOKUP_CHANNEL_REJECTED = ERR_LOOKUP_CHANNEL_REJECTED, ERR_RTM_TOKEN_EXPIRED = ERR_TOKEN_EXPIRED, ERR_RTM_INVALID_TOKEN = ERR_INVALID_TOKEN }

函数
const char *	agora_rtc_get_version (void)

__agora_api__ const char *	agora_rtc_err_2_str (int err)

__agora_api__ int	agora_rtc_license_gen_credential (char credential, unsigned int credential_len)

__agora_api__ int	agora_rtc_license_verify (const char certificate, int certificate_len, const char credential, int credential_len)

__agora_api__ int	agora_rtc_init (const char app_id, const agora_rtc_event_handler_t event_handler, rtc_service_option_t *option)

__agora_api__ int	agora_rtc_set_log_level (rtc_log_level_e level)

__agora_api__ int	agora_rtc_config_log (int size_per_file, int max_file_count)

__agora_api__ int	agora_rtc_join_channel (const char channel, const char user_id, const void token_ptr, size_t token_len, rtc_channel_options_t options)

__agora_api__ int	agora_rtc_leave_channel (const char *channel)

__agora_api__ int	agora_rtc_renew_token (const char channel, const void token_ptr, size_t token_len)

__agora_api__ int	agora_rtc_mute_local_audio (const char *channel, int mute)

__agora_api__ int	agora_rtc_mute_local_video (const char *channel, int mute)

__agora_api__ int	agora_rtc_mute_remote_audio (const char *channel, uint32_t remote_uid, int mute)

__agora_api__ int	agora_rtc_mute_remote_video (const char *channel, uint32_t remote_uid, int mute)

__agora_api__ int	agora_rtc_request_video_key_frame (const char *channel, uint32_t remote_uid, uint8_t stream_id)

__agora_api__ int	agora_rtc_send_audio_data (const char channel, const void data_ptr, size_t data_len, audio_frame_info_t *info_ptr)

__agora_api__ int	agora_rtc_send_video_data (const char channel, uint8_t stream_id, const void data_ptr, size_t data_len, video_frame_info_t *info_ptr)

__agora_api__ int	agora_rtc_login_rtm (const char rtm_uid, const char rtm_token, const agora_rtm_handler_t *handler)

__agora_api__ int	agora_rtc_logout_rtm (void)

__agora_api__ int	agora_rtc_send_rtm_data (const char rtm_uid, uint32_t msg_id, const void msg, size_t msg_len)

__agora_api__ int	agora_rtc_set_bwe_param (uint32_t min_bps, uint32_t max_bps, uint32_t start_bps)

__agora_api__ int	agora_rtc_set_cloud_proxy (cloud_proxy_type_e type)

__agora_api__ int	agora_rtc_set_params (const char *params)

__agora_api__ int	agora_rtc_fini (void)

宏定义说明

◆ __agora_api__

#define __agora_api__

◆ AGORA_CERTIFICATE_MAX_LEN

#define AGORA_CERTIFICATE_MAX_LEN 1024

◆ AGORA_CREDENTIAL_MAX_LEN

#define AGORA_CREDENTIAL_MAX_LEN 256

◆ AGORA_RTM_DATA_MAX_LEN

#define AGORA_RTM_DATA_MAX_LEN (32 * 1024)

◆ AGORA_RTM_UID_MAX_LEN

#define AGORA_RTM_UID_MAX_LEN 64

枚举类型说明

◆ agora_err_code_e

enum agora_err_code_e

错误码。

枚举值
ERR_OKAY	0: 无错误。
ERR_FAILED	1: 通用错误。你可以根据日志文件排查问题。
ERR_NET_DOWN	14: 网络不可用。你需要检查系统网络连接状态。
ERR_JOIN_CHANNEL_REJECTED	17: 加入频道请求被拒绝，可能是因为本地用户已在频道内。你需要调整代码逻辑，避免用户加入同一频道。
ERR_INVALID_APP_ID	101: App ID 无效。你需要检查 App ID 是否符合要求。
ERR_INVALID_CHANNEL_NAME	102: 频道名无效。你需要检查频道名是否符合要求。
ERR_NO_SERVER_RESOURCES	103: 在当前的区域限制码条件下无可用服务器资源
ERR_LOOKUP_CHANNEL_REJECTED	105: Agora 服务器拒绝了查询频道的请求。你需要检查 Token 是否有效。
ERR_OPEN_CHANNEL_REJECTED	107: Agora 服务器拒绝了创建频道的请求。你需要检查 Token 是否有效。
ERR_TOKEN_EXPIRED	109: 当前使用的 Token 过期，不再有效。一般有以下原因： Token 授权时间戳无效：Token 授权时间戳为 Token 生成时的时间戳，自 1970 年 1 月 1 日开始到当前时间的描述。授权该 Token 在生成后的 24 小时内可以访问 Agora 服务。如果 24 小时内没有访问，则该 Token 无法再使用。需要重新在服务端申请生成 Token。 Token 服务到期时间戳已过期：用户设置的服务到期时间戳小于当前时间戳，无法继续使用 Agora 服务（比如正在进行的通话会被强制终止）；设置服务到期时间并不意味着 Token 失效，而仅仅用于限制用户使用当前服务的时间。需要重新在服务端申请生成 Token。
ERR_INVALID_TOKEN	110: Token 无效，可能有以下原因：你在 Agora 控制台开启了 App 证书，但仍旧在代码里仅使用了 App ID。当启用了 App Certificate，必须使用 Token。生成 token 使用的 uid 必须和加入频道时使用的 uid 保持一致。
ERR_DYNAMIC_TOKEN_BUT_USE_STATIC_KEY	115: 你的项目已开启 Token 鉴权，但在加入频道时并未提供有效的 Token。请确保在调用 `agora_rtc_join_channel` 时使用了有效的 Token。
ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED	119: 切换用户角色失败，请尝试重新加入频道。
ERR_OPEN_CHANNEL_INVALID_TICKET	121: 打开频道的信令错误。请尝试重新加入频道。
ERR_OPEN_CHANNEL_TRY_NEXT_VOS	122: 系统在尝试切换服务器。通常不需要额外处理，系统会自动尝试切换服务器以打开频道。
ERR_CLIENT_IS_BANNED_BY_SERVER	123: 该客户端被服务器禁用。你需要检查该用户是否被踢。
ERR_SEND_VIDEO_OVER_BANDWIDTH_LIMIT	200: 视频帧发送速率超过带宽限制。可能会造成丢包。你可以通过 `on_target_bitrate_changed` 回调带宽参数调整码率。
ERR_AUDIO_DECODER_NOT_MATCH_AUDIO_FRAME	201: 设置的编码类型与实际编码类型不符导致 SDK 解码失败。你需要确认 SDK 设置的编码类型是否与实际传输的编码类型一致。
ERR_NO_AUDIO_DECODER_TO_HANDLE_AUDIO_FRAME	202: SDK 解码失败。SDK 内置的解码器仅支持 Opus、G722 和 PCMU 编码的音频帧。你需要确认对端发送的音频码流是否为 Opus 、G722 或 PCMU 编码格式。

◆ area_code_e

enum area_code_e

访问区域。

枚举值
AREA_CODE_CN	0x00000001: 中国大陆。
AREA_CODE_NA	0x00000002: 北美。
AREA_CODE_EU	0x00000004: 欧洲。
AREA_CODE_AS	0x00000008: 亚洲（除中国大陆）。
AREA_CODE_JP	0x00000010: 日本。
AREA_CODE_IN	0x00000020: 印度。
AREA_CODE_GLOB	0xFFFFFFFF: 全球 (默认)。

◆ audio_codec_type_e

enum audio_codec_type_e

SDK 内置的音频编解码器。

枚举值
AUDIO_CODEC_DISABLED	0: 关闭 SDK 内置音频编解码器。
AUDIO_CODEC_TYPE_OPUS	1: 使用 SDK 内置的 Opus 编解码器进行音频编、解码。
AUDIO_CODEC_TYPE_G722	2: 使用 SDK 内置的 G722 编解码器进行音频编、解码。
AUDIO_CODEC_TYPE_PCMU	3: 使用 SDK 内置的 G711（PCMU）编解码器进行音频编、解码。

◆ audio_data_type_e

enum audio_data_type_e

音频数据的编码格式。

枚举值
AUDIO_DATA_TYPE_OPUS	1: Opus
AUDIO_DATA_TYPE_PCMA	3: PCMA
AUDIO_DATA_TYPE_PCMU	4: PCMU
AUDIO_DATA_TYPE_G722	5: G722
AUDIO_DATA_TYPE_AACLC	8: AACLC
AUDIO_DATA_TYPE_HEAAC	9: HEAAC
AUDIO_DATA_TYPE_PCM	100: PCM。SDK 支持将 PCM 数据转换为 Opus、G722 或 PCMU 格式。
AUDIO_DATA_TYPE_GENERIC	253: Generic

◆ cloud_proxy_type_e

enum cloud_proxy_type_e

云代理类型

枚举值
CLOUD_PROXY_NONE	不开启云代理。
CLOUD_PROXY_UDP	开启 UDP 协议的云代理。
CLOUD_PROXY_TCP	开启 TCP 协议的云代理。
CLOUD_PROXY_AUTO	自动模式。在该模式下，SDK 优先连接 SD-RTN™，如果连接失败，自动切换到 TCP 协议的云代理。

◆ rtc_log_level_e

enum rtc_log_level_e

日志输出级别。

枚举值
RTC_LOG_DEFAULT	（默认）输出 EMERG、ALERT、CRIT、ERROR、WARNING、NOTICE 级别的日志。
RTC_LOG_EMERG	输出 EMERG 级别的日志。
RTC_LOG_ALERT	输出 EMERG、ALERT 级别的日志。
RTC_LOG_ERROR	输出 EMERG、ALERT、CRIT、ERROR 级别的日志。
RTC_LOG_WARNING	输出 EMERG、ALERT、CRIT、ERROR、WARNING 级别的日志。
RTC_LOG_CRIT	输出 EMERG、ALERT、CRIT 级别的日志。
RTC_LOG_NOTICE	（默认）输出 EMERG、ALERT、CRIT、ERROR、WARNING、NOTICE 级别的日志。
RTC_LOG_INFO	输出 EMERG、ALERT、CRIT、ERROR、WARNING、NOTICE、INFO 级别的日志。
RTC_LOG_DEBUG	输出所有 API 日志信息。如果你想获取最完整的日志，可以将日志级别设为该等级。

◆ rtm_err_code_e

enum rtm_err_code_e

枚举值
ERR_RTM_OK	0: 方法调用成功或登录成功。
ERR_RTM_FAILED	1: 通用错误。你可以根据日志文件排查问题。
ERR_RTM_LOGIN_REJECTED	2: Agora 服务器拒绝了登录云信令 (原 RTM) 的请求。你需要检查 RTM Token、App ID、User ID 是否符合要求。
ERR_RTM_INVALID_RTM_UID	3: 云信令 (原 RTM) 用户 ID 无效。你需要检查 User ID 是否符合要求。
ERR_RTM_LOGIN_INVALID_TOKEN	5: 云信令 (原 RTM) Token 无效。你需要检查 Token 是否符合要求。
ERR_RTM_LOGIN_NOT_AUTHORIZED	7: 未经授权的登录。你需要先进行登录，再进行其他操作。
ERR_RTM_INVALID_APP_ID	101: 云信令 (原 RTM) App ID 无效。你需要检查 App ID 是否符合要求。
WARN_RTM_LOOKUP_CHANNEL_REJECTED	105: Agora 服务器拒绝了查询云信令 (原 RTM) 频道的请求。你需要检查 Token 是否符合要求。
ERR_RTM_TOKEN_EXPIRED	109: 云信令 (原 RTM) Token 已过期。你需要重新生成 RTM Token。
ERR_RTM_INVALID_TOKEN	110: 云信令 (原 RTM) Token 无效。你需要检查 Token 是否符合要求。

◆ rtm_event_type_e

enum rtm_event_type_e

RTM 云信令 (原 RTM) 事件类型。

枚举值
RTM_EVENT_TYPE_LOGIN	0: 用户成功登录云信令 (原 RTM) 服务。
RTM_EVENT_TYPE_KICKOFF	1: 用户被踢出。
RTM_EVENT_TYPE_EXIT	2: 用户成功登出云信令 (原 RTM) 服务。

◆ user_offline_reason_e

enum user_offline_reason_e

远端用户离线原因。

枚举值
USER_OFFLINE_QUIT	0: 远端用户主动离开。
USER_OFFLINE_DROPPED	1: 远端用户超时掉线。

◆ video_data_type_e

enum video_data_type_e

视频编码格式。

枚举值
VIDEO_DATA_TYPE_YUV420	0: YUV420 （暂不支持）
VIDEO_DATA_TYPE_H264	2: H.264
VIDEO_DATA_TYPE_GENERIC	6: Generic
VIDEO_DATA_TYPE_GENERIC_JPEG	20: Generic JPEG

◆ video_frame_rate_e

enum video_frame_rate_e

视频帧率。

枚举值
VIDEO_FRAME_RATE_FPS_1	1: 1 fps
VIDEO_FRAME_RATE_FPS_7	7: 7 fps
VIDEO_FRAME_RATE_FPS_10	10: 10 fps
VIDEO_FRAME_RATE_FPS_15	15: 15 fps
VIDEO_FRAME_RATE_FPS_24	24: 24 fps
VIDEO_FRAME_RATE_FPS_30	30: 30 fps
VIDEO_FRAME_RATE_FPS_60	60: 60 fps。仅适用于 Windows 和 macOS。

◆ video_frame_type_e

enum video_frame_type_e

视频帧类型。

枚举值
VIDEO_FRAME_KEY	3: 关键帧。
VIDEO_FRAME_DELTA	4: Delta 帧，例如 P-Frame。

函数说明

◆ agora_rtc_config_log()

__agora_api__ int agora_rtc_config_log	(	int	size_per_file,
		int	max_file_count
	)

配置 Agora SDK 的日志文件。

参数

[in]	size_per_file	每份日志文件的大小（字节）。取值范围为 [0, 1010241024]。默认值为 110241024，即 1 MB。如果你将此参数设为 0，则代表关闭日志功能。
[in]	max_file_count	日志文件数。取值范围为 [0, 100]。默认值为 10。如果你将此参数设为 0，则代表关闭日志功能。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_err_2_str()

__agora_api__ const char* agora_rtc_err_2_str ( int err )

将错误码转为静态字符串，以便查看错误描述。

注解: 使用后不必释放。

参数

[in] err 错误码。

返回: 静态字符串。

◆ agora_rtc_fini()

__agora_api__ int agora_rtc_fini ( void )

释放所有由 agora_rtc_init 方法分配给 Agora RTSA 服务的资源。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_get_version()

const char* agora_rtc_get_version ( void )

获取 SDK 版本。

返回: 包含 SDK 版本信息的静态字符串。

◆ agora_rtc_init()

__agora_api__ int agora_rtc_init	(	const char *	app_id,
		const agora_rtc_event_handler_t *	event_handler,
		rtc_service_option_t *	option
	)

初始化 Agora RTSA 服务。

注解

每个进程只能初始化一次。
该方法可以使用 int 型的 UID 进行初始化，也可以使用 String 型用户名进行初始化。
SDK 每次初始化时会在指定的目录下自动创建一个新文件夹（随机命名），用于存放此次运行的日志。 SDK 不负责回收上一次初始化时创建的文件夹。为了避免日志占用过多空间，建议每次初始化之前先清空日志文件夹。

参数

[in]	app_id	Agora 为 App 开发者签发的 APP ID。
[in]	event_handler	用于处理 Agora SDK 事件的一系列回调。
[in]	option	RTSA 服务配置选项，包括限定访问区域。详见 rtc_service_option_t 。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_join_channel()

__agora_api__ int agora_rtc_join_channel	(	const char *	channel,
		const char *	user_id,
		const void *	token_ptr,
		size_t	token_len,
		rtc_channel_options_t *	options
	)

加入频道。

该方法让本地用户加入指定频道。同一个频道内使用相同 App ID 的用户可以互相传输数据。

注解: 你可以同时加入多个频道，所有你加入的频道都能接收到你发送的音视频数据。

参数

[in]	channel	频道名，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 89 个字符）： 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "\|", "~", ","
[in]	user_id	用户 ID。你需要根据 rtc_service_option_t 中 `use_string_ui` 的值进行不同设置：如果 `use_string_uid` 为 `false`，`user_id` 仅支持数字作为字符且数字大小范围为 (0, 4294967295 字节)。如果你需要 SDK 自动分配一个 user ID，可以将 `user_id` 设为 "0" 或 NULL。如果 `use_string_uid` 为 `true`，`user_id` 可设为任意字符，例如 "agora-user0"。成功加入后会触发 `on_local_user_registered` 回调。
[in]	token_ptr	用于鉴权的 Token。如果用户启用的是 App ID，可以将该值设为 `NULL`。如果用户想使用 Token，Agora 还会给开发者分发一个 App Certificate，并结合 Token 的算法在 App 的服务器端生成 Token。与 App ID 相比，Token 适用于安全要求较高的开发环境。
[in]	token_len	Token 的内存大小（字节），取值范围为 [32, 512]。如果用户启用的是 App ID，则设为 0。
[in]	options	频道设置选项。详见 rtc_channel_options_t 。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_leave_channel()

__agora_api__ int agora_rtc_leave_channel ( const char * channel )

离开频道。

停止在某频道传输数据后需要离开该频道。

参数

[in] channel 频道名。设为 NULL 则离开所有频道。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_license_gen_credential()

__agora_api__ int agora_rtc_license_gen_credential	(	char *	credential,
		unsigned int *	credential_len
	)

生成设备唯一标识 Credential。

注解: 该方法仅用于 Agora License 机制。如不使用 License，可忽略该方法。

参数

[out]	credential	用于存放 Credential 的缓冲区。
[in,out]	credential_len	缓冲区大小（字节）。输入值用于确认缓冲区的可用长度（字节），需大于 `AGORA_CREDENTIAL_MAX_LEN`。输出值为 Credential 的实际长度（字节）。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_license_verify()

__agora_api__ int agora_rtc_license_verify	(	const char *	certificate,
		int	certificate_len,
		const char *	credential,
		int	credential_len
	)

认证 SDK。

启用了 Agora License 机制后，安装了 Agora SDK 的设备只有通过 Certificate 验证才能加入 Agora 频道、使用数据传输功能。

注解

该方法仅用于 Agora License 机制。如不使用 License，可忽略该方法。
该方法必须在 agora_rtc_init 前调用。认证通过后，你才能有效调用 RTSA SDK 的其他 API。

参数

[in]	certificate	许可证 Certificate。
[in]	certificate_len	许可证长度。
[in]	credential	凭证 Credential。
[in]	credential_len	凭证长度。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_login_rtm()

__agora_api__ int agora_rtc_login_rtm	(	const char *	rtm_uid,
		const char *	rtm_token,
		const agora_rtm_handler_t *	handler
	)

登录云信令 (原 RTM) 服务。

参数

[in]	rtm_uid	云信令 (原 RTM) 用户 ID。该字符串不可超过 64 字节。不可设为空、`NULL` 或 `"NULL"`。以下为支持的字符集范围: 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "\|", "~", ","
[in]	rtm_token	用于登录云信令 (原 RTM) 系统的动态密钥。详见《校验用户权限》。如果你没有开启 Token 鉴权，此参数可设为 `NULL`。
[in]	handler	云信令 (原 RTM) 回调。详见 agora_rtm_handler_t 。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_logout_rtm()

__agora_api__ int agora_rtc_logout_rtm ( void )

登出云信令 (原 RTM) 服务。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_mute_local_audio()

__agora_api__ int agora_rtc_mute_local_audio	(	const char *	channel,
		int	mute
	)

暂停／恢复发送本地音频流。

可以先暂停向所有频道发送音频流，然后恢复向指定频道发送音频流。

参数

[in]	channel	频道名。如果为所有频道（包括所有未来将加入的频道），则设为 NULL。
[in]	mute	暂停／恢复发送本地音频流： 0:（默认）发送本地音频流。其他值: 暂停发送本地音频流。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_mute_local_video()

__agora_api__ int agora_rtc_mute_local_video	(	const char *	channel,
		int	mute
	)

暂停／恢复发送本地视频流。

可以先暂停向所有频道发送视频流，然后恢复向指定频道发送视频流。

参数

[in]	channel	频道名。如果为所有频道（包括所有未来将加入的频道），则设为 NULL。
[in]	mute	暂停／恢复发送本地视频流： 0:（默认）发送本地视频流。其他值: 暂停发送本地视频流。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_mute_remote_audio()

__agora_api__ int agora_rtc_mute_remote_audio	(	const char *	channel,
		uint32_t	remote_uid,
		int	mute
	)

暂停／恢复接收指定频道内指定远端用户的音频流。

可以先暂停接收所有频道的音频流，然后恢复接收某个指定频道的音频流。

参数

[in]	channel	频道名。如果为所有频道（包括所有未来将加入的频道），则设为 NULL。
[in]	remote_uid	远端用户 ID。设为 0 则停止接收频道内所有用户的音频流。
[in]	mute	暂停／恢复接收远端音频流： 0:（默认）接收远端音频流。其他值: 暂停接收远端音频流。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_mute_remote_video()

__agora_api__ int agora_rtc_mute_remote_video	(	const char *	channel,
		uint32_t	remote_uid,
		int	mute
	)

暂停／恢复接收指定频道内指定远端用户的视频流。

可以先暂停接收所有频道的视频流，然后恢复接收指定频道的视频流。

参数

[in]	channel	频道名。如果为所有频道（包括所有未来将加入的频道），则设为 NULL。
[in]	remote_uid	远端用户 ID。设为 0 则停止接收频道内所有用户的视频流。
[in]	mute	暂停／恢复接收远端视频流： 0: （默认）接收远端视频流。其他值: 暂停接收远端视频流。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_renew_token()

__agora_api__ int agora_rtc_renew_token	(	const char *	channel,
		const void *	token_ptr,
		size_t	token_len
	)

更新 Token。

注解: Token 的使用可以提高生产环境下应用程序的安全性。

参数

[in]	channel	频道名。如果为所有加入的频道，则设为 NULL。
[in]	token_ptr	指向 Token 内存地址的指针。
[in]	token_len	Token 的内存大小（字节），取值范围为 [32, 512]。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_request_video_key_frame()

__agora_api__ int agora_rtc_request_video_key_frame	(	const char *	channel,
		uint32_t	remote_uid,
		uint8_t	stream_id
	)

请求指定远端用户为指定远端视频流生成关键帧。

参数

[in]	channel	频道名。如果为所有频道，则设为 NULL。
[in]	remote_uid	远端用户 ID。如果为频道内的所有用户，则设为 0。
[in]	stream_id	视频流 ID。如果为所有视频流，则设为 0。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_send_audio_data()

__agora_api__ int agora_rtc_send_audio_data	(	const char *	channel,
		const void *	data_ptr,
		size_t	data_len,
		audio_frame_info_t *	info_ptr
	)

向加入的频道发送音频帧。

频道内所有用户都能收到你发出的音频帧。

注解: 你加入的所有频道都会收到你发送的音频帧，除非你暂停向指定频道发送音频帧。

参数

[in]	channel	发送音频帧的目标频道。设为 NULL 则发送音频帧到所有加入的频道。
[in]	data_ptr	音频包数据。
[in]	data_len	音频包数据大小（字节）。
[in]	info_ptr	音频帧配置，详见 audio_frame_info_t 。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_send_rtm_data()

__agora_api__ int agora_rtc_send_rtm_data	(	const char *	rtm_uid,
		uint32_t	msg_id,
		const void *	msg,
		size_t	msg_len
	)

通过云信令 (原 RTM) 服务发送消息。

注解: 成功登录云信令 (原 RTM) 服务并收到 on_rtm_event 回调时才可以发送消息。发送频率不能超过每 3 秒 180 条。

参数

[in]	rtm_uid	云信令 (原 RTM) 用户 ID。
[in]	msg_id	消息 ID。
[in]	msg	消息内容。仅支持 UTF-8 编码。
[in]	msg_len	消息长度，单位是字节。最大不得超过 32 KB。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_send_video_data()

__agora_api__ int agora_rtc_send_video_data	(	const char *	channel,
		uint8_t	stream_id,
		const void *	data_ptr,
		size_t	data_len,
		video_frame_info_t *	info_ptr
	)

向加入的频道发送视频帧。

频道内所有用户都能收到你发出的视频帧。

注解: 你加入的所有频道都会接收到你发送的视频帧，除非你暂停向指定频道发送视频帧。

参数

[in]	channel	发送视频帧的目标频道。设为 `NULL` 则发送视频帧到所有加入的频道。
[in]	stream_id	视频流的 ID。取值范围为 [0, 15]。你还可以使用此参数选择发送大流或小流。 `0`: SDK 会发送大流。 `1`: SDK 会发送小流。
[in]	data_ptr	视频包数据。
[in]	data_len	视频包数据大小（字节）。
[in]	info_ptr	视频帧配置，详见 video_frame_info_t 。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_set_bwe_param()

__agora_api__ int agora_rtc_set_bwe_param	(	uint32_t	min_bps,
		uint32_t	max_bps,
		uint32_t	start_bps
	)

设置 bandwidth estimation (BWE) 参数。

参数

[in]	min_bps	最大码率，单位为 bps。
[in]	max_bps	最小码率，单位为 bps。
[in]	start_bps	起始码率，单位为 bps。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_set_cloud_proxy()

__agora_api__ int agora_rtc_set_cloud_proxy ( cloud_proxy_type_e type )

设置 Agora 云代理服务。

参数

[in] type 云代理类型。参考 cloud_proxy_type_e 。

返回: 0: 方法调用成功。 < 0: 方法调用失败。

◆ agora_rtc_set_log_level()

__agora_api__ int agora_rtc_set_log_level ( rtc_log_level_e level )

设置 Agora SDK 的日志输出等级。

设置一个级别后，你可以看到该级别及之前所有级别的日志信息。

参数

[in] level 日志输出等级。详见 rtc_log_level_e 。

返回

0: 方法调用成功。
<0: 方法调用失败。

◆ agora_rtc_set_params()

__agora_api__ int agora_rtc_set_params ( const char * params )

通过 JSON 配置 SDK 提供技术预览或特别定制功能。

JSON 选项默认不公开。声网工程师正在努力寻求以标准化方式公开 JSON 选项。

参数

[in] params : JSON 字符串形式的参数。

返回

0: 方法调用成功。
<0: 方法调用失败。

Agora RTSA C API Reference for Linux

结构体

宏定义

枚举

函数

宏定义说明

◆ __agora_api__

◆ AGORA_CERTIFICATE_MAX_LEN

◆ AGORA_CREDENTIAL_MAX_LEN

◆ AGORA_RTM_DATA_MAX_LEN

◆ AGORA_RTM_UID_MAX_LEN

枚举类型说明

◆ agora_err_code_e

◆ area_code_e

◆ audio_codec_type_e

◆ audio_data_type_e

◆ cloud_proxy_type_e

◆ rtc_log_level_e

◆ rtm_err_code_e

◆ rtm_event_type_e

◆ user_offline_reason_e

◆ video_data_type_e

◆ video_frame_rate_e

◆ video_frame_type_e

函数说明

◆ agora_rtc_config_log()

◆ agora_rtc_err_2_str()

◆ agora_rtc_fini()

◆ agora_rtc_get_version()

◆ agora_rtc_init()

◆ agora_rtc_join_channel()

◆ agora_rtc_leave_channel()

◆ agora_rtc_license_gen_credential()

◆ agora_rtc_license_verify()

◆ agora_rtc_login_rtm()

◆ agora_rtc_logout_rtm()

◆ agora_rtc_mute_local_audio()

◆ agora_rtc_mute_local_video()

◆ agora_rtc_mute_remote_audio()

◆ agora_rtc_mute_remote_video()

◆ agora_rtc_renew_token()

◆ agora_rtc_request_video_key_frame()

◆ agora_rtc_send_audio_data()

◆ agora_rtc_send_rtm_data()

◆ agora_rtc_send_video_data()

◆ agora_rtc_set_bwe_param()

◆ agora_rtc_set_cloud_proxy()

◆ agora_rtc_set_log_level()

◆ agora_rtc_set_params()