本页介绍通过 RTSA Lite SDK 实现码流传输涉及的 API 方法和调用流程。

1. 进行认证

RTSA 通过 License 对设备鉴权。License 与设备绑定，一个 License 在同一时间只能绑定一个设备。

自 v1.4.2 起，SDK 下载包中包含了许可证文件，因此你无需购买商用 License 即可直接试用 RTSA Lite SDK 提供的示例项目。试用时效为 90 天且存在 10 路并发限制。 如果你需要在生产环境使用 RTSA Lite SDK，请联系 sales@agora.io 购买商用 License。

调用 RTSA Lite 的其他 API 前，你需要调用 agora_rtc_license_verify 方法完成认证，传入许可证 Certificate 和相应长度 certificate_len 。

示例代码如下，仅供参考：

/** ----------------PERSUDO CODE -----------------
 *  Load license files: certificate & credential
 *  Please replace it with your own implementation
 *  ----------------------------------------------
 */
app_load_license_file(certificate_file_path, str_certificate, &str_certificate_len);
app_load_license_file(credential_file_path, str_credential, &str_credential_len);

int rval = agora_rtc_license_verify(str_certificate, str_certificate_len, NULL, 0);

2. 初始化和监听事件

调用 agora_rtc_init 方法初始化 RTSA 服务。

在该方法中，你需要：

• 填入获取到的 App ID。只有 App ID 相同的应用程序才能进入同一个频道进行互通。
• 设置事件回调 agora_rtc_event_handler_t，用以通知 SDK 在运行过程中发生的事件。
• 设置用于存放 SDK 日志的目录（设为 NULL 表示使用默认目录）。
• （可选）通过 rtc_service_option_t 结构体设置 RTSA 服务选项。

static void __on_join_channel_success(const char *channel, int elapsed)
{
    g_app.b_connected_flag = true;
    LOGI("Join the channel \"%s\" successfully, elapsed %d ms", channel, elapsed);
}

static void __on_connection_lost(const char *channel)
{
    g_app.b_connected_flag = false;
    LOGW("Lost connection from the channel \"%s\"", channel);
}

static void __on_rejoin_channel_success(const char *channel, int elapsed_ms)
{
    g_app.b_connected_flag = true;
    LOGI("Rejoin the channel \"%s\" successfully, elapsed %d ms", channel, elapsed_ms);
}

static void __on_user_joined(const char *channel, uint32_t uid, int elapsed_ms)
{
    LOGI("Remote user \"%u\" has joined the channel \"%s\", elapsed %d ms", uid, channel,
         elapsed_ms);
}

static void __on_user_offline(const char *channel, uint32_t uid, int reason)
{
    LOGI("Remote user \"%u\" has left the channel \"%s\", reason %d", uid, channel, reason);
}

static void __on_error(const char *channel, int code, const char *msg)
{
    if (code == ERR_SEND_VIDEO_OVER_BANDWIDTH_LIMIT) {
        LOGE("Not enough uplink bandwdith. Error msg \"%s\"", msg);
        return;
    }

    if (code == ERR_INVALID_APP_ID) {
        LOGE("Invalid App ID. Please double check. Error msg \"%s\"", msg);
    } else if (code == ERR_INVALID_CHANNEL_NAME) {
        LOGE("Invalid channel name \"%s\". Please double check. Error msg \"%s\"", channel, msg);
    } else if (code == ERR_INVALID_TOKEN || code == ERR_TOKEN_EXPIRED) {
        LOGE("Invalid token. Please double check. Error msg \"%s\"", msg);
    } else if (code == ERR_DYNAMIC_TOKEN_BUT_USE_STATIC_KEY) {
        LOGE("Dynamic token is enabled but is not provided. Error msg \"%s\"", msg);
    } else {
        LOGW("Error %d is captured. Error msg \"%s\"", code, msg);
    }

    g_app.b_stop_flag = true;
}

static void __on_audio_data(const char *channel, const uint32_t uid, uint16_t sent_ts,
                            audio_codec_e codec, const void *data, size_t len)
{
    //LOGD("on_audio_data, uid %u, sent_ts %d, codec %d, len %zu", uid, sent_ts, codec, len);
    write_file(g_app.audio_file_writer, codec, data, len);
}

#ifndef CONFIG_AUDIO_ONLY
static void __on_video_data(const char *channel, const uint32_t uid, uint16_t sent_ts,
                            video_codec_e codec, uint8_t stream_id, int is_key_frame,
                            const void *data, size_t len)
{
    //LOGD("on_video_data: uid %u, key_frame %d, codec %u, len %zu", uid, is_key_frame, codec, len);
    write_file(g_app.video_file_writer, codec, data, len);
}

