Class PLVLinkMicManager

基础模块类

Hierarchy (View Summary)

Constructors

constructor

Properties

cameraFacing channelAllowLinkMic channelAllowRequestHandsUpLinkMic channelData channelLinkMicMode channelLinkMicViewers channelMainViewLinkMicId errorEvent initPromise invitationExpireTimestamp isLinkMicStrategyV2 joinLinkMicWaitingQueueOrder linkmicNetworkQuality linkmicNetworkStatistics linkmicState localLinkMicViewer renderMirror sdkSupportChannelLinkMic teacherHangUpLinkMicEvent viewerAnswerInvitationEvent viewerJoinLinkMicEvent viewerLeaveLinkMicEvent

Methods

acceptLinkMicInvitation acceptViewerLinkMicRequest closeLinkMic destroy enableCamera enableCameraMicrophoneToLastState enableMicrophone grantSpeaker hangupAllViewersLinkMic hangupViewerLinkMic inviteViewerLinkMic leaveLinkMic openLinkMic refuseLinkMicInvitation removeVideoRender requestLinkMic revokeSpeaker setLinkMicMode setLocalMirror setupVideoRender setViewerEnableCamera setViewerEnableMicrophone switchCamera

Constructors

constructor

  • new PLVLinkMicManager(
        dependScope: DependScope,
        channelData: PLVChannelData,
        socketMediator: PLVSocketMediator,
        playerMediator: PLVPlayerMediator,
        memberMediator: PLVMemberMediator,
    ): PLVLinkMicManager

    Parameters

    • dependScope: DependScope
    • channelData: PLVChannelData
    • socketMediator: PLVSocketMediator
    • playerMediator: PLVPlayerMediator
    • memberMediator: PLVMemberMediator

    Returns PLVLinkMicManager

Properties

ReadonlycameraFacing

cameraFacing: State<PLVLinkMicCameraFacing>

当前摄像头方向

ReadonlychannelAllowLinkMic

channelAllowLinkMic: State<boolean>

频道当前是否支持连麦

ReadonlychannelAllowRequestHandsUpLinkMic

channelAllowRequestHandsUpLinkMic: State<boolean>

频道当前是否支持观众举手申请连麦

channelData

channelData: PLVChannelData

频道数据

ReadonlychannelLinkMicMode

channelLinkMicMode: State<PLVLinkMicMode>

频道当前的连麦模式

ReadonlychannelLinkMicViewers

channelLinkMicViewers: State<PLVLinkMicViewer[]>

频道当前正在连麦用户的连麦参数

ReadonlychannelMainViewLinkMicId

channelMainViewLinkMicId: State<string>

频道第一画面观众的连麦ID

ReadonlyerrorEvent

errorEvent: MutableEvent<PLVLinkMicErrorEvent>

连麦模块错误事件

ReadonlyinitPromise

initPromise: Promise<void>

初始化回调

ReadonlyinvitationExpireTimestamp

invitationExpireTimestamp: State<number>

邀请连麦事件的过期时刻

ReadonlyisLinkMicStrategyV2

isLinkMicStrategyV2: State<boolean>

频道是否新版连麦模式

ReadonlyjoinLinkMicWaitingQueueOrder

joinLinkMicWaitingQueueOrder: State<number>

申请连麦时排队位置

ReadonlylinkmicNetworkQuality

linkmicNetworkQuality: State<PLVNetworkQuality>

网络质量回调

ReadonlylinkmicNetworkStatistics

linkmicNetworkStatistics: State<PLVNetworkStatistics>

网络质量统计回调

ReadonlylinkmicState

linkmicState: State<PLVLinkMicState>

当前连麦状态

ReadonlylocalLinkMicViewer

localLinkMicViewer: State<PLVLinkMicViewer>

自己的连麦参数

ReadonlyrenderMirror

renderMirror: State<boolean>

当前画面是否镜像

ReadonlysdkSupportChannelLinkMic

sdkSupportChannelLinkMic: State<boolean>

SDK 是否支持当前频道的连麦

ReadonlyteacherHangUpLinkMicEvent

teacherHangUpLinkMicEvent: MutableEvent<number>

被讲师挂断连麦事件

ReadonlyviewerAnswerInvitationEvent

viewerAnswerInvitationEvent: MutableEvent<PLVLinkMicAnswerInvitationEvent>

用户响应连麦邀请事件

ReadonlyviewerJoinLinkMicEvent

viewerJoinLinkMicEvent: MutableEvent<PLVLinkMicViewer[]>

