Class RCAudienceLivingRoom

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

Hierarchy

RCAudienceLivingRoom

Constructors

constructor

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

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

Properties

Readonly livingType

livingType: RCLivingType

Methods

getCDNPlayUrl

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

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

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

subscribe

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

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

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:1199
取消订阅资源

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

getRemoteTrack

getRemoteTrack(trackId: string): RCRemoteTrack

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

Parameters
- trackId: string
Returns RCRemoteTrack

getLocalTrack

getLocalTrack(trackId: string): RCRemoteTrack

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

Parameters
- trackId: string
Returns RCRemoteTrack

registerRoomEventListener

registerRoomEventListener(listener: null | IAudienceRoomEventListener): void

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

Parameters
- listener: null | IAudienceRoomEventListener
Returns void

onAudioLevelChange

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

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

Parameters
- handler: null | IAudioLevelChangeHandler
  
  业务端传入的音量上报事件
- Optional _: number
  
  参数已废弃
Returns void

registerReportListener

registerReportListener(listener: null | IRCRTCReportListener): void

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

Parameters
- listener: null | IRCRTCReportListener
Returns void

getRoomId

getRoomId(): string

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

Returns string

getCrtUserId

getCrtUserId(): string

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

Returns string

getSessionId

getSessionId(): string

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

Returns string

getRemoteUserIds

getRemoteUserIds(): string[]

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

Returns string[]

getRemoteTracksByUserId

getRemoteTracksByUserId(userId: string): RCRemoteTrack[]

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

Parameters
- userId: string
Returns RCRemoteTrack[]

getRemoteTracks

getRemoteTracks(): RCRemoteTrack[]

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

Returns RCRemoteTrack[]

getRemoteRTCTracks

getRemoteRTCTracks(): RCRemoteTrack[]

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

Returns RCRemoteTrack[]

getRemoteMCUTracks

getRemoteMCUTracks(): RCRemoteTrack[]

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

Returns RCRemoteTrack[]

getCDNInfo

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

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

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

getClientSessionId

getClientSessionId(): string

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