QChatMediaServiceInterface

调用方式:

qchat.qchatMedia.initQChatMedia(options)

Hierarchy

QChatMediaServiceInterface

Methods

addRTCChannelListener

addRTCChannelListener(): void

添加RTC频道事件监听

Returns void

connectChannel

connectChannel(options: ConnectOptions): Promise<void>

连接圈组多媒体频道（房间）,必须先登录后再调用该接口

Parameters
- options: ConnectOptions
Returns Promise<void>

disconnectChannel

disconnectChannel(): Promise<void>

取消连接多媒体频道

Returns Promise<void>

enumCameraDevices

enumCameraDevices(): Promise<null | NEDeviceBaseInfo[]>

获取当前摄像头列表

Returns Promise<null | NEDeviceBaseInfo[]>

enumPlayoutDevices

enumPlayoutDevices(): Promise<null | NEDeviceBaseInfo[]>

获取当前扬声器列表

Returns Promise<null | NEDeviceBaseInfo[]>

enumRecordDevices

enumRecordDevices(): Promise<null | NEDeviceBaseInfo[]>

获取当前麦克风列表

Returns Promise<null | NEDeviceBaseInfo[]>

getRTCChannelInfo

getRTCChannelInfo(options: GetRTCChannelInfoOptions): Promise<GetRTCChannelInfoResult>

查询音视频频道的房间相关参数

Parameters
- options: GetRTCChannelInfoOptions
Returns Promise<GetRTCChannelInfoResult>

getRTCChannelOnlineMembers

getRTCChannelOnlineMembers(options: GetRTCChannelOnlineMembersOptions): Promise<QChatMediaMemberInfo[]>

查询音视频频道的房间在线成员

Parameters
- options: GetRTCChannelOnlineMembersOptions
Returns Promise<QChatMediaMemberInfo[]>

getRTCMembers

getRTCMembers(): QChatMediaMember[]

获取远端成员列表返回远端成员列表

Returns QChatMediaMember[]

getScreenSharingUserUuid

getScreenSharingUserUuid(): string

查询屏幕共享者的userUuid

Returns string

initQChatMedia

initQChatMedia(options: InitOptions): Promise<void>

初始化

Parameters
- options: InitOptions
Returns Promise<void>

kickMemberOut

kickMemberOut(options: KickMemberOutOptions): Promise<void>

移除成员

Parameters
- options: KickMemberOutOptions
Returns Promise<void>

loginByIM

loginByIM(): Promise<void>

登录圈组多媒体服务，必须先初始化后在调用该接口

Returns Promise<void>

muteAllAudio

muteAllAudio(): Promise<void>

关闭所有成员音频

Returns Promise<void>

muteAllVideo

muteAllVideo(): Promise<void>

关闭所有成员视频

Returns Promise<void>

muteAudio

muteAudio(options: MuteAudioOptions): Promise<void>

关闭成员音频,如果accid为当前用户，则关闭本端音频发送，操作其他成员会进行权限校验

Parameters
- options: MuteAudioOptions
Returns Promise<void>

muteVideo

muteVideo(options: MuteVideoOptions): Promise<void>

关闭成员视频,如果accid为当前用户，则关闭本端视频，操作其他成员会进行权限校验

Parameters
- options: MuteVideoOptions
Returns Promise<void>

removeRTCChannelListener

removeRTCChannelListener(): void

移除RTC频道监听

Returns void

setSelectedCameraDevice

setSelectedCameraDevice(options: SetSelectedCameraDeviceOptions): Promise<null | NEDeviceSwitchInfo>

切换摄像头设备

Parameters
- options: SetSelectedCameraDeviceOptions
Returns Promise<null | NEDeviceSwitchInfo>

setSelectedPlayoutDevice

setSelectedPlayoutDevice(options: SetSelectedPlayoutDeviceOptions): Promise<null | NEDeviceSwitchInfo>

切换扬声器设备

Parameters
- options: SetSelectedPlayoutDeviceOptions
Returns Promise<null | NEDeviceSwitchInfo>

setSelectedRecordDevice

setSelectedRecordDevice(options: SetSelectedRecordDeviceOptions): Promise<null | NEDeviceSwitchInfo>

切换麦克风设备

Parameters
- options: SetSelectedRecordDeviceOptions
Returns Promise<null | NEDeviceSwitchInfo>

setupRemoteVideoSubStreamCanvas

setupRemoteVideoSubStreamCanvas(options: SetupRemoteVideoSubStreamCanvasOptions): number

设置远端的辅流视频画布

Parameters
- options: SetupRemoteVideoSubStreamCanvasOptions
Returns number

setupVideoCanvas

setupVideoCanvas(options: SetupVideoCanvasOptions): number

设置用户视图,如果accid为当前登录用户，则设置本端视图

Parameters
- options: SetupVideoCanvasOptions
Returns number

startScreenShare

