Agora Web SDK API Reference
Hierarchy
- InjectStreamConfig
Index
Properties
Optional audioBitrate
Audio bitrate of the added stream to the interactive streaming.
Positive integer. The default value is 48. The value range is [1, 10000].
Note
Agora recommends that you stay with the default value and not reset it at this point of time.
Optional audioChannels
Audio channels to add into the interactive streaming.
Positive integer. The default value is 1. The value range is [1, 2].
Note
Agora recommends that you stay with the default value and not reset it at this point of time.
Optional audioSampleRate
Audio sampling rate of the added stream to the interactive streaming.
- 32000: 32 kHz
- 44100: (Default) 44.1 kHz
- 48000: 48 kHz
Note
Agora recommends that you stay with the default value and not reset it at this point of time.
Optional height
Height of the added stream to the interactive streaming.
Integer, the default value is 0, which is the same height as the original stream. The value range is [0, 10000].
Optional videoBitrate
Video bitrate of the added stream to the interactive streaming.
Positive integer. The default value is 400 Kbps. The value range is [1, 10000].
Note
The setting of the video bitrate is closely linked to the resolution. If the video bitrate you set is beyond the reasonable range, the SDK will set it within the reasonable range instead.
Optional videoFramerate
Video frame rate of the added stream to the interactive streaming.
Positive integer. The default value is 15 fps. The value range is [1, 10000].
Optional videoGop
Video GOP of the added stream to the interactive streaming.
Positive integer. The default value is 30 frames. The value range is [1, 10000].
Optional width
Width of the added stream to the interactive streaming.
Integer, the default value is 0, which is the same width as the original stream. The value range is [0, 10000].
A class for configuring the imported voice or video stream in addInjectStreamUrl.
Sample code
var InjectStreamConfig = { width: 0, height: 0, videoGop: 30, videoFramerate: 15, videoBitrate: 400, audioSampleRate: 44100, audioChannels: 1, };