Options
All
  • Public
  • Public/Protected
  • All
Menu

Module QChatMediaServiceInterface

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

ConnectOptions

ConnectOptions: { channelId: string; serverId: string }

Type declaration

  • channelId: string

    频道ID

  • serverId: string

    服务器ID

GetRTCChannelInfoOptions

GetRTCChannelInfoOptions: { channelId: string; serverId: string }

Type declaration

  • channelId: string

    频道ID

  • serverId: string

    服务器ID

GetRTCChannelInfoResult

GetRTCChannelInfoResult: { audio: { profile: string; scenario: string }; limit: number; video: { fps: number; height: number; width: number } }

Type declaration

  • audio: { profile: string; scenario: string }

    房间配置下的roleConfigs的音频质量

    • profile: string
    • scenario: string
  • limit: number

    房间配置下的roleConfigs的人数限制

  • video: { fps: number; height: number; width: number }

    房间配置下的roleConfigs的视频质量

    • fps: number
    • height: number
    • width: number

GetRTCChannelOnlineMembersOptions

GetRTCChannelOnlineMembersOptions: { channelId: string; serverId: string }

Type declaration

  • channelId: string

    频道ID

  • serverId: string

    服务器ID

InitOptions

InitOptions: { serverConfig: { imServerConfig: { httpsEnabled: boolean; lbs: string; link: string; linkSslWeb: boolean; nosDownloader: string; nosUploader: string }; roomKitServerConfig: { roomServer: string }; rtcServerConfig: { channelServer: string; roomServer: string; statisticsServer: string; useIPv6: boolean }; whiteboardServerConfig: { dataReportServer: string; directNosServer: string; docTransServer: string; fontDownloadServer: string; mediaUploadServer: string; roomServer: string; sdkLogNosServer: string } } }

Type declaration

  • serverConfig: { imServerConfig: { httpsEnabled: boolean; lbs: string; link: string; linkSslWeb: boolean; nosDownloader: string; nosUploader: string }; roomKitServerConfig: { roomServer: string }; rtcServerConfig: { channelServer: string; roomServer: string; statisticsServer: string; useIPv6: boolean }; whiteboardServerConfig: { dataReportServer: string; directNosServer: string; docTransServer: string; fontDownloadServer: string; mediaUploadServer: string; roomServer: string; sdkLogNosServer: string } }
    • imServerConfig: { httpsEnabled: boolean; lbs: string; link: string; linkSslWeb: boolean; nosDownloader: string; nosUploader: string }
      • httpsEnabled: boolean

        nos是否开启https

      • lbs: string

        lbs连接地址

      • link: string

        link连接地址

      • linkSslWeb: boolean

        是否对link连接进行https处理

      • nosDownloader: string

        nos下载地址 这个是用来接到消息后，要按一定模式替换掉文件链接的。给予一个安全下载链接。

      • nosUploader: string

        nos上传地址

    • roomKitServerConfig: { roomServer: string }
      • roomServer: string
    • rtcServerConfig: { channelServer: string; roomServer: string; statisticsServer: string; useIPv6: boolean }
      • channelServer: string

        通道信息服务器地址

      • roomServer: string

        roomServer服务器地址

      • statisticsServer: string

        统计上报服务器地址

      • useIPv6: boolean

        是否使用ipv6

    • whiteboardServerConfig: { dataReportServer: string; directNosServer: string; docTransServer: string; fontDownloadServer: string; mediaUploadServer: string; roomServer: string; sdkLogNosServer: string }

      白板相关私有化配置

KickMemberOutOptions

KickMemberOutOptions: { accid: string }

Type declaration

  • accid: string

    移除成员的用户id

MuteAudioOptions

MuteAudioOptions: { accid: string }

Type declaration

  • accid: string

    关闭成员音频的用户id

MuteVideoOptions

MuteVideoOptions: { accid: string }

Type declaration

  • accid: string

    关闭成员视频的accid

QChatMediaMember

QChatMediaMember: { accid: string; isAudioOn: boolean; isSharingScreen: boolean; isVideoOn: boolean; properties: Record<string, any> }

Type declaration

  • accid: string
  • isAudioOn: boolean
  • isSharingScreen: boolean
  • isVideoOn: boolean
  • properties: Record<string, any>

QChatMediaMemberInfo

