Class TCICAlpha

constructor

• new TCIC(opts): TCIC

• Parameters

  • opts: {
        classId: number;
        playerConf?: any;
        token: string;
        userId: string;
    }

    • classId: number

    • Optional playerConf?: any

    • token: string

    • userId: string

  Returns TCIC

Optional _hostInfo

Optional _myInfo

classId

Optional classInfo

memberInfo

playerConf

Optional schoolInfo

token

trtc

userId

destroy

• destroy(): void

• 销毁实例,会结尝试结束房间

  Returns void

end

• end(): Promise<unknown>

• 业务流程结束，将会通知所有房间内成员下线

  Returns Promise<unknown>

fetchData

• fetchData(path, param?): Promise<unknown>

• Parameters

  • path: string

    请求地址

  • Optional param: any

    请求参数

  Returns Promise<unknown>

getMembersDetail

• getMembersDetail(classId, pager): Promise<{
      class_members: Classroom[];
      error_code: number;
      error_msg: string;
      member_number: number;
      member_offline_number: number;
      members: TCIC_Bussiness.CGIType.Member[];
      offline_total: number;
      request_id: string;
      total: number;
  }>

• 获取成员列表详情

  Parameters

  • classId: string

    课堂ID

  • pager: Partial<{
        keyword: string;
        limit: number;
        page: number;
        type: TMemberType;
    }>

    分页信息

  Returns Promise<{
      class_members: Classroom[];
      error_code: number;
      error_msg: string;
      member_number: number;
      member_offline_number: number;
      members: TCIC_Bussiness.CGIType.Member[];
      offline_total: number;
      request_id: string;
      total: number;
  }>

getStreamConfig

• getStreamConfig(userId, streamType): undefined | Stream

• Parameters

  • userId: string

  • streamType: string

  Returns undefined | Stream

getUserInfoByIds

• getUserInfoByIds(ids): Promise<Member[]>

• 通过ID列表获取用户简要信息 只有nick和头像

  Parameters

  • ids: string[]

    用户ID列表

  Returns Promise<Member[]>

hostInfo

• hostInfo(): MemberInfo

• 获取当前房主信息

  Returns MemberInfo

init

• init(opts?): Promise<void>

• 初始化业务必要信息， 例如当前房间状态， 当前应用信息， 台上用户等等

  Parameters

  • Optional opts: {
        ready?: (() => void);
        role?: RoleType;
    }

    • Optional ready?: (() => void)

      • • (): void

        • Returns void

    • Optional role?: RoleType

  Returns Promise<void>

leaveRoom

• leaveRoom(): Promise<unknown>

• Returns Promise<unknown>

memberAction

• memberAction(args): Promise<unknown>

• 对用户操作，详情参见枚举类型 TCIC_Bussiness.TMemberActionType

  Parameters

  • args: TMemberActionParam

    操作参数，例如踢出等等

  Returns Promise<unknown>

memberStateReport

• memberStateReport(state): Promise<unknown>

• 成员状态上报 TCIC_Bussiness.TMemberActionType

  Parameters

  • state: TMemberStateReportParam

    操作参数，例如踢出等等

  Returns Promise<unknown>

myInfo

• myInfo(): MemberInfo

• 获取当前登陆用户信息

  Returns MemberInfo

setStreamConfigs

• setStreamConfigs(streamConfigs, seq): void

• Parameters

  • streamConfigs: Stream[]

  • seq: number

  Returns void

setTRTC

• setTRTC(trtc): void

• Parameters

  • trtc: any

  Returns void

start

• start(): Promise<unknown>

• 业务流程开启，房间活动开始后 才可以进行录制，视频等等一系列活动

  Returns Promise<unknown>