Class RCAudienceLivingRoom

观众直播房间类处理： 1、通知观众房间内人员变更、资源变更 2、观众订阅、取消订阅资源

Hierarchy

RCAudienceLivingRoom

Constructors

constructor

new RCAudienceLivingRoom(_context: RTCContext, _runtime: IRuntime, _initOptions: IRCRTCInitOptions, _roomId: string, _joinResData: { kvEntries: IServerRTCRoomEntry[]; token: string }, livingType: RCLivingType, _useMutilPeerC?: boolean, _clientSessionId?: string): RCAudienceLivingRoom

- Defined in src/core/room/RCAudienceLivingRoom.ts:188
Parameters
- _context: RTCContext
- _runtime: IRuntime
- _initOptions: IRCRTCInitOptions
- _roomId: string
- _joinResData: { kvEntries: IServerRTCRoomEntry[]; token: string }
  - kvEntries: IServerRTCRoomEntry[]
  - token: string
- livingType: RCLivingType
- Optional _useMutilPeerC: boolean
- _clientSessionId: string = ...
Returns RCAudienceLivingRoom

Properties

Readonly livingType

livingType: RCLivingType

Methods

__destroy

__destroy(quitRoom: boolean): Promise<void>

- Defined in src/core/room/RCAudienceLivingRoom.ts:1248
退出房间并销毁当前房间实例，退出后该房间的所有方法将不可用

Parameters
- quitRoom: boolean
Returns Promise<void>

__getPC

__getPC(): default[]

- Defined in src/core/room/RCAudienceLivingRoom.ts:1286
获取 _pc 实例

Returns default[]

__onReconnected

__onReconnected(): Promise<void>

- Defined in src/core/room/RCAudienceLivingRoom.ts:1301
断线重连后处理逻辑, SDK 内部处理调用

Returns Promise<void>

addSubscribeTask

addSubscribeTask(tracks: (RCRemoteTrack | ISubscribeAttr)[]): Promise<{ code: RCRTCCode; failedList?: ISubscribeAttr[] }>

- Defined in src/core/room/RCAudienceLivingRoom.ts:1188
Parameters
- tracks: (RCRemoteTrack | ISubscribeAttr)[]
Returns Promise<{ code: RCRTCCode; failedList?: ISubscribeAttr[] }>

addUnsubscribeTask

addUnsubscribeTask(tracks: RCRemoteTrack[]): Promise<{ code: RCRTCCode; failedList?: ISubscribeAttr[] }>

- Defined in src/core/room/RCAudienceLivingRoom.ts:1240
Parameters
- tracks: RCRemoteTrack[]
Returns Promise<{ code: RCRTCCode; failedList?: ISubscribeAttr[] }>

getCDNInfo

getCDNInfo(): { CDNEnable: undefined | boolean; fps: RCFrameRate; resolution: RCResolution } | { CDNEnable: boolean; fps: undefined; resolution: undefined }

- Defined in src/core/room/RCAudienceLivingRoom.ts:1446
获取房间内 CDN 信息

Returns { CDNEnable: undefined | boolean; fps: RCFrameRate; resolution: RCResolution } | { CDNEnable: boolean; fps: undefined; resolution: undefined }

getCDNPlayUrl

getCDNPlayUrl(resolution?: RCResolution, fps?: RCFrameRate): Promise<{ CDNPlayUrl?: string; code: RCRTCCode }>

- Defined in src/core/room/RCAudienceLivingRoom.ts:1143
获取 CDN 资源对应的拉流地址

Parameters
- Optional resolution: RCResolution
- Optional fps: RCFrameRate
Returns Promise<{ CDNPlayUrl?: string; code: RCRTCCode }>
CDNPlayUrl

getClientSessionId

getClientSessionId(): string

- Defined in src/core/room/RCAudienceLivingRoom.ts:1458
Returns string

getCrtUserId

getCrtUserId(): string