QChatMediaMemberInfo: { accid: string; avatar: string; createTime: number; ext?: string; inviter: string; joinTime: number; nick: string; serverId: string; type: 0 | 1; updateTime: number; validFlag: 0 | 1 }

Type declaration

  • accid: string

    用户accid

  • avatar: string

    头像

  • createTime: number

    创建时间

  • Optional ext?: string

    自定义扩展

  • inviter: string

    邀请模人

  • joinTime: number

    加入时间

  • nick: string

    昵称

  • serverId: string

    服务器ID

  • type: 0 | 1

    类型：0-普通成员，1-所有者

  • updateTime: number

    更新时间

  • validFlag: 0 | 1

    有效标志：0-无效，1-有效

QChatMediaVideoView

QChatMediaVideoView: HTMLElement | string

QChatMemberVolumeInfo

QChatMemberVolumeInfo: { userUuid: string; volume: number }

Type declaration

  • userUuid: string
  • volume: number

SetSelectedCameraDeviceOptions

SetSelectedCameraDeviceOptions: { deviceId: string }

Type declaration

  • deviceId: string

    设备Id

SetSelectedPlayoutDeviceOptions

SetSelectedPlayoutDeviceOptions: { deviceId: string }

Type declaration

  • deviceId: string

    设备Id

SetSelectedRecordDeviceOptions

SetSelectedRecordDeviceOptions: { deviceId: string }

Type declaration

  • deviceId: string

    设备Id

SetupRemoteVideoSubStreamCanvasOptions

SetupRemoteVideoSubStreamCanvasOptions: { accid: string; videoView: QChatMediaVideoView }

Type declaration

SetupVideoCanvasOptions

SetupVideoCanvasOptions: { accid: string; videoView: QChatMediaVideoView }

Type declaration

StopMemberScreenShareOptions

StopMemberScreenShareOptions: { accid: string }

Type declaration

  • accid: string

    成员accid

SubscribeRemoteVideoStreamOptions

SubscribeRemoteVideoStreamOptions: { accid: string; streamType: number }

Type declaration

  • accid: string

    成员accid

  • streamType: number

    大小流 0-大流，1-小流

SubscribeRemoteVideoSubStreamOptions

SubscribeRemoteVideoSubStreamOptions: { accid: string }

Type declaration

  • accid: string

    成员accid

UnMuteAudioOptions

UnMuteAudioOptions: { accid: string }

Type declaration

  • accid: string

    打开成员音频的用户id

UnMuteVideoOptions

UnMuteVideoOptions: { accid: string }

Type declaration

  • accid: string

    打开成员视频的accid

UnSubScribeRemoteVideoSubStreamOptions

UnSubScribeRemoteVideoSubStreamOptions: { accid: string }

Type declaration

  • accid: string

    成员accid

UnSubscribeRemoteVideoStreamOptions

UnSubscribeRemoteVideoStreamOptions: { accid: string; streamType: number }

Type declaration

  • accid: string

    成员accid

  • streamType: number

    大小流 0-大流，1-小流

UpdateRTCChannelInfoOptions

UpdateRTCChannelInfoOptions: { audio: { profile: string; scenario: string }; channelId: string; limit: number; serverId: string; video: { fps: number; height: number; width: number } }

Type declaration

  • audio: { profile: string; scenario: string }

    房间配置下的roleConfigs的音频质量

    • profile: string
    • scenario: string
  • channelId: string

    频道ID

  • limit: number

    房间配置下的roleConfigs的人数限制

  • serverId: string

    服务器ID

  • video: { fps: number; height: number; width: number }

    房间配置下的roleConfigs的视频质量

    • fps: number
    • height: number
    • width: number

enumDevicesResult

enumDevicesResult: NEDeviceBaseInfo

setDeviceInfoResult

setDeviceInfoResult: NEDeviceSwitchInfo

updateRTCChannelInfoResult

updateRTCChannelInfoResult: { audio: { profile: string; scenario: string }; limit: number; video: { fps: number; height: number; width: number } }

Type declaration

  • audio: { profile: string; scenario: string }

    房间配置下的roleConfigs的音频质量

    • profile: string
    • scenario: string
  • limit: number

    房间配置下的roleConfigs的人数限制

  • video: { fps: number; height: number; width: number }

    房间配置下的roleConfigs的视频质量

    • fps: number
    • height: number
    • width: number