call-live-sdk 1.0.0

package/dist/api/index.d.ts

@@ -0,0 +1,438 @@
+export interface RTCStorageConfigRequest {
+    /** 允许嘉宾自我解除静音 0:否 1:是 默认:0 */
+    allow_guests_cancel_muted?: number;
+    /** 加入会议时静音 0:否 1:是 默认:0 */
+    enter_muted?: number;
+    /** 活动ID */
+    live_id: number;
+    /** 锁定模式 0:否 1:是 默认:0 */
+    lock_mode?: number;
+    /** 等待模式 0:否 1:是 默认:0 */
+    waiting_mode?: number;
+}
+export interface RTCMasterConfigRequest {
+    /** 活动ID */
+    live_id: number;
+    [property: string]: any;
+}
+export interface RTCGuestConfigRequest {
+    /** 商户ID */
+    agent_id: number;
+    /** 直播ID */
+    live_id: number;
+    /** RTC用户ID */
+    rtc_userid: string;
+    [property: string]: any;
+}
+export interface RTCGuestGetNicknameByRTCUseridRequest {
+    /** 商户ID */
+    agent_id: number;
+    /** 活动ID */
+    live_id: number;
+    /** RTC用户ID */
+    rtc_userid: string;
+    [property: string]: any;
+}
+export interface RTCGuestGetNicknameByRTCUseridResponse {
+    /** 昵称 */
+    nickname?: string;
+    [property: string]: any;
+}
+export interface RTCStartRequest {
+    /** 直播ID */
+    live_id: number;
+    [property: string]: any;
+}
+export interface RTCStopRequest {
+    /** 直播ID */
+    live_id: number;
+    [property: string]: any;
+}
+export interface RTCDismissRoomRequest {
+    /** 直播ID */
+    live_id: number;
+    [property: string]: any;
+}
+/**
+ * api.app.business.api.v1.RTCMasterConfigRes
+ */
+export interface RTCMasterConfigResponse {
+    /**
+     * 允许嘉宾自我解除静音 0:否 1:是 默认:0
+     */
+    allow_guests_cancel_muted?: number;
+    /**
+     * RTC AppID
+     */
+    appid?: string;
+    /**
+     * 画板Token
+     */
+    drawing_board_token?: string;
+    /**
+     * 画板ID
+     */
+    drawing_board_id?: string;
+    /**
+     * 加入会议时静音 0:否 1:是 默认:0
+     */
+    enter_muted?: number;
+    /**
+     * 锁定模式 0:否 1:是 默认:0
+     */
+    lock_mode?: number;
+    /**
+     * 昵称
+     */
+    nickname?: string;
+    /**
+     * 邀请密码
+     */
+    password?: string;
+    /**
+     * RTC房间ID
+     */
+    rtc_room_id: string;
+    /**
+     * 用户标识ID
+     */
+    rtc_userid?: string;
+    /**
+     * 未开始：0 ，开始：1 ，结束：2
+     */
+    status?: number;
+    /**
+     * RTC Token
+     */
+    token?: string;
+    /**
+     * 等待模式 0:否 1:是 默认:0
+     */
+    waiting_mode?: number;
+    /** 直播名称 */
+    title?: string;
+    [property: string]: any;
+}
+export interface RTCBanUserStreamRequest {
+    /** 是否封禁音频 false:维持当前状态 true:封禁音频流 */
+    audio?: boolean;
+    /** 封禁时长，取值范围为{0,[60,259200]}，单位为秒。
+     * 若传入值为空或 0  表示封禁音视频流至主动调用unbanroomuser
+     * 接口解封。若传入值大于 0，且小于10，自动修改为10。若传入值大于259200，自动修改为259200。
+     */
+    forbidden_interval: number;
+    /** 活动ID */
+    live_id: number;
+    /** RTC用户ID */
+    rtc_userid: string;
+    /** 是否封禁视频 false:维持当前状态 true:封禁视频流 */
+    video?: boolean;
+    [property: string]: any;
+}
+export interface RTCUnbanUserStreamRequest {
+    /** 是否解封音频 false:维持当前状态 true:解封音频流 */
+    audio?: boolean;
+    /** 活动ID */
+    live_id: number;
+    /** RTC用户ID */
+    rtc_userid: string;
+    /** 是否解封视频 false:维持当前状态 true:解封视频流 */
+    video?: boolean;
+    [property: string]: any;
+}
+export interface RTCBanRoomUserRequest {
+    /** 封禁时长，取值范围为 {0,[10,604800]}，单位为秒。
+     * 若传入值为空或 0 表示允许用户重新进房。若传入值小于 10，自动修改为 10。
+     * 若传入值大于 604800，自动修改为 604800。
+     */
+    forbidden_interval: number;
+    /** 活动ID */
+    live_id: number;
+    /** RTC用户ID */
+    rtc_userid: string;
+    [property: string]: any;
+}
+export interface RTCGetRoomOnlineUsersRequest {
+    /** 活动ID */
+    live_id: number;
+    rtc_userid?: string;
+    /** 商户ID */
+    agent_id?: number;
+    [property: string]: any;
+}
+export interface RTCRoomOnlineInvisibleUser {
+    device_type?: string;
+    media_processing_type?: number;
+    /** 用户标识ID */
+    rtc_userid?: string;
+    [property: string]: any;
+}
+export interface RTCRoomOnlineVisibleUser {
+    /** 设备类型 */
+    device_type?: string;
+    /** 用户标识ID */
+    rtc_userid?: string;
+    [property: string]: any;
+}
+export interface RTCGetRoomOnlineUsersResponse {
+    /** 不可见用户 */
+    invisible_user_list?: RTCRoomOnlineInvisibleUser[];
+    /** 房间是否存在 */
+    room_exist?: boolean;
+    /** 可见用户 */
+    visible_user_list?: RTCRoomOnlineVisibleUser[];
+    [property: string]: any;
+}
+export interface RTCRefreshPasswordRequest {
+    /** 活动ID */
+    live_id: number;
+    [property: string]: any;
+}
+export interface RTCRefreshPasswordResponse {
+    /** 新的邀请密码 */
+    password: string;
+    [property: string]: any;
+}
+export interface LoginRequestParams {
+    live_id: number;
+    nickname: string;
+    password: string;
+    rtc_userid: string;
+}
+export type VerifyPasswordRequest = LoginRequestParams;
+export interface LoginResponseData {
+    appid?: string;
+    nickname?: string;
+    rtc_room_id: string;
+    rtc_userid?: string;
+    token?: string;
+}
+export type VerifyPasswordResponse = LoginResponseData;
+/**
+ * 更新RTC存储配置
+ * @param params 配置参数
+ * @returns Promise<{ code?: number; message?: string; data?: any; success?: boolean }>
+ */
+export declare const updateRTCStorageConfig: (params: RTCStorageConfigRequest) => Promise<{
+    code?: number;
+    message?: string;
+    data?: any;
+    success?: boolean;
+}>;
+/**
+ * 获取RTC连麦配置
+ * @description 获取指定直播间的RTC连麦配置信息，包括房间密码、用户ID、令牌等关键信息
+ * @param params 请求参数对象
+ * @param params.live_id 直播间ID，用于标识特定的直播间
+ * @param params.extra_config 可选的额外配置参数
+ * @returns 返回包含RTC配置信息的Promise对象
+ * @throws {Error} 当网络请求失败或服务器返回错误时抛出异常
+ * @example
+ * ```typescript
+ * // 获取直播间123的RTC配置
+ * const config = await getRTCMasterConfig({ live_id: 123 });
+ * if (config.success) {
+ *   console.log('RTC房间ID:', config.data.rtc_room_id);
+ *   console.log('用户ID:', config.data.rtc_userid);
+ * }
+ * ```
+ */
+export declare const getRTCMasterConfig: (params: RTCMasterConfigRequest) => Promise<import("./request").ResponseData<RTCMasterConfigResponse>>;
+/**
+ * 获取RTC嘉宾配置
+ * @description 获取指定直播间嘉宾的RTC连麦配置信息，包括房间密码、用户ID、令牌等关键信息
+ * @param params 请求参数对象
+ * @param params.agent_id 商户ID，用于标识商户
+ * @param params.live_id 直播间ID，用于标识特定的直播间
+ * @param params.rtc_userid RTC用户ID，用于标识嘉宾用户
+ * @returns 返回包含RTC嘉宾配置信息的Promise对象
+ * @throws {Error} 当网络请求失败或服务器返回错误时抛出异常
+ * @example
+ * ```typescript
+ * // 获取嘉宾的RTC配置
+ * const config = await getRTCGuestConfig({
+ *   agent_id: 1001,
+ *   live_id: 123,
+ *   rtc_userid: 'guest_001'
+ * });
+ * if (config.success) {
+ *   console.log('RTC房间ID:', config.data.rtc_room_id);
+ *   console.log('嘉宾令牌:', config.data.token);
+ * }
+ * ```
+ */
+export declare const getRTCGuestConfig: (params: RTCGuestConfigRequest) => Promise<import("./request").ResponseData<RTCMasterConfigResponse>>;
+/**
+ * RTC封禁用户音视频流
+ * @param params 封禁参数
+ * @returns Promise<{ code?: number; message?: string; data?: any; success?: boolean }>
+ */
+export declare const banUserStream: (params: RTCBanUserStreamRequest) => Promise<{
+    code?: number;
+    message?: string;
+    data?: any;
+    success?: boolean;
+}>;
+/**
+ * RTC解封用户音视频流
+ * @param params 解封参数
+ * @returns Promise<{ code?: number; message?: string; data?: any; success?: boolean }>
+ */
+export declare const unbanUserStream: (params: RTCUnbanUserStreamRequest) => Promise<{
+    code?: number;
+    message?: string;
+    data?: any;
+    success?: boolean;
+}>;
+/**
+ * RTC踢出房间用户
+ * @param params 踢人参数
+ * @returns Promise<{ code?: number; message?: string; data?: any; success?: boolean }>
+ */
+export declare const banRoomUser: (params: RTCBanRoomUserRequest) => Promise<{
+    code?: number;
+    message?: string;
+    data?: any;
+    success?: boolean;
+}>;
+/**
+ * 获取房间在线用户
+ * @param params 请求参数
+ * @returns Promise<{ code?: number; message?: string; data?: RTCGetRoomOnlineUsersResponse; success?: boolean }>
+ */
+export declare const getRoomOnlineUsers: (params: RTCGetRoomOnlineUsersRequest) => Promise<{
+    code?: number;
+    message?: string;
+    data?: RTCGetRoomOnlineUsersResponse;
+    success?: boolean;
+}>;
+/**
+ * 刷新邀请密码
+ * @param params 请求参数
+ * @returns Promise<{ code?: number; message?: string; data?: RTCRefreshPasswordResponse; success?: boolean }>
+ */
+export declare const refreshInvitePassword: (params: RTCRefreshPasswordRequest) => Promise<import("./request").ResponseData<any>>;
+/**
+ * 用户登录验证密码
+ * @param params 登录参数
+ * @returns Promise<>
+ */
+export declare const verifyPassword: (params: VerifyPasswordRequest) => Promise<import("./request").ResponseData<any>>;
+/**
+ * 根据RTC用户ID获取昵称
+ * @param params 请求参数
+ * @returns Promise<{ code?: number; message?: string; data?: RTCGuestGetNicknameByRTCUseridResponse; success?: boolean }>
+ */
+export declare const getRTCGuestNicknameByRTCUserid: (params: RTCGuestGetNicknameByRTCUseridRequest) => Promise<{
+    code?: number;
+    message?: string;
+    data?: RTCGuestGetNicknameByRTCUseridResponse;
+    success?: boolean;
+}>;
+/**
+ * 开始连麦
+ * @param params 请求参数
+ * @returns Promise<{ code?: number; message?: string; data?: any; success?: boolean }>
+ */
+export declare const startRTC: (params: RTCStartRequest) => Promise<{
+    code?: number;
+    message?: string;
+    data?: any;
+    success?: boolean;
+}>;
+/**
+ * 停止连麦
+ * @param params 请求参数
+ * @returns Promise<{ code?: number; message?: string; data?: any; success?: boolean }>
+ */
+export declare const stopRTC: (params: RTCStopRequest) => Promise<{
+    code?: number;
+    errorMessage?: string;
+    data?: any;
+    success?: boolean;
+}>;
+/**
+ * 解散房间
+ * @description 解散指定直播间的RTC房间，结束所有用户的连麦会话
+ * @param params 请求参数对象
+ * @param params.live_id 直播间ID，用于标识需要解散的房间
+ * @returns 返回解散房间操作结果的Promise对象
+ * @throws {Error} 当网络请求失败或服务器返回错误时抛出异常
+ * @example
+ * ```typescript
+ * // 解散直播间123的RTC房间
+ * const result = await dismissRoom({ live_id: 123 });
+ * if (result.success) {
+ *   console.log('房间解散成功');
+ * } else {
+ *   console.error('房间解散失败:', result.message);
+ * }
+ * ```
+ */
+export declare const dismissRoom: (params: RTCDismissRoomRequest) => Promise<{
+    code?: number;
+    message?: string;
+    data?: any;
+    success?: boolean;
+}>;
+declare const _default: {
+    updateRTCStorageConfig: (params: RTCStorageConfigRequest) => Promise<{
+        code?: number;
+        message?: string;
+        data?: any;
+        success?: boolean;
+    }>;
+    getRTCMasterConfig: (params: RTCMasterConfigRequest) => Promise<import("./request").ResponseData<RTCMasterConfigResponse>>;
+    getRTCGuestConfig: (params: RTCGuestConfigRequest) => Promise<import("./request").ResponseData<RTCMasterConfigResponse>>;
+    banUserStream: (params: RTCBanUserStreamRequest) => Promise<{
+        code?: number;
+        message?: string;
+        data?: any;
+        success?: boolean;
+    }>;
+    unbanUserStream: (params: RTCUnbanUserStreamRequest) => Promise<{
+        code?: number;
+        message?: string;
+        data?: any;
+        success?: boolean;
+    }>;
+    banRoomUser: (params: RTCBanRoomUserRequest) => Promise<{
+        code?: number;
+        message?: string;
+        data?: any;
+        success?: boolean;
+    }>;
+    getRoomOnlineUsers: (params: RTCGetRoomOnlineUsersRequest) => Promise<{
+        code?: number;
+        message?: string;
+        data?: RTCGetRoomOnlineUsersResponse;
+        success?: boolean;
+    }>;
+    refreshInvitePassword: (params: RTCRefreshPasswordRequest) => Promise<import("./request").ResponseData<any>>;
+    verifyPassword: (params: VerifyPasswordRequest) => Promise<import("./request").ResponseData<any>>;
+    getRTCGuestNicknameByRTCUserid: (params: RTCGuestGetNicknameByRTCUseridRequest) => Promise<{
+        code?: number;
+        message?: string;
+        data?: RTCGuestGetNicknameByRTCUseridResponse;
+        success?: boolean;
+    }>;
+    startRTC: (params: RTCStartRequest) => Promise<{
+        code?: number;
+        message?: string;
+        data?: any;
+        success?: boolean;
+    }>;
+    stopRTC: (params: RTCStopRequest) => Promise<{
+        code?: number;
+        errorMessage?: string;
+        data?: any;
+        success?: boolean;
+    }>;
+    dismissRoom: (params: RTCDismissRoomRequest) => Promise<{
+        code?: number;
+        message?: string;
+        data?: any;
+        success?: boolean;
+    }>;
+};
+export default _default;