用户加入了连麦事件

ReadonlyviewerLeaveLinkMicEvent

viewerLeaveLinkMicEvent: MutableEvent<PLVLinkMicViewer[]>

用户离开了连麦事件

Methods

acceptLinkMicInvitation

  • acceptLinkMicInvitation(): void

    [观众、嘉宾] 接受讲师连麦邀请

    Returns void

acceptViewerLinkMicRequest

  • acceptViewerLinkMicRequest(viewerId: string): void

    [讲师] 接受观众连麦申请

    Parameters

    • viewerId: string

    Returns void

closeLinkMic

  • closeLinkMic(): Promise<boolean>

    [讲师] 关闭连麦

    Returns Promise<boolean>

destroy

  • destroy(): void

    销毁

    Returns void

enableCamera

  • enableCamera(enable: boolean): void

    切换摄像头开关

    Parameters

    • enable: boolean

    Returns void

enableCameraMicrophoneToLastState

  • enableCameraMicrophoneToLastState(): void

    [观众] 切换摄像头和麦克风开关至上一次连麦时保存的状态

    Returns void

enableMicrophone

  • enableMicrophone(enable: boolean): void

    切换麦克风开关

    Parameters

    • enable: boolean

    Returns void

grantSpeaker

  • grantSpeaker(viewerId: string): void

    [讲师] 授予主讲权限

    [嘉宾] 移交主讲权限

    Parameters

    • viewerId: string

    Returns void

hangupAllViewersLinkMic

  • hangupAllViewersLinkMic(): void

    [讲师] 全体下麦

    Returns void

hangupViewerLinkMic

  • hangupViewerLinkMic(viewerId: string): void

    [讲师] 挂断观众的连麦

    Parameters

    • viewerId: string

    Returns void

inviteViewerLinkMic

  • inviteViewerLinkMic(viewerId: string, needAnswer?: boolean): void

    [讲师] 邀请观众连麦

    Parameters

    • viewerId: string
    • needAnswer: boolean = true

    Returns void

leaveLinkMic

  • leaveLinkMic(): void

    [观众、嘉宾] 离开连麦

    Returns void

openLinkMic

  • openLinkMic(): Promise<boolean>

    [讲师] 打开连麦

    Returns Promise<boolean>

refuseLinkMicInvitation

  • refuseLinkMicInvitation(): void

    [观众、嘉宾] 拒绝讲师连麦邀请

    Returns void

removeVideoRender

  • removeVideoRender(renderParam: PLVLinkMicVideoRenderParam): void

    移除视频渲染

    Parameters

    • renderParam: PLVLinkMicVideoRenderParam

      其中 xcomponentId 为 null 时移除视频渲染， 不为 null 时只有当前 linkmicId 绑定的 xcomponentId 与传入参数一致才移除视频渲染

    Returns void

requestLinkMic

  • requestLinkMic(): void

    [观众、嘉宾] 举手申请加入连麦

    Returns void

revokeSpeaker

  • revokeSpeaker(viewerId: string): void

    [讲师] 撤销主讲权限

    [嘉宾] 主动移除自己的主讲权限

    Parameters

    • viewerId: string

    Returns void

setLinkMicMode

  • setLinkMicMode(linkmicMode: PLVLinkMicMode): Promise<boolean>

    [讲师] 更改连麦模式

    在频道已经开启连麦的情况下，更改连麦模式将自动下麦全体成员

    Parameters

    • linkmicMode: PLVLinkMicMode

    Returns Promise<boolean>

setLocalMirror

  • setLocalMirror(isMirror: boolean): void

    设置自己的画面镜像

    Parameters

    • isMirror: boolean

      是否镜像

    Returns void

setupVideoRender

  • setupVideoRender(renderParam: PLVLinkMicVideoRenderParam): void

    设置视频渲染

    Parameters

    • renderParam: PLVLinkMicVideoRenderParam

      渲染参数

    Returns void

setViewerEnableCamera

  • setViewerEnableCamera(viewerId: string, enable: boolean): void

    [讲师] 设置观众开关摄像头

    Parameters

    • viewerId: string
    • enable: boolean

    Returns void

setViewerEnableMicrophone

  • setViewerEnableMicrophone(viewerId: string, enable: boolean): void

    [讲师] 设置观众开关麦克风

    Parameters

    • viewerId: string
    • enable: boolean

    Returns void

switchCamera

  • switchCamera(): void

    切换前后摄像头

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods