Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InjectStreamConfig

Configuration of the injected media stream.

Hierarchy

  • InjectStreamConfig

Index

Constructors

Properties

Constructors

constructor

  • new InjectStreamConfig(width?: number, height?: number, videoGop?: number, videoFramerate?: number, videoBitrate?: number, audioSampleRate?: AUDIO_SAMPLE_RATE_TYPE, audioBitrate?: number, audioChannels?: number): InjectStreamConfig

  • Parameters

    • Default value width: number = 0
    • Default value height: number = 0
    • Default value videoGop: number = 30
    • Default value videoFramerate: number = 15
    • Default value videoBitrate: number = 400
    • Default value audioSampleRate: AUDIO_SAMPLE_RATE_TYPE = AUDIO_SAMPLE_RATE_TYPE.AUDIO_SAMPLE_RATE_48000
    • Default value audioBitrate: number = 48
    • Default value audioChannels: number = 1

    Returns InjectStreamConfig

Properties

audioBitrate

audioBitrate: number

Audio bitrate of the injected stream in the live interactive streaming. The default value is 48.

note

We recommend setting the default value.

audioChannels

audioChannels: number

Audio channels in the live interactive streaming.

  • 1: (Default) Mono
  • 2: Two-channel stereo
note

We recommend setting the default value.

audioSampleRate

audioSampleRate: AUDIO_SAMPLE_RATE_TYPE

Audio-sample rate of the injected stream in the live interactive streaming: AUDIO_SAMPLE_RATE_TYPE. The default value is 48000 Hz.

note

We recommend setting the default value.

height

height: number

Height of the injected stream in the live interactive streaming. The default value is 0 (same height as the original stream).

videoBitrate

videoBitrate: number

Video bitrate of the injected stream in the live interactive streaming. The default value is 400 Kbps.

note

The setting of the video bitrate is closely linked to the resolution. If the video bitrate you set is beyond a reasonable range, the SDK sets it within a reasonable range.

videoFramerate

videoFramerate: number

Video frame rate of the injected stream in the live interactive streaming. The default value is 15 fps.

videoGop

videoGop: number

Video GOP (in frames) of the injected stream in the live interactive streaming. The default value is 30 fps.

width

width: number

Width of the injected stream in the live interactive streaming. The default value is 0 (same width as the original stream).

Generated using TypeDoc