package/dist/api/request.d.ts

@@ -0,0 +1,39 @@
+import { AxiosRequestConfig } from 'axios';
+export declare enum ErrorShowType {
+    SILENT = 0,
+    WARN_MESSAGE = 1,
+    ERROR_MESSAGE = 2,
+    NOTIFICATION = 3,
+    REDIRECT = 9
+}
+/**
+ * 与后端约定的响应数据格式
+ */
+export interface ResponseData<T = any> {
+    success: boolean;
+    data: T;
+    errorCode?: number;
+    errorMessage?: string;
+    showType?: ErrorShowType;
+}
+/**
+ * 请求配置选项
+ */
+export interface RequestOptions extends Omit<AxiosRequestConfig, 'params' | 'data' | 'method'> {
+    /** 请求方法 */
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    /** 请求数据，用于 POST/PUT/PATCH 请求 */
+    data?: any;
+    /** URL 参数，用于 GET 请求 */
+    params?: any;
+    /** 是否跳过错误处理 */
+    skipErrorHandler?: boolean;
+}
+/**
+ * 通用请求函数
+ * @param url 请求 URL
+ * @param options 请求配置选项
+ * @returns Promise<ResponseData<T>>
+ */
+export declare const request: <T = any>(url: string, options?: RequestOptions) => Promise<ResponseData<T>>;
+export default request;