- Defined in src/core/room/RCAudienceLivingRoom.ts:1360
获取当前 userId

Returns string

getLocalTrack

getLocalTrack(trackId: string): RCRemoteTrack

- Defined in src/core/room/RCAudienceLivingRoom.ts:1294
TODO 待优化

Parameters
- trackId: string
Returns RCRemoteTrack

getRemoteMCUTracks

getRemoteMCUTracks(): RCRemoteTrack[]

- Defined in src/core/room/RCAudienceLivingRoom.ts:1432
获取远端 MCU tracks

Returns RCRemoteTrack[]

getRemoteRTCTracks

getRemoteRTCTracks(): RCRemoteTrack[]

- Defined in src/core/room/RCAudienceLivingRoom.ts:1418
获取远端 RTC tracks

Returns RCRemoteTrack[]

getRemoteTrack

getRemoteTrack(trackId: string): RCRemoteTrack

- Defined in src/core/room/RCAudienceLivingRoom.ts:1279
根据 trackId 获取房间内的远端资源

Parameters
- trackId: string
Returns RCRemoteTrack

getRemoteTracks

getRemoteTracks(): RCRemoteTrack[]

- Defined in src/core/room/RCAudienceLivingRoom.ts:1398
获取房间内所有已发布的远端资源列表, 包含合流资源

Returns RCRemoteTrack[]

getRemoteTracksByUserId

getRemoteTracksByUserId(userId: string): RCRemoteTrack[]

- Defined in src/core/room/RCAudienceLivingRoom.ts:1383
获取远端用户的资源列表

Parameters
- userId: string
Returns RCRemoteTrack[]

getRemoteUserIds

getRemoteUserIds(): string[]

- Defined in src/core/room/RCAudienceLivingRoom.ts:1374
获取远程主播用户列表

Returns string[]

getRoomId

getRoomId(): string

- Defined in src/core/room/RCAudienceLivingRoom.ts:1353
获取房间 Id

Returns string

getSessionId

getSessionId(): string

- Defined in src/core/room/RCAudienceLivingRoom.ts:1367
获取房间当前会话 Id，当房间内已无成员时房间会回收，重新加入时 sessionId 将更新

Returns string

onAudioLevelChange

onAudioLevelChange(handler: null | IAudioLevelChangeHandler, gap?: number): void

- Defined in src/core/room/RCAudienceLivingRoom.ts:1330
音量上报

Parameters
- handler: null | IAudioLevelChangeHandler
  
  业务端传入的音量上报事件
- Optional gap: number
  
  上报时间间隔
Returns void

registerReportListener

registerReportListener(listener: null | IRCRTCReportListener): void

- Defined in src/core/room/RCAudienceLivingRoom.ts:1346
注册房间数据监控

Parameters
- listener: null | IRCRTCReportListener
Returns void

registerRoomEventListener

registerRoomEventListener(listener: null | IAudienceRoomEventListener): void

- Defined in src/core/room/RCAudienceLivingRoom.ts:1321
观众房间事件注册

Parameters
- listener: null | IAudienceRoomEventListener
Returns void

subscribe

subscribe(tracks: (RCRemoteTrack | ISubscribeAttr)[]): Promise<{ code: RCRTCCode; failedList?: ISubscribeAttr[] }>

- Defined in src/core/room/RCAudienceLivingRoom.ts:1184
订阅资源

Parameters
- tracks: (RCRemoteTrack | ISubscribeAttr)[]
Returns Promise<{ code: RCRTCCode; failedList?: ISubscribeAttr[] }>

unsubscribe

unsubscribe(tracks: RCRemoteTrack[]): Promise<{ code: RCRTCCode; failedList?: ISubscribeAttr[] }>

- Defined in src/core/room/RCAudienceLivingRoom.ts:1236
取消订阅资源

Parameters
- tracks: RCRemoteTrack[]
Returns Promise<{ code: RCRTCCode; failedList?: ISubscribeAttr[] }>

Generated using TypeDoc