Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

CarouselSetting

CarouselSetting: { interval: number; range: number; state: number; type: number }

Video carousel setting

Type declaration

  • interval: number

    Update interval of the video carousel, unit: seconds

  • range: number

    Which user can join video carousel 1: all users 2: device available users only

  • state: number

    Whether video carousel is enabled 1: enabled 0: disabled

  • type: number

    Video carousel type 1: sequential 2: random

ClassroomSchedule

ClassroomSchedule: { closeDelay: number; duration?: number; startTime?: number; state?: ClassState }

Classroom schedule info

Type declaration

  • closeDelay: number

    Delay to close current classroom after class, unit: seconds

  • Optional duration?: number

    Duration of current classroom, unit: seconds

  • Optional startTime?: number

    Start time of current classroom, unit: milliseconds

  • Optional state?: ClassState

    State of course

ExpandedScope

ExpandedScope: { state: ExpandedScopeState; userUuids: string[] }

Video gallery state

Type declaration

  • state: ExpandedScopeState

    Whether video gallery is open or not

  • userUuids: string[]

    List of User UUDI of Video gallery

FcrCustomMessage

FcrCustomMessage: AgoraRteCustomMessage

FcrCustomMessageObserver

FcrCustomMessageObserver: AgoraRteCustomMessageObserver

HandUpProgress

HandUpProgress: { payload?: any; ts: number; userName: string; userUuid: string }

Handup progress

Type declaration

  • Optional payload?: any

    Extra playload

  • ts: number

    User raise hand timestamp´╝îin milliseconds

  • userName: string

    User name

  • userUuid: string

    User UUID

HostingScene

HostingScene: { finishType: number; reserveVideoURL: string; videoURL: string }

deprecated

Type declaration

  • finishType: number
  • reserveVideoURL: string
  • videoURL: string

RecordStreamingUrl

RecordStreamingUrl: { flv: string; hls: string; rtmp: string }

Streaming info of the record

Type declaration

  • flv: string

    FLV URL

  • hls: string

    HLS URL

  • rtmp: string

    RTMP URL

TrackData

TrackData: { extra?: any; position: { xaxis: number; yaxis: number }; size?: { height: number; width: number } }

Track info

Type declaration

  • Optional extra?: any

    extra info

  • position: { xaxis: number; yaxis: number }

    Object position

    • xaxis: number
    • yaxis: number
  • Optional size?: { height: number; width: number }

    Object size

    • height: number
    • width: number