startScreenShare(): Promise<void>

打开本端屏幕共享

Returns Promise<void>

stopMemberScreenShare

stopMemberScreenShare(options: StopMemberScreenShareOptions): Promise<void>

关闭RTC频道内成员的屏幕共享，会进行权限校验

Parameters
- options: StopMemberScreenShareOptions
Returns Promise<void>

stopScreenShare

stopScreenShare(): Promise<void>

关闭本端屏幕共享

Returns Promise<void>

subscribeRemoteVideoStream

subscribeRemoteVideoStream(options: SubscribeRemoteVideoStreamOptions): Promise<void>

订阅指定远端用户的视频流

Parameters
- options: SubscribeRemoteVideoStreamOptions
Returns Promise<void>

subscribeRemoteVideoSubStream

subscribeRemoteVideoSubStream(options: SubscribeRemoteVideoSubStreamOptions): Promise<void>

订阅指定远端用户辅流视频

Parameters
- options: SubscribeRemoteVideoSubStreamOptions
Returns Promise<void>

unMuteAllAudio

unMuteAllAudio(): Promise<void>

打开所有成员音频

Returns Promise<void>

unMuteAllVideo

unMuteAllVideo(): Promise<void>

打开所有成员视频

Returns Promise<void>

unMuteAudio

unMuteAudio(options: UnMuteAudioOptions): Promise<void>

打开成员音频,如果accid为当前用户，则打开本端音频发送，操作其他成员会进行权限校验

Parameters
- options: UnMuteAudioOptions
Returns Promise<void>

unMuteVideo

unMuteVideo(options: UnMuteVideoOptions): Promise<void>

打开成员视频,如果accid为当前用户，则打开本端视频，操作其他成员会进行权限校验

Parameters
- options: UnMuteVideoOptions
Returns Promise<void>

unSubscribeRemoteVideoStream

unSubscribeRemoteVideoStream(options: UnSubscribeRemoteVideoStreamOptions): Promise<void>

取消订阅指定远端用户的视频流

Parameters
- options: UnSubscribeRemoteVideoStreamOptions
Returns Promise<void>

unsubscribeRemoteVideoSubStream

unsubscribeRemoteVideoSubStream(options: UnSubScribeRemoteVideoSubStreamOptions): Promise<void>

取消订阅指定远端用户辅流视频

Parameters
- options: UnSubScribeRemoteVideoSubStreamOptions
Returns Promise<void>

updateRTCChannelInfo

updateRTCChannelInfo(options: UpdateRTCChannelInfoOptions): Promise<void>

修改音视频频道的房间相关参数

Parameters
- options: UpdateRTCChannelInfoOptions
Returns Promise<void>

Hierarchy

Index

Methods

Methods

addRTCChannelListener

Returns void

connectChannel

Parameters

options: ConnectOptions

Returns Promise<void>

disconnectChannel

Returns Promise<void>

enumCameraDevices

Returns Promise<null | NEDeviceBaseInfo[]>

enumPlayoutDevices

Returns Promise<null | NEDeviceBaseInfo[]>

enumRecordDevices

Returns Promise<null | NEDeviceBaseInfo[]>

getRTCChannelInfo

Parameters

options: GetRTCChannelInfoOptions

Returns Promise<GetRTCChannelInfoResult>

getRTCChannelOnlineMembers

Parameters

options: GetRTCChannelOnlineMembersOptions

Returns Promise<QChatMediaMemberInfo[]>

getRTCMembers

Returns QChatMediaMember[]

getScreenSharingUserUuid

Returns string

initQChatMedia

Parameters

options: InitOptions

Returns Promise<void>

kickMemberOut

Parameters

options: KickMemberOutOptions

Returns Promise<void>

loginByIM

Returns Promise<void>

muteAllAudio

Returns Promise<void>

muteAllVideo

Returns Promise<void>

muteAudio

Parameters

options: MuteAudioOptions

Returns Promise<void>

muteVideo

Parameters

options: MuteVideoOptions

Returns Promise<void>

removeRTCChannelListener

Returns void

setSelectedCameraDevice

Parameters

options: SetSelectedCameraDeviceOptions

Returns Promise<null | NEDeviceSwitchInfo>

setSelectedPlayoutDevice

Parameters

options: SetSelectedPlayoutDeviceOptions

Returns Promise<null | NEDeviceSwitchInfo>

setSelectedRecordDevice

Parameters

options: SetSelectedRecordDeviceOptions

Returns Promise<null | NEDeviceSwitchInfo>

setupRemoteVideoSubStreamCanvas

Parameters

options: SetupRemoteVideoSubStreamCanvasOptions

Returns number

setupVideoCanvas

Parameters

options: SetupVideoCanvasOptions

Returns number

startScreenShare

Returns Promise<void>

stopMemberScreenShare

Parameters

options: StopMemberScreenShareOptions

Returns Promise<void>