static void __on_target_bitrate_changed(const char *channel, uint32_t target_bps)
{
    LOGI("Bandwidth change detected. Please adjust encoder bitrate to %u kbps", target_bps / 1000);
}

static void __on_key_frame_gen_req(const char *channel, uint32_t uid, uint8_t stream_id)
{
    LOGW("Frame loss detected. Please notify the encoder to generate key frame immediately");
}
#endif

static agora_rtc_event_handler_t event_handler = {
    .on_join_channel_success = __on_join_channel_success,
    .on_connection_lost = __on_connection_lost,
    .on_rejoin_channel_success = __on_rejoin_channel_success,
    .on_user_joined = __on_user_joined,
    .on_user_offline = __on_user_offline,
#ifndef CONFIG_AUDIO_ONLY
    .on_target_bitrate_changed = __on_target_bitrate_changed,
    .on_key_frame_gen_req = __on_key_frame_gen_req,
    .on_video_data = __on_video_data,
#endif
    .on_error = __on_error,
    .on_audio_data = __on_audio_data,
};

...

int appid_len = strlen(config->p_appid);
rtc_service_option_t service_opt;
memset(&service_opt, 0, sizeof(service_opt));
service_opt.area_code = config->area;
void *p_appid = (void *)(appid_len == 0 ? NULL : config->p_appid);
// Init the Agora RTC engine
rval = agora_rtc_init(p_appid, &event_handler, config->p_sdk_log_dir, &service_opt);
    if (rval < 0) {
        LOGE("Failed to initialize Agora sdk, reason: %s", agora_rtc_err_2_str(rval));
        return -1;
    }

3. 加入频道

调用 agora_rtc_join_channel 方法加入频道。

在该方法中，你需要：

• 传入能标识频道的频道 ID。输入相同频道 ID 的用户会进入同一个频道。
• 传入能标识用户的用户 ID。你可以通过 rtc_service_option_t 中的 use_string_uid 参数选择使用 String 型用户名或 Int 型用户名。
• 传入能标识用户角色和权限的 Token 以及 Token 的大小。如果安全要求不高，使用的是 App ID，可以将 token 设为 nullptr，token 大小设为 0。

用户与频道的关系如下：

• 一个频道内的用户可以互相传输数据。
• 一个用户可以同时加入多个频道。该用户加入的所有频道都能接收到他发送的音视频数据。

成功加入频道后，SDK 会触发 on_join_channel_success 回调。

示例代码如下，仅供参考：

agora_rtc_join_channel ("YOUR_CHANNEL_NAME", "123456", str_token, str_token_len);

4. 发送/接收音视频流

成功加入频道后，可以：

• 监听 on_audio_data 回调接收所有你已加入的频道内的音频数据流。
• 监听 on_video_data 回调接收所有你已加入的频道内的视频数据流。
• 调用 agora_rtc_send_audio_data 方法向指定或所有你已加入的频道发送音频数据流。
• 调用 agora_rtc_send_video_data 方法向指定或所有你已加入的频道发送视频数据流。

示例代码如下，仅供参考：

static void OnAudioData (const char *channel, const uint32_t uid, uint16_t sent_ts, uint8_t codec, const void *data, size_t data_len)
{
    printf("invoked at %s@%d\n", __FUNCTION__, __LINE__);
    // ...
}
static void OnVideoData (const char *channel, const uint32_t uid, uint16_t sent_ts, uint8_t codec, uint8_t stream_id, int is_key_frame,
                         const void *data, size_t data_len)
{
    printf("invoked at %s@%d\n", __FUNCTION__, __LINE__);
    // ...
}

static const agora_rtc_event_handler_t listener = {
    .on_audio_data = OnAudioData,
    .on_video_data = OnVideoData,
    // ...
};


// Send audio data
audio_frame_info_t info;
info.codec = AUDIO_CODEC_AACLC;
agora_rtc_send_audio_data ("YOUR_CHANNEL_NAME", data_ptr, data_len, &info);


// Send video data
video_frame_info_t info;
info.codec = VIDEO_CODEC_H264;
info.type = is_key_frame_flag ? VIDEO_FRAME_KEY : VIDEO_FRAME_DELTA;
info.frames_per_sec = VIDEO_FRAME_RATE_FPS_30;
agora_rtc_send_video_data ("YOUR_CHANNEL_NAME", stream_id, data_ptr, data_len, &info);

5. 离开频道

调用 agora_rtc_leave_channel 方法离开指定频道，结束在该频道的数据传输。

示例代码如下，仅供参考：

agora_rtc_leave_channel ("YOUR_CHANNEL_NAME");