Class Stream

Hierarchy

BasicModule
- Stream

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Stream(options: IStreamInitOptions): Stream

Overrides BasicModule.constructor
- Defined in src/modules/Stream.ts:171
Parameters
- options: IStreamInitOptions
Returns Stream

Properties

Readonly audio

audio: IAudioNode

Readonly video

video: IVideoNode

Methods

addPublishStreamUrl

addPublishStreamUrl(url: string): Promise<void>

- Defined in src/modules/Stream.ts:566
Parameters
- url: string
Returns Promise<void>

get

get(options: IGetStreamOptions): Promise<{ mediaStream: MediaStream }>

- Defined in src/modules/Stream.ts:292
Parameters
- options: IGetStreamOptions
Returns Promise<{ mediaStream: MediaStream }>

publish

publish(options: { stream: IStreamInfo }): Promise<{ liveUrl?: string }>

- Defined in src/modules/Stream.ts:323
Parameters
- options: { stream: IStreamInfo }
  - stream: IStreamInfo
Returns Promise<{ liveUrl?: string }>

removePublishStreamUrl

removePublishStreamUrl(url: string): Promise<void>

- Defined in src/modules/Stream.ts:575
Parameters
- url: string
Returns Promise<void>

resize

resize(options: IUserRes<{ size: StreamSize; tag: string }>): Promise<undefined>

- Defined in src/modules/Stream.ts:501
Parameters
- options: IUserRes<{ size: StreamSize; tag: string }>
Returns Promise<undefined>

setMixConfig

setMixConfig(options: IMCUConfigInfo): Promise<void>

- Defined in src/modules/Stream.ts:516
Parameters
- options: IMCUConfigInfo
Returns Promise<void>

subscribe

subscribe(options: ISubLiveOptions | IUserRes<IResInfo>): Promise<IUserRes<IOutputInfo> | { mediaStream: MediaStream }>

- Defined in src/modules/Stream.ts:458
Parameters
- options: ISubLiveOptions | IUserRes<IResInfo>
Returns Promise<IUserRes<IOutputInfo> | { mediaStream: MediaStream }>

unpublish

unpublish(options: { stream: IResInfo }): Promise<undefined>

- Defined in src/modules/Stream.ts:347
Parameters
- options: { stream: IResInfo }
  - stream: IResInfo
Returns Promise<undefined>

unsubscribe

unsubscribe(options?: IUserRes<IResInfo>): Promise<void>

- Defined in src/modules/Stream.ts:488
Parameters
- Optional options: IUserRes<IResInfo>
Returns Promise<void>

Generated using TypeDoc