接口说明

目录

详情

• alirts_get_version：获取SDK当前版本号。

  const char *alirts_get_version();

  返回说明

  返回SDK版本号。

• alirts_set_log：设置SDK日志输出级别及路径。

  int alirts_set_log(alirts_log_level_e level, const char * dir);

  参数说明

  参数	类型	描述
  level	alirts_log_level_e	日志等级。详情请参见SDK文件ali_rts_sdk.h中的alirts_log_level_e定义。
  dir	const char *	日志文件存储路径，参数为NULL表示不写本地日志。 说明 如果已设置on_log_data日志回调，则SDK不写本地日志，仅回调日志。

  返回说明

  返回0表示调用成功，小于0表示调用失败。

• alirts_create：创建SDK实例。

  alirts_handler_t *alirts_create(const alirts_event_handler_t *event_handler);

  参数说明

  参数	类型	描述
  event_handler	const alirts_event_handler_t *	事件回调句柄，SDK通过该句柄回调事件。

  返回说明

  返回SDK句柄表示调用成功，NULL表示调用失败。

• alirts_start：启动RTS推流，根据输入配置启动音视频编码器，与CDN服务端建立连接。

  int alirts_start(alirts_handler_t *handler, const alirts_config_t *config);

  参数说明

  参数	类型	描述
  handler	alirts_handler_t *	SDK实例句柄。
  config	const alirts_config_t *	推流配置。

  返回说明

  返回0表示调用成功，小于0表示调用失败。

  说明 此接口调用成功后会触发on_push_start事件回调，之后可以调用alirts_send_frame发送音视频数据。
• alirts_send_frame：发送音视频媒体数据。

  int alirts_send_frame(const alirts_handler_t *handler, const alirts_frame_t *frame);

  参数说明

  参数	类型	描述
  handler	const alirts_handler_t *	SDK实例句柄。
  frame	const alirts_frame_t *	音视频帧数据。

  返回说明

  返回0表示调用成功，小于0表示调用失败。

  说明 建议在on_push_start事件回调之后调用此接口发送音视频数据。
• alirts_get_statistics_info：获取推流统计信息。

  int alirts_get_statistics_info(const alirts_handler_t *handler, alirts_push_info_t *info);

  参数说明

  参数	类型	描述
  handler	const alirts_handler_t *	SDK实例句柄。
  info	alirts_push_info_t *	当前推流统计信息。

  返回说明

  返回0表示调用成功，小于0表示调用失败。

  注意 请勿频繁调用此接口，建议调用间隔不小于1秒。
• alirts_stop：停止推流，释放编码器与CDN断开连接。

  void alirts_stop(alirts_handler_t *handler);

  参数说明

  参数	类型	描述
  handler	alirts_handler_t *	SDK实例句柄。

  说明 此接口调用成功后会触发on_push_stop事件回调。
• alirts_destroy：释放SDK实例。

  void alirts_destroy(alirts_handler_t *handler);

  参数说明

  参数	类型	描述
  handler	alirts_handler_t *	SDK实例句柄。