Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LiveInjectStreamConfig

Configuration of the imported live interactive voice or video stream.

Hierarchy

  • LiveInjectStreamConfig

Index

Constructors

constructor

  • new LiveInjectStreamConfig(params?: undefined | { audioBitrate?: undefined | number; audioChannels?: AudioChannel; audioSampleRate?: AudioSampleRateType; height?: undefined | number; videoBitrate?: undefined | number; videoFramerate?: VideoFrameRate; videoGop?: undefined | number; width?: undefined | number }): LiveInjectStreamConfig
  • Parameters

    • Optional params: undefined | { audioBitrate?: undefined | number; audioChannels?: AudioChannel; audioSampleRate?: AudioSampleRateType; height?: undefined | number; videoBitrate?: undefined | number; videoFramerate?: VideoFrameRate; videoGop?: undefined | number; width?: undefined | number }

    Returns LiveInjectStreamConfig

Properties

Optional audioBitrate

audioBitrate: undefined | number

Audio bitrate of the added stream to the live interactive streaming. The default value is 48 Kbps.

Note

We recommend you use the default value and not reset it.

Optional audioChannels

audioChannels: AudioChannel

Audio channels to add into the live streaming. The value ranges between 1 and 2. The default value is 1.

Note

We recommend you use the default value and not reset it.

Optional audioSampleRate

audioSampleRate: AudioSampleRateType

Audio sample rate of the added stream to the live interactive streaming. The default value is 44100 Hz.

Note

We recommend you use the default value and not reset it.

Optional height

height: undefined | number

Height (pixels) of the added stream to the live interactive streaming. The default value is 0, which is the same height as the original stream.

Optional videoBitrate

videoBitrate: undefined | number

Video bitrate of the added stream to the live interactive streaming. The default value is 400 Kbps.

Note

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

Optional videoFramerate

videoFramerate: VideoFrameRate

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

Optional videoGop

videoGop: undefined | number

Video GOP of the added stream to the live interactive streaming. The default value is 30 frames.

Optional width

width: undefined | number

Width (pixels) of the added stream to the live interactive streaming. The default value is 0, which is the same width as the original stream.

Generated using TypeDoc